Skip to content

Commit 7802d28

Browse files
committed
flux-exec(1): move EXIT STATUS to the end
Problem: the EXIT STATUS section comes before OPTIONS, but this contradicts the section order suggested in man-pages(7), a style guide of sorts. Move EXIT STATUS to after OPTIONS.
1 parent 960da28 commit 7802d28

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

doc/man1/flux-exec.rst

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,6 @@ the received signal to the remote processes. When standard input of
3434
SIGINT. Two of those in short succession can force :program:`flux exec`
3535
to exit in the event that remote processes are hanging.
3636

37-
EXIT STATUS
38-
===========
39-
40-
In the case that all processes are successfully launched, the exit status
41-
of :program:`flux exec` is the largest of the remote process exit codes.
42-
43-
If a non-existent rank is targeted, :program:`flux exec` will return with
44-
code 68 (EX_NOHOST from sysexits.h).
45-
46-
If one or more remote commands are terminated by a signal, then
47-
:program:`flux exec` exits with exit code 128+signo.
48-
49-
5037
OPTIONS
5138
=======
5239

@@ -106,6 +93,17 @@ NODESET FORMAT
10693

10794
.. include:: common/nodeset.rst
10895

96+
EXIT STATUS
97+
===========
98+
99+
In the case that all processes are successfully launched, the exit status
100+
of :program:`flux exec` is the largest of the remote process exit codes.
101+
102+
If a non-existent rank is targeted, :program:`flux exec` will return with
103+
code 68 (EX_NOHOST from sysexits.h).
104+
105+
If one or more remote commands are terminated by a signal, then
106+
:program:`flux exec` exits with exit code 128+signo.
109107

110108
RESOURCES
111109
=========

0 commit comments

Comments
 (0)