mirror/findutils
1
0
Fork 0
mirror of https://https.git.savannah.gnu.org/git/findutils.git synced 2026-01-27 01:44:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: populate man pages' headers and footers more

Browse Source 
Style warnings from `groff -rCHECKSTYLE=3 -man`.
an.tmac:/.../share/man/man1/locate.1:1: style: .TH missing third argument; \
  consider document modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:/.../share/man/man1/locate.1:1: style: .TH missing fourth argument; \
  consider package/project name and version (e.g., "groff 1.23.0")
...and similar.

groff_man_style(7):
     .TH identifier section [footer‐middle [footer‐inside [header‐
     middle]]]
...
            By convention, footer‐middle is the date of the most recent
            modification to the man page source document, and footer‐
            inside is the name and version or release of the project
            providing it.

* find/find.1:
* locate/locate.1:
* locate/locatedb.5:
* locate/updatedb.1:
* xargs/xargs.1: Add appropriate third and fourth arguments to `TH` macro calls.

To determine the revision date to include in the page, I used the Git
"AuthorDate" of the last commit consituting anything but a "bump" to the
copyright notice.

Discussed at:
https://lists.gnu.org/r/bug-findutils/2025-11/msg00094.html

Copyright-paperwork-exempt: Yes
This commit is contained in:
G. Branden Robinson 2025-11-18 21:44:11 -06:00 committed by Bernhard Voelker
parent 2749632838
commit 627072f022
5 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
find/find.1
View File

@ -1,5 +1,5 @@
'\" t
.TH FIND 1 \" -*- nroff -*-
.TH FIND 1 2025-10-12 findutils \" -*- nroff -*-
.SH NAME
find \- search for files in a directory hierarchy
.SH SYNOPSIS

2
locate/locate.1
View File

@ -1,4 +1,4 @@
.TH LOCATE 1 \" -*- nroff -*-
.TH LOCATE 1 2020-12-27 findutils \" -*- nroff -*-
.SH NAME
locate \- list files in databases that match a pattern
.

2
locate/locatedb.5
View File

@ -1,4 +1,4 @@
.TH LOCATEDB 5 \" -*- nroff -*-
.TH LOCATEDB 5 2020-12-27 findutils \" -*- nroff -*-
.SH NAME
locatedb \- front-compressed file name database
.

2
locate/updatedb.1
View File

@ -1,4 +1,4 @@
.TH UPDATEDB 1 \" -*- nroff -*-
.TH UPDATEDB 1 2023-11-10 findutils \" -*- nroff -*-
.SH NAME
updatedb \- update a file name database
.SH SYNOPSIS

2
xargs/xargs.1
View File

@ -1,4 +1,4 @@
.TH XARGS 1 \" -*- nroff -*-
.TH XARGS 1 2024-06-03 findutils \" -*- nroff -*-
.SH NAME
xargs \- build and execute command lines from standard input
.SH SYNOPSIS