Skip to content

Commit a930d0c

Browse files
committed
docs: add support for ref-man man-pages
1 parent 076d14c commit a930d0c

File tree

11 files changed

+806
-47
lines changed

11 files changed

+806
-47
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ make/otp_doc_built
115115
JAVADOC-GENERATED
116116

117117
*.1
118+
*.3
118119

119120
# Anchored from $ERL_TOP
120121
/bin

lib/stdlib/src/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ MODULES= \
103103
json \
104104
lists \
105105
log_mf_h \
106+
man_docs \
106107
maps \
107108
math \
108109
ms_transform \

lib/stdlib/src/beam_lib.erl

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,11 @@ The key can be provided in the following two ways:
9999
[`compile`](`m:compile#debug_info_key`) and function `crypto_key_fun/1` to
100100
register a fun that returns the key whenever `beam_lib` must decrypt the
101101
debug information.
102-
103-
If no such fun is registered, `beam_lib` instead searches for an `.erlang.crypt`
104-
file, see the next section.
105-
102+
If no such fun is registered, `beam_lib` instead searches for an `.erlang.crypt`
103+
file, see the next section.
106104
1. Store the key in a text file named `.erlang.crypt`.
107-
108-
In this case, Compiler option `encrypt_debug_info` can be used, see
109-
[`compile`](`m:compile#encrypt_debug_info`).
105+
In this case, Compiler option `encrypt_debug_info` can be used, see
106+
[`compile`](`m:compile#encrypt_debug_info`).
110107

111108
## .erlang.crypt
112109

lib/stdlib/src/gen_statem.erl

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,6 @@ and returns. Here are the sequence of steps for a _state transition_:
779779
in order of appearance. In this step all replies generated
780780
by any `t:reply_action/0` are sent. Other actions set
781781
`t:transition_option/0`s that come into play in subsequent steps.
782-
783782
2. If [_state enter calls_](`t:state_enter/0`) are used,
784783
it is either the initial state or one of the callback results
785784
[`repeat_state`](`t:state_callback_result/2`) or
@@ -797,15 +796,11 @@ and returns. Here are the sequence of steps for a _state transition_:
797796
[`(enter, OldState, State, Data)`](`t:state_enter/0`) (depending on
798797
[_callback mode_](`t:callback_mode/0`)) and when it returns
799798
starts again from the top of this sequence.
800-
801799
3. If `t:postpone/0` is `true`, the current event is postponed.
802-
803800
4. If this is a _state change_, the queue of incoming events is reset
804801
to start with the oldest postponed.
805-
806802
5. All events stored with `t:action/0` `next_event` are inserted
807803
to be processed before previously queued events.
808-
809804
6. Time-out timers `t:event_timeout/0`, `t:generic_timeout/0` and
810805
`t:state_timeout/0` are handled. Time-outs with zero time
811806
are guaranteed to be delivered to the state machine
@@ -820,12 +815,10 @@ and returns. Here are the sequence of steps for a _state transition_:
820815
A _state change_ cancels a `t:state_timeout/0` and any new transition
821816
option of this type belongs to the new state, that is;
822817
a `t:state_timeout/0` applies to the state the state machine enters.
823-
824818
7. If there are enqueued events the
825819
[_state callback_](#state-callback) for the possibly
826820
new state is called with the oldest enqueued event, and we start again
827821
from the top of this sequence.
828-
829822
8. Otherwise the `gen_statem` goes into `receive` or hibernation
830823
(if `t:hibernate/0` is `true`) to wait for the next message.
831824
In hibernation the next non-system event awakens the `gen_statem`,

0 commit comments

Comments
 (0)