Util-Linux Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 6/7] Manual pages: Standardize on EXIT STATUS as section title
@ 2020-05-19 12:53 Michael Kerrisk (man-pages)
  0 siblings, 0 replies; only message in thread
From: Michael Kerrisk (man-pages) @ 2020-05-19 12:53 UTC (permalink / raw)
  To: Karel Zak; +Cc: mtk.manpages, util-linux

There is quite some value (in terms of readability and user
expectations) if consistent names are used for the sections
within manual pages. This patch is one of a series to bring
about this consistency.

Currently we have EXIT STATUS (18), EXIT CODES (3), RETURN CODE (7),
RETURN CODES (1), or RETURN VALUE (4 instances in pages that document
commands, rather than functions).

Let's standardize on the EXIT STATUS (which is also what is
suggested in man-pages(7), and is the POSIX terminology).

A subsequent patch will clean up corresponding miswordings in
manual page text.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
---
 disk-utils/fsck.minix.8 | 2 +-
 disk-utils/mkfs.bfs.8   | 2 +-
 disk-utils/mkfs.minix.8 | 2 +-
 misc-utils/blkid.8      | 2 +-
 misc-utils/kill.1       | 2 +-
 misc-utils/logger.1     | 2 +-
 misc-utils/lsblk.8      | 2 +-
 sys-utils/chcpu.8       | 2 +-
 sys-utils/chmem.8       | 2 +-
 sys-utils/fstrim.8      | 2 +-
 sys-utils/losetup.8     | 2 +-
 sys-utils/mount.8       | 2 +-
 sys-utils/switch_root.8 | 2 +-
 sys-utils/zramctl.8     | 2 +-
 14 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/disk-utils/fsck.minix.8 b/disk-utils/fsck.minix.8
index 2aabd2fa3..600b1e2da 100644
--- a/disk-utils/fsck.minix.8
+++ b/disk-utils/fsck.minix.8
@@ -92,7 +92,7 @@ will print "unable to read super block".  If the device exists, but is not
 a MINIX filesystem,
 .B fsck.minix
 will print "bad magic number in super-block".
-.SH EXIT CODES
+.SH EXIT STATUS
 The exit code returned by
 .B fsck.minix
 is the sum of the following:
diff --git a/disk-utils/mkfs.bfs.8 b/disk-utils/mkfs.bfs.8
index 9f2e7bb87..ca0847227 100644
--- a/disk-utils/mkfs.bfs.8
+++ b/disk-utils/mkfs.bfs.8
@@ -47,7 +47,7 @@ Option
 only works as
 .B \-\-version
 when it is the only option.
-.SH EXIT CODES
+.SH EXIT STATUS
 The exit code returned by
 .B mkfs.bfs
 is 0 when all went well, and 1 when something went wrong.
diff --git a/disk-utils/mkfs.minix.8 b/disk-utils/mkfs.minix.8
index 7486ca5bc..9a6b26c54 100644
--- a/disk-utils/mkfs.minix.8
+++ b/disk-utils/mkfs.minix.8
@@ -70,7 +70,7 @@ with other options.
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 Display help text and exit.
-.SH EXIT CODES
+.SH EXIT STATUS
 The exit code returned by
 .B mkfs.minix
 is one of the following:
diff --git a/misc-utils/blkid.8 b/misc-utils/blkid.8
index 6ef73f33c..6c0bbe43d 100644
--- a/misc-utils/blkid.8
+++ b/misc-utils/blkid.8
@@ -286,7 +286,7 @@ Look up the device that uses this filesystem \fIuuid\fR.  For more details see t
 .TP
 \fB\-V\fR, \fB\-\-version\fR
 Display version number and exit.
-.SH RETURN CODE
+.SH EXIT STATUS
 If the specified device or device addressed by specified token (option
 \fB\-\-match\-token\fR) was found and it's possible to gather any information about the
 device, an exit code 0 is returned.  Note the option \fB\-\-match\-tag\fR filters output
diff --git a/misc-utils/kill.1 b/misc-utils/kill.1
index 27258d293..c0383faca 100644
--- a/misc-utils/kill.1
+++ b/misc-utils/kill.1
@@ -171,7 +171,7 @@ preferred in relation to the
 executable described by this manual.  Easiest way to ensure one is executing
 the executable is to use full path when calling the command, for example:
 .B "/bin/kill \-\-version"
-.SH RETURN CODES
+.SH EXIT STATUS
 .B kill
 has the following return codes:
 .PP
diff --git a/misc-utils/logger.1 b/misc-utils/logger.1
index b2f2133ae..501ed938d 100644
--- a/misc-utils/logger.1
+++ b/misc-utils/logger.1
@@ -294,7 +294,7 @@ Display version information and exit.
 .TP
 .BR \-h , " \-\-help"
 Display help text and exit.
-.SH RETURN VALUE
+.SH EXIT STATUS
 The
 .B logger
 utility exits 0 on success, and >0 if an error occurs.
diff --git a/misc-utils/lsblk.8 b/misc-utils/lsblk.8
index 1b73e6f25..cca345f1a 100644
--- a/misc-utils/lsblk.8
+++ b/misc-utils/lsblk.8
@@ -180,7 +180,7 @@ This sysfs block directory appeared in kernel 2.6.27 (October 2008).
 In case of problems with a new enough kernel, check that CONFIG_SYSFS
 was enabled at the time of the kernel build.
 
-.SH RETURN CODES
+.SH EXIT STATUS
 .IP 0
 success
 .IP 1
diff --git a/sys-utils/chcpu.8 b/sys-utils/chcpu.8
index 23191e2b9..7f94de535 100644
--- a/sys-utils/chcpu.8
+++ b/sys-utils/chcpu.8
@@ -77,7 +77,7 @@ Display version information and exit.
 .BR \-h , " \-\-help"
 Display help text and exit.
 
-.SH RETURN CODES
+.SH EXIT STATUS
 .B chcpu
 has the following return codes:
 .TP
diff --git a/sys-utils/chmem.8 b/sys-utils/chmem.8
index c11514007..21a8152c0 100644
--- a/sys-utils/chmem.8
+++ b/sys-utils/chmem.8
@@ -79,7 +79,7 @@ progress.
 .TP
 .BR \-V ", " \-\-version
 Print the version number, then exit.
-.SH RETURN CODES
+.SH EXIT STATUS
 .B chmem
 has the following return codes:
 .TP
diff --git a/sys-utils/fstrim.8 b/sys-utils/fstrim.8
index e3857f9d0..f8e4ebc6f 100644
--- a/sys-utils/fstrim.8
+++ b/sys-utils/fstrim.8
@@ -115,7 +115,7 @@ Display version information and exit.
 .BR \-h , " \-\-help"
 Display help text and exit.
 
-.SH RETURN CODES
+.SH EXIT STATUS
 .IP 0
 success
 .IP 1
diff --git a/sys-utils/losetup.8 b/sys-utils/losetup.8
index 4cf548741..6c4f603da 100644
--- a/sys-utils/losetup.8
+++ b/sys-utils/losetup.8
@@ -170,7 +170,7 @@ Display help text and exit.
 .B Cryptoloop is no longer supported in favor of dm-crypt.
 .B For more details see cryptsetup(8).
 
-.SH RETURN VALUE
+.SH EXIT STATUS
 .B losetup
 returns 0 on success, nonzero on failure.  When
 .B losetup
diff --git a/sys-utils/mount.8 b/sys-utils/mount.8
index e31660baa..a9df585ce 100644
--- a/sys-utils/mount.8
+++ b/sys-utils/mount.8
@@ -2501,7 +2501,7 @@ initialize a new device if the same backing file is already used for some loop
 device with the same offset and sizelimit. This is necessary to avoid
 a filesystem corruption.
 
-.SH RETURN CODES
+.SH EXIT STATUS
 .B mount
 has the following return codes (the bits can be ORed):
 .TP
diff --git a/sys-utils/switch_root.8 b/sys-utils/switch_root.8
index b194a262f..b169817e9 100644
--- a/sys-utils/switch_root.8
+++ b/sys-utils/switch_root.8
@@ -28,7 +28,7 @@ Display help text and exit.
 .IP "\fB\-V, \-\-version\fP"
 Display version information and exit.
 
-.SH RETURN VALUE
+.SH EXIT STATUS
 .B switch_root
 returns 0 on success and 1 on failure.
 
diff --git a/sys-utils/zramctl.8 b/sys-utils/zramctl.8
index 12983f144..97e3f4118 100644
--- a/sys-utils/zramctl.8
+++ b/sys-utils/zramctl.8
@@ -95,7 +95,7 @@ Display version information and exit.
 .BR \-h , " \-\-help"
 Display help text and exit.
 
-.SH RETURN VALUE
+.SH EXIT STATUS
 .B zramctl
 returns 0 on success, nonzero on failure.
 
-- 
2.26.2

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-19 12:53 [PATCH 6/7] Manual pages: Standardize on EXIT STATUS as section title Michael Kerrisk (man-pages)

Util-Linux Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/util-linux/0 util-linux/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 util-linux util-linux/ https://lore.kernel.org/util-linux \
		util-linux@vger.kernel.org
	public-inbox-index util-linux

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.util-linux


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git