[bug-inetutils] wishlist: please suggest file name convention for --include files

[Simon Josefsson]

Hi Brendan,

First thank you for creating help2man, I use it in several projects.

The discussion below came up on the GNU InetUtils list.  I used .h2m as
the file name extension because I noticed that help2man used it
internally, however this convention is not very well documented.  How
about something like this to hopefully improve consistency?

--- help2man.texi~      2005-10-04 12:14:09.000000000 +0200
+++ help2man.texi       2009-12-08 15:23:03.000000000 +0100
@@ -279,7 +279,9 @@
 
 Additional static text may be included in the generated manual page by
 using the @samp{--include} and @samp{--opt-include} options
-(@pxref{Invoking help2man}).
+(@pxref{Invoking help2man}).  While these files can be named anything,
+for consistency we suggest to use the extension @code{.h2m} for
+help2man include files.
 
 The format for files included with these option is simple:
 
Thanks,
/Simon

Simon Josefsson <address@hidden> writes:

>> 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.
>
> /Simon