Bug#106073: recommend to install <package> documentation into /usr/share/doc/<package>/
Charles Plessy <plessy@debian.org> writes:
> 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 ?
I tried to avoid changing anything in this area because we have another
bug with quite a bit of discussion about that (#556015 and its merged bug)
and resolving that is going to be more work. That section was just an
attempt to preserve the status quo until we can deal with the other issue,
since I'm not sure what the outcome will be.
>> + 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 ?
Oh, yes. The intent here is that any files that are used or read by
programs need to not be in /usr/share/doc so that those programs don't
break; just referring to that area in, say, help text in the program is
fine. I'll reword this.
--
Russ Allbery (rra@debian.org) <http://www.eyrie.org/~eagle/>
Reply to: