[Top][All Lists]

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

[bug-inetutils] Re: man pages

From: Simon Josefsson
Subject: [bug-inetutils] Re: man pages
Date: Tue, 08 Dec 2009 15:15:46 +0100
User-agent: Gnus/5.110011 (No Gnus v0.11) Emacs/23.1 (gnu/linux)

"Alfred M. Szmidt" <address@hidden> writes:

> Though a small note, the following ChangeLog entries don't follow GNU
> practise, they describe the purpose of change, when they should
> describe the actual code changes.  Take the first one as an example,
> it introduces a new variable `all', modifies EXTRA_DIST, and
> MAINTAINERCLEANFILES, none of which are mentioned.  So the ChangeLog
> entry should mention those changes, could you fix that?

Should be done now.

> We also avoid wildcards, so the file renames should mention what file
> they got renamed to, otherwise it is hard to search for `ftpd.h2m' to
> see when it was introduced, moved, etc.

Also fixed.

> Descriprive comments should be in the source code, so why we use .h2m
> as an extention instead of the (common?) .x should be in the
> Makefile.am not in ChangeLog.

I removed the rationale from the ChangeLog -- but I don't think the
rationale needs to be documented in the Makefile.a, feel free to add it
if you believe a comment there will be useful.

The help2man package itself uses .h2m as the file extension, and it is
mentioned in the help2man manual.  Is there any package other than
coreutils that uses .x as the extension?  It would have helped if the
help2man manual was a bit more explicit about a file name convention, so
I'll report this separately to the help2man maintainer.


reply via email to

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