From f25886e59fc6a1217e48c42510da36594cb292bd Mon Sep 17 00:00:00 2001 From: Ariel Otilibili Date: Mon, 9 Dec 2024 21:58:27 +0100 Subject: [PATCH 1/3] lib/stdlib: fix redirection links in docs Signed-off-by: Ariel Otilibili --- lib/stdlib/src/gen_event.erl | 2 +- lib/stdlib/src/gen_fsm.erl | 5 ++--- lib/stdlib/src/gen_statem.erl | 4 ++-- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/lib/stdlib/src/gen_event.erl b/lib/stdlib/src/gen_event.erl index d69e648c2514..5c4e930e910f 100644 --- a/lib/stdlib/src/gen_event.erl +++ b/lib/stdlib/src/gen_event.erl @@ -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 diff --git a/lib/stdlib/src/gen_fsm.erl b/lib/stdlib/src/gen_fsm.erl index 7276f192842f..113d00166dfe 100644 --- a/lib/stdlib/src/gen_fsm.erl +++ b/lib/stdlib/src/gen_fsm.erl @@ -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. @@ -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) diff --git a/lib/stdlib/src/gen_statem.erl b/lib/stdlib/src/gen_statem.erl index 150ba7455b4d..b48626f05f4c 100644 --- a/lib/stdlib/src/gen_statem.erl +++ b/lib/stdlib/src/gen_statem.erl @@ -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 } > @@ -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) From 3c82d6c7964e66869453da001d5a4f9ea59566eb Mon Sep 17 00:00:00 2001 From: Ariel Otilibili Date: Mon, 9 Dec 2024 21:58:27 +0100 Subject: [PATCH 2/3] lib/sasl: fix redirection links in docs Signed-off-by: Ariel Otilibili --- lib/kernel/doc/references/app.md | 2 +- lib/sasl/doc/references/appup.md | 5 ++--- lib/sasl/src/release_handler.erl | 5 ++--- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/lib/kernel/doc/references/app.md b/lib/kernel/doc/references/app.md index 30c30fb57063..2d98a025a764 100644 --- a/lib/kernel/doc/references/app.md +++ b/lib/kernel/doc/references/app.md @@ -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 diff --git a/lib/sasl/doc/references/appup.md b/lib/sasl/doc/references/appup.md index 157f25fbc9b6..b8ea2cd214a9 100644 --- a/lib/sasl/doc/references/appup.md +++ b/lib/sasl/doc/references/appup.md @@ -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`. diff --git a/lib/sasl/src/release_handler.erl b/lib/sasl/src/release_handler.erl index 9cf3bab849c8..597ec16d71dc 100644 --- a/lib/sasl/src/release_handler.erl +++ b/lib/sasl/src/release_handler.erl @@ -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 From 952323a789c525d50563d7840eba16d1b0c17289 Mon Sep 17 00:00:00 2001 From: Ariel Otilibili Date: Mon, 9 Dec 2024 22:00:26 +0100 Subject: [PATCH 3/3] system/doc: fix redirection links in docs Signed-off-by: Ariel Otilibili --- system/doc/reference_manual/modules.md | 2 +- system/doc/system_principles/system_principles.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/system/doc/reference_manual/modules.md b/system/doc/reference_manual/modules.md index dcfdb524f0fd..961eef08bff8 100644 --- a/system/doc/reference_manual/modules.md +++ b/system/doc/reference_manual/modules.md @@ -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 diff --git a/system/doc/system_principles/system_principles.md b/system/doc/system_principles/system_principles.md index 972db0802561..539527ec7d67 100644 --- a/system/doc/system_principles/system_principles.md +++ b/system/doc/system_principles/system_principles.md @@ -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