diff options
author | Alejandro Colomar <alx.manpages@gmail.com> | 2022-08-20 13:48:02 +0200 |
---|---|---|
committer | Alejandro Colomar <alx.manpages@gmail.com> | 2022-08-21 14:29:13 +0200 |
commit | 7bd6328fd40871ad75cbc3b6aa5d4a4b70f53ac7 (patch) | |
tree | 32c5602713bd9accf424556851977de3a963ef6a /man1 | |
parent | 112770f9ecd7d68762a5a81fd16a7d3f9fb10374 (diff) |
All pages: Replace the 4th argument to .TH by "Linux man-pages (unreleased)"
On 8/20/22 13:57, Alejandro Colomar wrote:
> On 8/20/22 07:43, G. Branden Robinson wrote:
>>
>> In my opinion it would benefit readers of the Linux man-pages if the
>> fourth argument to `TH` were what it is in many other man pages: an
>> identifier for the name and version number of the release originating
>> them. In every page it would be clear what version of the man-pages was
>> being viewed. Little sophistication would be demanded of the user to
>> check the Web to determine the relative age of the pages, independently
>> of the modification date of the particular page. Such usage would be
>> congruent with the argument's purpose in AT&T and BSD Unix, where this
>> datum was "7th Edition", "System III", or "4.2 Berkeley Distribution",
>> or similar.
>
> I thought about it in the past... That field was the only thing that
> said where a function came from. If we removed GNU (or something else),
> how would someone know where does the function or whatever comes from??
>
> I guess that's also why the colophon was appended to the pages by
> Michael. Since we couldn't use the 4th field for that, we had to have a
> COLOPHON section.
>
> However, the addition of the LIBRARY section seems to fix this issue,
> and so now we have an even more precise way to determine where a given
> function comes from (including the library file name, and the linker
> option).
>
> This gives me another argument for those who don't like to have a
> LIBRARY section for libc stuff (since -lc is unnecessary), and consider
> it noise.
>
>>
>> Further, as the libc-related man pages in this project expand coverage
>> to other libcs than GNU's, the alternatives to the empty string
>> proferred in man-pages(7) seem less and less appropriate.
>
> Agree. LIBRARY seems much more appropriate for that purpose.
>
> And this helps remove the COLOPHON section (or at least, we don't need
> to autogenerate it, since the version number now comes in .TH, and the
> COLOPHON is static; so I can even move it to a smaller REPORTING BUGS
> section).
Scripted change:
$ find man* -type f \
|xargs sed -Ei '/^.TH /s/(.TH +[^ ]+ +[^ ]+ +[^ ]+) +"[^"]*"/\1 "Linux man-pages (unreleased)"/'
$ find man* -type f \
|xargs sed -Ei '/^.TH /s/(.TH +[^ ]+ +[^ ]+ +[^ ]+) +[^" ]+/\1 "Linux man-pages (unreleased)"/'
$ git restore man5/tzfile.5
$ git restore man8/zdump.8
$ git restore man8/zic.8
$ git restore man7/bpf-helpers.7
Link: <https://lore.kernel.org/linux-man/20220819180323.dbsgxh5qvcjabjm6@jwilk.net/T/#u>
Reported-by: Jakub Wilk <jwilk@jwilk.net>
Reported-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
Cc: Ingo Schwarze <schwarze@openbsd.de>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>
Diffstat (limited to 'man1')
-rw-r--r-- | man1/getent.1 | 2 | ||||
-rw-r--r-- | man1/iconv.1 | 2 | ||||
-rw-r--r-- | man1/intro.1 | 2 | ||||
-rw-r--r-- | man1/ldd.1 | 2 | ||||
-rw-r--r-- | man1/locale.1 | 2 | ||||
-rw-r--r-- | man1/localedef.1 | 2 | ||||
-rw-r--r-- | man1/memusage.1 | 2 | ||||
-rw-r--r-- | man1/memusagestat.1 | 2 | ||||
-rw-r--r-- | man1/mtrace.1 | 2 | ||||
-rw-r--r-- | man1/pldd.1 | 2 | ||||
-rw-r--r-- | man1/sprof.1 | 2 | ||||
-rw-r--r-- | man1/time.1 | 2 |
12 files changed, 12 insertions, 12 deletions
diff --git a/man1/getent.1 b/man1/getent.1 index 832398336..f56fe09d2 100644 --- a/man1/getent.1 +++ b/man1/getent.1 @@ -3,7 +3,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH GETENT 1 2021-03-22 "Linux" "User Commands" +.TH GETENT 1 2021-03-22 "Linux man-pages (unreleased)" "User Commands" .SH NAME getent \- get entries from Name Service Switch libraries .SH SYNOPSIS diff --git a/man1/iconv.1 b/man1/iconv.1 index f9901ef37..c393f8ed1 100644 --- a/man1/iconv.1 +++ b/man1/iconv.1 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: GPL-2.0-or-later .\" -.TH ICONV 1 2021-08-27 "GNU" "Linux User Manual" +.TH ICONV 1 2021-08-27 "Linux man-pages (unreleased)" "Linux User Manual" .SH NAME iconv \- convert text from one character encoding to another .SH SYNOPSIS diff --git a/man1/intro.1 b/man1/intro.1 index b23ae8109..67180a445 100644 --- a/man1/intro.1 +++ b/man1/intro.1 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH INTRO 1 2020-08-13 "Linux" "Linux User's Manual" +.TH INTRO 1 2020-08-13 "Linux man-pages (unreleased)" "Linux User's Manual" .SH NAME intro \- introduction to user commands .SH DESCRIPTION diff --git a/man1/ldd.1 b/man1/ldd.1 index 8f69e0ec8..a2874248b 100644 --- a/man1/ldd.1 +++ b/man1/ldd.1 @@ -8,7 +8,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH LDD 1 2021-08-27 GNU "Linux Programmer's Manual" +.TH LDD 1 2021-08-27 "Linux man-pages (unreleased)" "Linux Programmer's Manual" .SH NAME ldd \- print shared object dependencies .SH SYNOPSIS diff --git a/man1/locale.1 b/man1/locale.1 index b86443e7c..8b86f6f1c 100644 --- a/man1/locale.1 +++ b/man1/locale.1 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH LOCALE 1 2021-03-22 "Linux" "Linux User Manual" +.TH LOCALE 1 2021-03-22 "Linux man-pages (unreleased)" "Linux User Manual" .SH NAME locale \- get locale-specific information .SH SYNOPSIS diff --git a/man1/localedef.1 b/man1/localedef.1 index 702840f6d..34787180d 100644 --- a/man1/localedef.1 +++ b/man1/localedef.1 @@ -12,7 +12,7 @@ .\" Lars Wirzenius to document new functionality (as of GNU .\" C library 2.3.5). .\" -.TH LOCALEDEF 1 2021-03-22 "Linux" "Linux User Manual" +.TH LOCALEDEF 1 2021-03-22 "Linux man-pages (unreleased)" "Linux User Manual" .SH NAME localedef \- compile locale definition files .SH SYNOPSIS diff --git a/man1/memusage.1 b/man1/memusage.1 index 4408e0e12..703a51230 100644 --- a/man1/memusage.1 +++ b/man1/memusage.1 @@ -2,7 +2,7 @@ .\" and Copyright (C) 2014, Michael Kerrisk <mtk.manpages@gmail.com> .\" .\" SPDX-License-Identifier: GPL-2.0-or-later -.TH MEMUSAGE 1 2021-03-22 "GNU" "Linux user manual" +.TH MEMUSAGE 1 2021-03-22 "Linux man-pages (unreleased)" "Linux user manual" .SH NAME memusage \- profile memory usage of a program .SH SYNOPSIS diff --git a/man1/memusagestat.1 b/man1/memusagestat.1 index 208d01719..115725899 100644 --- a/man1/memusagestat.1 +++ b/man1/memusagestat.1 @@ -1,7 +1,7 @@ .\" Copyright (c) 2013, Peter Schiffer <pschiffe@redhat.com> .\" .\" SPDX-License-Identifier: GPL-2.0-or-later -.TH MEMUSAGESTAT 1 2021-03-22 "GNU" "Linux programmer's manual" +.TH MEMUSAGESTAT 1 2021-03-22 "Linux man-pages (unreleased)" "Linux programmer's manual" .SH NAME memusagestat \- generate graphic from memory profiling data .SH SYNOPSIS diff --git a/man1/mtrace.1 b/man1/mtrace.1 index 1f23e3414..7d94883be 100644 --- a/man1/mtrace.1 +++ b/man1/mtrace.1 @@ -1,7 +1,7 @@ .\" Copyright (c) 2013, Peter Schiffer (pschiffe@redhat.com) .\" .\" SPDX-License-Identifier: GPL-2.0-or-later -.TH MTRACE 1 2021-03-22 "GNU" "Linux user manual" +.TH MTRACE 1 2021-03-22 "Linux man-pages (unreleased)" "Linux user manual" .SH NAME mtrace \- interpret the malloc trace log .SH SYNOPSIS diff --git a/man1/pldd.1 b/man1/pldd.1 index d27f88b54..56e778e7c 100644 --- a/man1/pldd.1 +++ b/man1/pldd.1 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH PLDD 1 2020-11-01 "GNU" "Linux User Manual" +.TH PLDD 1 2020-11-01 "Linux man-pages (unreleased)" "Linux User Manual" .SH NAME pldd \- display dynamic shared objects linked into a process .SH SYNOPSIS diff --git a/man1/sprof.1 b/man1/sprof.1 index cef1b27a8..6fe52dbd9 100644 --- a/man1/sprof.1 +++ b/man1/sprof.1 @@ -2,7 +2,7 @@ .\" .\" SPDX-License-Identifier: Linux-man-pages-copyleft .\" -.TH SPROF 1 2020-11-01 "Linux" "Linux User Manual" +.TH SPROF 1 2020-11-01 "Linux man-pages (unreleased)" "Linux User Manual" .SH NAME sprof \- read and display shared object profiling data .SH SYNOPSIS diff --git a/man1/time.1 b/man1/time.1 index c609cf75e..707370be5 100644 --- a/man1/time.1 +++ b/man1/time.1 @@ -4,7 +4,7 @@ .\" .\" SPDX-License-Identifier: GPL-1.0-or-later .\" -.TH TIME 1 2019-03-06 GNU "Linux User's Manual" +.TH TIME 1 2019-03-06 "Linux man-pages (unreleased)" "Linux User's Manual" .SH NAME time \- time a simple command or give resource usage .SH SYNOPSIS |