bug#59631: 29.0.50; [PATCH] New check-man target to check man pages for errors

[Stefan Kangas <stefankangas@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 284 bytes --]

Eli Zaretskii <eliz@gnu.org> writes:

> Thanks, but I think it is better to have this as a script in admin/, not a
> rule in the top-level Makefile.  Especially since it requires specialized
> tools and setups.

OK, please find attached a new patch making this into a script instead.

[-- Attachment #2: 0001-New-script-admin-check-man-pages.patch --]
[-- Type: text/x-diff, Size: 1932 bytes --]

From 559b88afc3d56ee9d5116754e013383920290dea Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Sun, 27 Nov 2022 18:37:37 +0100
Subject: [PATCH] New script admin/check-man-pages

* admin/check-man-pages: New file with script used to check man pages
for errors.
---
 admin/check-man-pages | 44 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100755 admin/check-man-pages

diff --git a/admin/check-man-pages b/admin/check-man-pages
new file mode 100755
index 0000000000..3f3190d495
--- /dev/null
+++ b/admin/check-man-pages
@@ -0,0 +1,44 @@
+#!/bin/bash
+### check-man-pages - check man pages for errors
+
+## Copyright (C) 2022 Free Software Foundation, Inc.
+
+## This file is part of GNU Emacs.
+
+## GNU Emacs is free software: you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 3 of the License, or
+## (at your option) any later version.
+
+## GNU Emacs is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+
+## You should have received a copy of the GNU General Public License
+## along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
+
+### Commentary:
+
+## Check our man pages for errors using `man'.
+
+### Code:
+
+source "${0%/*}/emacs-shell-lib"
+
+exit_status=0
+
+cd "$PD"/../doc/man
+for page in *.1; do
+    log=$(emacs_mktemp)
+    LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
+        man --warnings -E UTF-8 -l -Tutf8 -Z "$page" >/dev/null 2> $log
+    log_size=$(stat --format=%s "$log")
+    if [ $log_size -ne 0 ]; then
+        echo "doc/man/$page:"
+        cat $log
+        exit_status=1
+    fi
+done
+
+exit $exit_status
-- 
2.35.1