Re: Bug#106073: recommend to install <package> documentation into /usr/share/doc/<package>/
Le Fri, Jan 06, 2012 at 09:13:13AM -0800, Russ Allbery a écrit :
>
> Discussion, objections, seconds?
Dear Russ,
overall, I am very positive with your changes, but here are two comments that I
hope can improve the section.
> + <p>
> + Any separate package providing documentation must still install
> + standard documentation files in its
> + own <file>/usr/share/doc</file> directory as specified in the
> + rest of this policy. See, for example, <ref id="copyrightfile">
> + and <ref id="changelogs">.
> + </p>
There have been recurrent discussions about /usr/share/doc/<var>package</var>-doc
being a symbolic link to /usr/share/doc/<var>package</var>. In my understanding,
this is discouraged now. Perhaps this desserves a footnote ?
> + Any files that are referenced by programs but are
> + also useful as stand alone documentation should be installed
> + elsewhere, normally
> + under <file>/usr/share/<var>package</var>/</file>, and then
> + included via symbolic links
> + in <file>/usr/share/doc/<var>package</var></file>.
While ‘referenced’ is in the original wording, maybe it could be clarified.
For instance, if the help page of a program contains “Please refer to
the Foo specification”, and the spec is in /usr/share/doc, I assume that
it can stay there ?
Have a nice day,
--
Charles Plessy
Tsurumi, Kanagawa, Japan
Reply to: