armscii-8.7, koi8-r.7, koi8-u.7, unicode.7: Uniform description

PATCH In review David Prévot 2 participants 4 messages Oct 24, 2010 – Oct 30, 2010 1 message not in the archive Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore

Share & tools

lore

David Prévot

author

2010-10-24 22:24 UTC #0 lore raw

PATCH 1/1 armscii-8.7, koi8-r.7, koi8-u.7, unicode.7: Uniform description

Hi,

Please find inline a patch to address some consistency among character set manual page descriptions. If you prefer to shrink “the” from other manual page descriptions (ascii.7, cp1251.7 and iso_8859-*.7 ones), I volunteer to provide the (trivial) patch instead.

man7/armscii-8.7 +1 -1

index 9cd8bd1..597f0a8 100644
@@ -25,7 +25,7 @@
 .TH ARMSCII-8 7 2010-09-20 "Linux" "Linux Programmer's Manual"
 .nh
 .SH NAME
-armscii-8 \- Armenian Character Set encoded in octal, decimal, and
+armscii-8 \- the Armenian character set encoded in octal, decimal, and
 hexadecimal
 .SH DESCRIPTION
 The Armenian Standard Code for Information Interchange,

man7/koi8-r.7 +1 -1

index 509adac..bb08d8b 100644
@@ -25,7 +25,7 @@
 .TH KOI8-R 7 2010-10-24 "Linux" "Linux Programmer's Manual"
 .nh
 .SH NAME
-koi8-r \- Russian Net Character Set encoded in octal, decimal, and
+koi8-r \- the Russian character set encoded in octal, decimal, and
 hexadecimal
 .SH DESCRIPTION
 KOI8-R is the character set of choice for encoding Russian texts for

man7/koi8-u.7 +1 -1

index 5d30bb8..d59cb52 100644
@@ -26,7 +26,7 @@
 .TH KOI8-U 7 2010-09-20 "Linux" "Linux Programmer's Manual"
 .nh
 .SH NAME
-koi8-u \- Ukrainian Net Character Set encoded in octal, decimal, and
+koi8-u \- the Ukrainian character set encoded in octal, decimal, and
 hexadecimal
 .SH DESCRIPTION
 KOI8-U (KOI8 Ukrainian, described in RFC\ 2310)

man7/unicode.7 +1 -1

index ee4c4bc..b8a8948 100644
@@ -29,7 +29,7 @@
 .\"
 .TH UNICODE 7 2001-05-11 "GNU" "Linux Programmer's Manual"
 .SH NAME
-Unicode \- the Universal Character Set
+Unicode \- the universal character set
 .SH DESCRIPTION
 The international standard
 .B ISO 10646

Regards

David

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

Michael Kerrisk

2010-10-25 05:18 UTC #1 lore raw

Hi David,

Quoted 7 lines · David Prévot

Hi,
Please find inline a patch to address some consistency among character set manual page descriptions. If you prefer to shrink “the” from other manual page descriptions (ascii.7, cp1251.7 and iso_8859-*.7 ones), I volunteer to provide the (trivial) patch instead.

Thanks. Applied for 3.30. I prefer without "the", and made that change also.

All changes are now pushed to git; you may wish to check.

Thanks,

Michael

Quoted 65 lines

man7/armscii-8.7 +0 -0
index 9cd8bd1..597f0a8 100644
@@ -25,7 +25,7 @@
.TH ARMSCII-8 7 2010-09-20 "Linux" "Linux Programmer's Manual" .nh
.SH NAME
man7/armscii-8.7 +1 -1
-armscii-8 \- Armenian Character Set encoded in octal, decimal, and
+armscii-8 \- the Armenian character set encoded in octal, decimal, and
hexadecimal
.SH DESCRIPTION
The Armenian Standard Code for Information Interchange,
man7/koi8-r.7 +0 -0
index 509adac..bb08d8b 100644
@@ -25,7 +25,7 @@
.TH KOI8-R 7 2010-10-24 "Linux" "Linux Programmer's Manual" .nh
.SH NAME
man7/koi8-r.7 +1 -1
-koi8-r \- Russian Net Character Set encoded in octal, decimal, and
+koi8-r \- the Russian character set encoded in octal, decimal, and
hexadecimal
.SH DESCRIPTION
KOI8-R is the character set of choice for encoding Russian texts for
man7/koi8-u.7 +0 -0
index 5d30bb8..d59cb52 100644
@@ -26,7 +26,7 @@
.TH KOI8-U 7 2010-09-20 "Linux" "Linux Programmer's Manual" .nh
.SH NAME
man7/koi8-u.7 +1 -1
-koi8-u \- Ukrainian Net Character Set encoded in octal, decimal, and
+koi8-u \- the Ukrainian character set encoded in octal, decimal, and
hexadecimal
.SH DESCRIPTION
KOI8-U (KOI8 Ukrainian, described in RFC\ 2310)
man7/unicode.7 +0 -0
index ee4c4bc..b8a8948 100644
@@ -29,7 +29,7 @@
.\"
.TH UNICODE 7 2001-05-11 "GNU" "Linux Programmer's Manual" .SH NAME
man7/unicode.7 +1 -1
-Unicode \- the Universal Character Set
+Unicode \- the universal character set
.SH DESCRIPTION
The international standard
.B ISO 10646
Regards
David
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

Signature · 7 lines

Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface"; http://man7.org/tlpi/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): AANLkTi=DngvZdHPMqQmH9DQZ750ukoKZfzayWLDkBOQw-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

David Prévot

author

2010-10-25 12:38 UTC #3 lore raw

PATCH 1/1 hosts.5, protocols.5, spufs.7, termio.7: Uniform description (Was: armscii-8.7, koi8-r.7, koi8-u.7, unicode.7)

Hi Michael,

Quoted 1 line

All changes are now pushed to git; you may wish to check.

Seems fine, thanks.

Quoted 1 line

Thanks. Applied for 3.30. I prefer without "the", and made that change also.

Agreed. Please find inline another tiny patch in order to shrink the definite article from some other pages (found with “rgrep -i ' \\\- the' man*/”).

man5/hosts.5 +1 -1

index cb9b253..513a4e3 100644
@@ -26,7 +26,7 @@
 .\"
 .TH HOSTS 5 2002-06-16 "Linux" "Linux Programmer's Manual"
 .SH NAME
-hosts \- The static table lookup for hostnames
+hosts \- static table lookup for hostnames
 .SH SYNOPSIS
 .B /etc/hosts
 .SH DESCRIPTION

man5/protocols.5 +1 -1

index d414093..9c644f7 100644
@@ -27,7 +27,7 @@
 .\"
 .TH PROTOCOLS 5 2008-09-23 "Linux" "Linux Programmer's Manual"
 .SH NAME
-protocols \- the protocols definition file
+protocols \- protocols definition file
 .SH DESCRIPTION
 This file is a plain ASCII file, describing the various DARPA internet
 protocols that are available from the TCP/IP subsystem.

man7/spufs.7 +1 -1

index 64c4357..ee65298 100644
@@ -25,7 +25,7 @@
 .\"
 .TH SPUFS 7 2007-12-20 Linux "Linux Programmer's Manual"
 .SH NAME
-spufs \- the SPU file system
+spufs \- SPU file system
 .SH DESCRIPTION
 The SPU file system is used on PowerPC machines that implement the
 Cell Broadband Engine Architecture in order to access Synergistic

man7/termio.7 +1 -1

index d6c20c0..bfa9003 100644
@@ -24,7 +24,7 @@
 .\"
 .TH TERMIO 7 2006-12-28 "Linux" "Linux Programmer's Manual"
 .SH NAME
-termio \- the System V terminal driver interface
+termio \- System V terminal driver interface
 .SH DESCRIPTION
 .B termio
 is the name of the old System V terminal driver interface.

Cheers

David

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

Michael Kerrisk

2010-10-30 05:40 UTC #4 lore raw

Re: [patch] hosts.5, protocols.5, spufs.7, termio.7: Uniform description (Was: armscii-8.7, koi8-r.7, koi8-u.7, unicode.7)

Hello David,

Quoted 10 lines · David Prévot

Hi Michael,
Quoted 1 line
All changes are now pushed to git; you may wish to check.
Seems fine, thanks.
Quoted 1 line
Thanks. Applied for 3.30. I prefer without "the", and made that change also.
Agreed. Please find inline another tiny patch in order to shrink the definite article from some other pages (found with “rgrep -i ' \\\- the' man*/”).

Thanks. Applied for 3.30.

Michael

Quoted 64 lines

man5/hosts.5 +0 -0
index cb9b253..513a4e3 100644
@@ -26,7 +26,7 @@
.\"
.TH HOSTS 5 2002-06-16 "Linux" "Linux Programmer's Manual" .SH NAME
man5/hosts.5 +1 -1
-hosts \- The static table lookup for hostnames
+hosts \- static table lookup for hostnames
.SH SYNOPSIS
.B /etc/hosts
.SH DESCRIPTION
man5/protocols.5 +0 -0
index d414093..9c644f7 100644
@@ -27,7 +27,7 @@
.\"
.TH PROTOCOLS 5 2008-09-23 "Linux" "Linux Programmer's Manual" .SH NAME
man5/protocols.5 +1 -1
-protocols \- the protocols definition file
+protocols \- protocols definition file
.SH DESCRIPTION
This file is a plain ASCII file, describing the various DARPA internet protocols that are available from the TCP/IP subsystem.
man7/spufs.7 +0 -0
index 64c4357..ee65298 100644
@@ -25,7 +25,7 @@
.\"
.TH SPUFS 7 2007-12-20 Linux "Linux Programmer's Manual" .SH NAME
man7/spufs.7 +1 -1
-spufs \- the SPU file system
+spufs \- SPU file system
.SH DESCRIPTION
The SPU file system is used on PowerPC machines that implement the Cell Broadband Engine Architecture in order to access Synergistic
man7/termio.7 +0 -0
index d6c20c0..bfa9003 100644
@@ -24,7 +24,7 @@
.\"
.TH TERMIO 7 2006-12-28 "Linux" "Linux Programmer's Manual" .SH NAME
man7/termio.7 +1 -1
-termio \- the System V terminal driver interface
+termio \- System V terminal driver interface
.SH DESCRIPTION
.B termio
is the name of the old System V terminal driver interface.
Cheers
David
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

Signature · 7 lines

Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface"; http://man7.org/tlpi/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html