Skip to content

Commit

Permalink
Merge pull request #9099 from ariel-anieli/typo-gen-statem
Browse files Browse the repository at this point in the history
fix redirection links in docs
  • Loading branch information
garazdawi authored Dec 10, 2024
2 parents c838c6c + 952323a commit 3749221
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 15 deletions.
2 changes: 1 addition & 1 deletion lib/kernel/doc/references/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ The other keys are ignored by `systools`.

This implies that for an included application, the set of start phases must be
a subset of the set of phases defined for the primary application. For more
information, see [OTP Design Principles](`e:system:applications.md`).
information, see [_Applications_ in _OTP Design Principles_](`e:system:applications.md`).

- **`runtime_dependencies`{: #runtime_dependencies }** - A list of application
versions that the application depends on. An example of such an application
Expand Down
5 changes: 2 additions & 3 deletions lib/sasl/doc/references/appup.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,8 @@ this example works for, for example, `2.1.1`, but not for `2.1.1.1`.
## Release Upgrade Instructions

Release upgrade instructions are interpreted by the release handler when an
upgrade or downgrade is made. For more information about release handling, see
[OTP Design Principles](`e:system:release_handling.md`) in _System
Documentation_.
upgrade or downgrade is made. For more information, see
[_Release Handling_ in _OTP Design Principles_](`e:system:release_handling.md`).

A process is said to _use_ a module `Mod` if `Mod` is listed in the `Modules`
part of the child specification used to start the process, see `m:supervisor`.
Expand Down
5 changes: 2 additions & 3 deletions lib/sasl/src/release_handler.erl
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ The _release handler_ process belongs to the SASL application, which is
responsible for _release handling_, that is, unpacking, installation, and
removal of release packages.
An introduction to release handling and an example is provided in
[OTP Design Principles](`e:system:release_handling.md`) in _System
Documentation_.
An introduction to release handling and an example is provided by
[Release Handling section in OTP Design Principles](`e:system:release_handling.md`).
A _release package_ is a compressed tar file containing code for a certain
version of a release, created by calling
Expand Down
2 changes: 1 addition & 1 deletion lib/stdlib/src/gen_event.erl
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ event handlers that are added and deleted dynamically.
An event manager implemented using this module has a standard set of
interface functions and includes functionality for tracing
and error reporting. It also fits into an OTP supervision tree.
For more information, see [OTP Design Principles](`e:system:events.md`).
For more information, see [gen_event section in OTP Design Principles](`e:system:events.md`).
Each event handler is implemented as a callback module
exporting a predefined set of functions. The relationship between
Expand Down
5 changes: 2 additions & 3 deletions lib/stdlib/src/gen_fsm.erl
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ A generic finite state machine process (`gen_fsm`) implemented
using this module has a standard set of interface functions
and includes functionality for tracing and error reporting.
It also fits into an OTP supervision tree. For more information,
see [OTP Design Principles](`e:system:design_principles`).
see [OTP Design Principles](`e:system:design_principles.md`).
A `gen_fsm` process assumes all specific parts to be located
in a callback module exporting a predefined set of functions.
Expand Down Expand Up @@ -679,8 +679,7 @@ its internal [*state data*](#state-data)
during a release upgrade/downgrade, that is,
when instruction `{update, Module, Change, ...}`,
where `Change = {advanced, Extra}`, is given in the appup file;
see section Release Handling Instructions in OTP Design Principles.
[OTP Design Principles](`e:system:release_handling.md#instr`).
see [Release Handling Instructions in OTP Design Principles](`e:system:release_handling.md#instr`).
For an upgrade, `OldVsn` is `Vsn`, and for a downgrade,
`OldVsn` is `{down, Vsn}`. `Vsn` is defined by the vsn attribute(s)
Expand Down
4 changes: 2 additions & 2 deletions lib/stdlib/src/gen_statem.erl
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ A generic state machine server process (`gen_statem`) implemented
using this module has a standard set of interface functions
and includes functionality for tracing and error reporting.
It also fits into an OTP supervision tree. For more information,
see [OTP Design Principles](`e:system:statem.md`).
see [gen_statem section in OTP Design Principles](`e:system:statem.md`).
> #### Note {: .info }
>
Expand Down Expand Up @@ -1739,7 +1739,7 @@ its internal state during a release upgrade/downgrade, that is,
when the instruction `{update, Module, Change, ...}`,
where `Change = {advanced, Extra}`, is specified in
the [`appup`](`e:sasl:appup.md`) file. For more information, see
[OTP Design Principles](`e:system:release_handling.md#instr`).
[Release Handling Instructions in OTP Design Principles](`e:system:release_handling.md#instr`).
For an upgrade, `OldVsn` is `Vsn`, and for a downgrade, `OldVsn` is
`{down, Vsn}`. `Vsn` is defined by the `vsn` attribute(s)
Expand Down
2 changes: 1 addition & 1 deletion system/doc/reference_manual/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ is to be preferred since the extra type information can be used by tools to
produce documentation or find discrepancies.

Read more about behaviours and callback modules in
[OTP Design Principles](`e:system:spec_proc.md#behaviours`).
[OTP Design Principles](`e:system:design_principles.md#behaviours`).

### Record Definitions

Expand Down
2 changes: 1 addition & 1 deletion system/doc/system_principles/system_principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ This requires that the source code is structured as applications
according to the OTP design principles.

For more information about `.rel` files, see
[OTP Design Principles](`e:system:release_handling.md`) and the
[Release Handling](`e:system:release_handling.md`) and the
[rel](`e:sasl:rel.md`) page in SASL.

To generate the binary boot script file `Name.boot` the boot script file
Expand Down

0 comments on commit 3749221

Please sign in to comment.