Path: csiph.com!aioe.org!bofh.it!news.nic.it!robomod
From: Tiago Ilieve <tiago.myhro@gmail.com>
Newsgroups: linux.debian.maint.python
Subject: Properly splitting Python "-doc" packages
Date: Thu, 14 Apr 2016 15:20:02 +0200
Message-ID: <rnPlE-2aV-3@gated-at.bofh.it>
Old-Return-Path: <tiago.myhro@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Approved: robomod@news.nic.it
Lines: 47
Organization: linux.* mail to news gateway
Sender: robomod@news.nic.it
Xref: csiph.com linux.debian.maint.python:8427

Hi,

I was working on the "boostrap-vz" package and noticed something
really annoying when creating a "boostrap-vz-doc"[1] binary package
with its Sphinx documentation: the actual Python files that composes
the application weren't being packaged on the main "boostrap-vz" one.
I had to add "usr/lib/python*/dist-packages/bootstrapvz/" to its
"debian/boostrap-vz.install"[2] to fix this, but I feel this is wrong.
Looking at other Python packages that have separate "-doc" packages,
like "python-django", they don't seem to need this.

Also, its "*.egg-info/" folder also went missing, as we can see with "debdiff":

Files in first .deb but not in second
-------------------------------------
-rw-r--r--  root/root
/usr/lib/python2.7/dist-packages/bootstrap_vz-0.9.5.egg-info/PKG-INFO
-rw-r--r--  root/root
/usr/lib/python2.7/dist-packages/bootstrap_vz-0.9.5.egg-info/dependency_links.txt
-rw-r--r--  root/root
/usr/lib/python2.7/dist-packages/bootstrap_vz-0.9.5.egg-info/entry_points.txt
-rw-r--r--  root/root
/usr/lib/python2.7/dist-packages/bootstrap_vz-0.9.5.egg-info/requires.txt
-rw-r--r--  root/root
/usr/lib/python2.7/dist-packages/bootstrap_vz-0.9.5.egg-info/top_level.txt

This broke its entry point scripts (at least I finally find out the
cause of the "pkg_resources.DistributionNotFound" error), so I had to
either add custom ones[3] or add
"usr/lib/python2.7/dist-packages/bootstrap_vz-*.egg-info/" to its
"debian/boostrap-vz.install" file as well.

Any ideas on what I missed here?

Regards,
Tiago.

[1]: https://anonscm.debian.org/git/cloud/bootstrap-vz.git/commit/?id=899e841f89d17418de77e5d7f56ff48627415e79
[2]: https://anonscm.debian.org/git/cloud/bootstrap-vz.git/commit/?id=7d0cf538f8e806f83529b3b7cad9af3ee93cca42
[3]: https://anonscm.debian.org/git/cloud/bootstrap-vz.git/commit/?id=d8ec5b17af1f96d9b1221963abf5abc3ef087900

-- 
Tiago "Myhro" Ilieve
Blog: https://blog.myhro.info/
GitHub: https://github.com/myhro
LinkedIn: https://br.linkedin.com/in/myhro
Montes Claros - MG, Brasil