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

Bug#39830: [AMENDMENT]: get rid of undocumented(7) symlinks



On Tue, Nov 12, 2002 at 12:53:35PM +0000, Colin Watson wrote:
> +	  There should be a manual page at least for every program.  If
> +	  no manual page is available, this is considered as a bug and
> +	  should be reported to the Debian Bug Tracking System (the
> +	  maintainer of the package is allowed to write this bug report
> +	  himself, too).  Do not close the bug report until a proper
> +	  manpage is available.<footnote>

This wording is unclear, it could be misinterpreted by newbie maintainers to
mean no manual page at all in the package, as opposed to no manual page per
each shipped program. Yeah, I know, I'm nitpicking. :)

Note that I don't want to second this proposal even if you fix the above,
because I think the undocumented(7) manual page is better than nothing for
total newbies. Sorry. :)

(Thanks for not outlawing it -- then I'd have to object.)

> +	      It is not very hard to write a man page. See the <url
> +	      id="http://www.schweikhardt.net/man_page_howto.html";
> +	      name="Man-Page-HOWTO">, <tt>man(7)</tt>, the examples
> +	      created by <tt>debmake</tt> or <tt>dh_make</tt>, or the
> +	      directory <file>/usr/share/doc/man-db/examples</file>.

Oh, and that should be <manref name="man" section="7">.

And s,<tt>debmake</tt> or,,; >:)

-- 
     2. That which causes joy or happiness.



Reply to: