Util-Linux Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 5/7] Manual pages: Standardize on ENVIRONMENT as section title
@ 2020-05-19 12:52 Michael Kerrisk (man-pages)
  0 siblings, 0 replies; only message in thread
From: Michael Kerrisk (man-pages) @ 2020-05-19 12:52 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.

But, let's make sure that the section is consistently titled
across pages. Currently we have ENVIRONMENT (many) or ENVIRONMENT
VARIABLES (3).  Let's standardize on ENVIRONMENT (which is also
what is suggested in man-pages(7)).

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
---
 disk-utils/fsck.8     | 2 +-
 login-utils/sulogin.8 | 2 +-
 text-utils/pg.1       | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/disk-utils/fsck.8 b/disk-utils/fsck.8
index 10728c861..e53333bca 100644
--- a/disk-utils/fsck.8
+++ b/disk-utils/fsck.8
@@ -345,7 +345,7 @@ with
 Options to different filesystem-specific fsck's are not standardized.
 .SH FILES
 .I /etc/fstab
-.SH ENVIRONMENT VARIABLES
+.SH ENVIRONMENT
 The
 .B fsck
 program's behavior is affected by the following environment variables:
diff --git a/login-utils/sulogin.8 b/login-utils/sulogin.8
index d5b24383d..7e77cd541 100644
--- a/login-utils/sulogin.8
+++ b/login-utils/sulogin.8
@@ -72,7 +72,7 @@ will wait forever.
 Display help text and exit.
 .IP "\fB\-V\fR, \fB\-\-version\fP"
 Display version information and exit.
-.SH ENVIRONMENT VARIABLES
+.SH ENVIRONMENT
 .B sulogin
 looks for the environment variable
 .B SUSHELL
diff --git a/text-utils/pg.1 b/text-utils/pg.1
index 4c9a759eb..a7fd60134 100644
--- a/text-utils/pg.1
+++ b/text-utils/pg.1
@@ -196,7 +196,7 @@ input file or writes on the terminal,
 will immediately display the prompt.
 In all other situations these keys will terminate
 .BR pg .
-.SH ENVIRONMENT VARIABLES
+.SH ENVIRONMENT
 The following environment variables
 affect the behavior of
 .BR pg :
-- 
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:52 [PATCH 5/7] Manual pages: Standardize on ENVIRONMENT 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