[PATCH 02/42] doc: populate man pages' headers and footers more

"G. Branden Robinson" <[email protected]> Tue, 18 Nov 2025 21:44:11 -0600
Newsgroups	gmane.comp.gnu.findutils.bugs
Message-ID	<20251119034411.ng7rxwf6qpnk5e3g@illithid>
* 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.

Fixes 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.

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.
---
 find/find.1       | 2 +-
 locate/locate.1   | 2 +-
 locate/locatedb.5 | 2 +-
 locate/updatedb.1 | 2 +-
 xargs/xargs.1     | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/find/find.1 b/find/find.1
index 9c241c01..0ccbd801 100644
--- a/find/find.1
+++ b/find/find.1
@@ -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
diff --git a/locate/locate.1 b/locate/locate.1
index b8fce73a..b65d9036 100644
--- a/locate/locate.1
+++ b/locate/locate.1
@@ -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
 .
diff --git a/locate/locatedb.5 b/locate/locatedb.5
index 17d6532a..da08fc36 100644
--- a/locate/locatedb.5
+++ b/locate/locatedb.5
@@ -1,4 +1,4 @@
-.TH LOCATEDB 5 \" -*- nroff -*-
+.TH LOCATEDB 5 2020-12-27 findutils \" -*- nroff -*-
 .SH NAME
 locatedb \- front-compressed file name database
 .
diff --git a/locate/updatedb.1 b/locate/updatedb.1
index c6cdb47d..07eac5ee 100644
--- a/locate/updatedb.1
+++ b/locate/updatedb.1
@@ -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
diff --git a/xargs/xargs.1 b/xargs/xargs.1
index 017173a0..13799318 100644
--- a/xargs/xargs.1
+++ b/xargs/xargs.1
@@ -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
-- 
2.30.2
signature.asc (application/pgp-signature, 833 B)