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

Re: Policy 12.3: should I rename?

* Shachar Shemesh <shachar@debian.org>, 2016-07-16, 23:04:
The package currently ships the docs in a package calles "libargtable2-docs" (plural). I am wondering whether I should rename it, and how to do it.

As far as I can tell, I have three options:

1. Don't rename. It's only a "recommends".
2. Rename with full transitional package
3. Rename without transitional package

The incentive for doing 3 is that the dev package already depends on the docs package, so a transitional package might not be all that important.

Another question I have is regarding packaging. The Policy suggests that libargtable2-doc should install the docs to /usr/share/doc/libargtable2.

Policy is rather unclear about the details[0], but I don't think anybody would expect to find API documentation in /usr/share/doc/libargtable2, especially when no package named "libargtable2" exists.

I would expect to find these files in /usr/share/doc/libargtable2-dev.

It seems that debhelper is not a friend in that regard, pushing me to install to /usr/share/doc/libargtable2-doc. Am I missing some option that would make that easy?

You can use dh_install, instead of dh_installdocs, which lets you choose destination directory.

Or maybe you could merge -dev and -doc(s) packages? The documentation is currently pretty big, mostly because of suspiciously large PDF and PS files. Perhaps you could make them smaller somehow, or get rid of them completely? I think HTML documentation would be sufficient for most (all?) users.

[0] Literal interpretation of §12.3 is that documentation for "libargtable2-dev" should be in the package named "libargtable2-dev-doc", but I don't think that's what we want.

Jakub Wilk

Reply to: