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

Re: Examples


Le 5 mai 08 à 15:50, Cyril Brulebois a écrit :

On 05/05/2008, Thibaut Paumard wrote:

Actually I was sort of guessing the only package allowed to put
anything under /usr/share/doc/<package>/ was <package> itself. It's
probably the core of the original post. Is this assumption incorrect?


AFAICT, yes. Particularly when the binaries come from the very same
source, so that the maintainer is kind of aware of the possible
implications of moving this or that bit of doc from a package to
another (e.g. can handle moving a manpage/HTML manual or two from/ to the 
$foo package -- say it's considered core documentation -- to/from the
$foo-doc package, possibly setting Replaces: where needed, etc.).


I have no precise excerpt from policy to back it up.


:)


Note that /usr/share/doc/<package>-doc/ will be created anyway.
If it contains the usual Debian changelog and copyright file, there's no 
reason to have a look there in the first place. If one installs
$foo-doc, isn't it a bit logical to check for its documentation in
/u/s/d/$foo?
People tend to find logical what they are used too. If it's a matter of surprising the least possible number of users, ask a sociology student to make a real study, because I wouldn't trust any wild guess. I'm used to finding all doc under the -doc directory (logical, isn't it? ;-), and only copyright+license under the other one... 


If the actual doc is installed under /usr/share/doc/<package>/, then
/usr/share/doc/<package>-doc/ should definitely point to it somehow,
via symlink(s) or README.Debian.


Beware of symlinking. That means a strict dependency (because of the
copyright file). And one probably doesn't want to update a possibly
several dozens MB large -doc package when moving from 1.2.3 to 1.2.4,
which is say a bugfix release only. Not to mention what happens when the 
package gets binNMU'd. Want to update a -doc package for that? Oh, and
the funny part: how do you declare a strict Depends: on an Arch: any
package from an Arch: all package?


I was talking of something like
 /u/s/d/<package>-doc/html -> /u/s/d/<package>/html/
where both are created in the -doc package, not
 /u/s/d/<package>-doc -> /u/s/d/<package>/
which is a really bad idea, for the reasons you mention and more. If at all possible, I believe <package>-doc packages should Suggests: <package> rather than Depends: on them. Use case: reading the doc on my local machine while running the software on another one. 

Regards, Thibaut.

Attachment: PGP.sig
Description: =?ISO-8859-1?Q?Ceci_est_une_signature_=E9lectronique_PGP?=

Reply to: