emacs-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#62854: closed (aclocal: Man page “Name” section should be revised to


From: GNU bug Tracking System
Subject: bug#62854: closed (aclocal: Man page “Name” section should be revised to be conformant to the POSIX man specification)
Date: Tue, 30 May 2023 00:57:03 +0000

Your message dated Mon, 29 May 2023 18:56:05 -0600
with message-id <202305300056.34U0u5u4015303@freefriends.org>
and subject line Re: bug#62853: Man page “Name” section should be revised to be 
conformant to the POSIX man specification
has caused the debbugs.gnu.org bug report #62853,
regarding aclocal: Man page “Name” section should be revised to be conformant 
to the POSIX man specification
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs@gnu.org.)


-- 
62853: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=62853
GNU Bug Tracking System
Contact help-debbugs@gnu.org with problems
--- Begin Message --- Subject: aclocal: Man page “Name” section should be revised to be conformant to the POSIX man specification Date: Fri, 14 Apr 2023 17:43:37 +0200
Hello,

Currently, the "Name" section of the aclocal man page reads "aclocal - manual page for aclocal 1.16.5" This is problematic for two reasons:

- It is redundant, as there is no need to mention that it is a manual page. Also, the version is already available in the footer of the man page.
- More importantly, the text is non-conformant to the POSIX man specification because the "name" sections is used to generate the "utilities summary database" (used for the "man -k" or the "apropos" command), which should be a "terse description of the purpose of the utility". The current text does not describe what aclocal does or how it can be used.

POSIX specification for the man command: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/man.html

Thanks for your time.

--- End Message ---
--- Begin Message --- Subject: Re: bug#62853: Man page “Name” section should be revised to be conformant to the POSIX man specification Date: Mon, 29 May 2023 18:56:05 -0600
Hi Sebastian,

    Currently, the "Name" section of the automake man

I just committed a change to set the Name section, as you suggested.
We'll now have (based on the --help message):

aclocal - Generate aclocal.m4 by scanning configure.ac
automake - Generate Makefile.in files for configure from Makefile.am

Thanks again for the report,
Karl


--- End Message ---

reply via email to

[Prev in Thread] Current Thread [Next in Thread]