Groups > linux.debian.maint.python > #7812

Re: dh-python (pybuild + dh_py*) documentation

Path	csiph.com!eternal-september.org!feeder.eternal-september.org!aioe.org!bofh.it!news.nic.it!robomod
From	Matthias Klose <doko@debian.org>
Newsgroups	linux.debian.maint.python
Subject	Re: dh-python (pybuild + dh_py*) documentation
Date	Wed, 28 Oct 2015 13:30:02 +0100
Message-ID	<qoy1A-2xS-19@gated-at.bofh.it> (permalink)
References	<qnOi6-7DV-19@gated-at.bofh.it>
X-Original-To	debian-python@lists.debian.org
X-Mailbox-Line	From debian-python-request@lists.debian.org Wed Oct 28 12:25:43 2015
Old-Return-Path	<doko@debian.org>
X-Amavis-Spam-Status	No, score=-7.7 tagged_above=-10000 required=5.3 tests=[BAYES_00=-2, LDO_WHITELIST=-5, RCVD_IN_DNSWL_LOW=-0.7] autolearn=ham autolearn_force=no
X-Policyd-Weight	using cached result; rate: -5
Old-X-Envelope-From	doko@debian.org
Old-X-Envelope-To	<debian-python@lists.debian.org>
User-Agent	Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.2.0
MIME-Version	1.0
Content-Type	text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding	8bit
X-Mailing-List	<debian-python@lists.debian.org> archive/latest/13125
List-ID	<debian-python.lists.debian.org>
List-URL	<https://lists.debian.org/debian-python/>
List-Archive	https://lists.debian.org/msgid-search/5630BEB9.3060604@debian.org
Approved	robomod@news.nic.it
Lines	38
Organization	linux.* mail to news gateway
Sender	robomod@news.nic.it
X-Original-Date	Wed, 28 Oct 2015 13:25:29 +0100
X-Original-Message-ID	<5630BEB9.3060604@debian.org>
X-Original-References	<20151026113605.GW15907@sar0.p1otr.com>
Xref	csiph.com linux.debian.maint.python:7812

Show key headers only | View raw

On 26.10.2015 12:36, Piotr Ożarowski wrote:
> there are manpages: pybuild¹, dh_python3² / dh_python2³ / dh_pypy⁴
> there's a wiki page⁵ with examples, there's even
> /usr/share/doc/dh-python/README.PyDist⁶ and a talk⁷ about pybuild during
> DebConf... but people still tell me dh-python's documentation sucks
> so...

talks and mailing list discussions are forgotten.

> How can I improve it? Do you need more detailed description of options?
> Do you need more examples? Or maybe I should hide most of options, the
> "corner case" ones? I focus on making things work out of the box, if
> possible, and make it very customizable so that weird corner cases are
> possible as well - this means there are a lot of options, is this the
> problem?
>
> Can you be more specific about what's missing?

Agreed on the high level overview.  Maybe somebody could come up with a table of 
contents, and then people can start filling that? There was at least one comment 
from a book author ;)

I'd like to see a section with examples too, maybe even referencing particular 
packages, which show good practice for a given use case, or which demonstrate 
some feature.

Please don't hide things.  When I see something in a build log, I'd like to be 
able to reproduce it.  pybuild writes these "I: ..." messages, but these are 
still incomplete. It would be good to see directory changes and other side 
effects like setting of env vars and written config files as well.  I found 
these missing while looking at #803242. However asking you on irc usually helps 
;)  Having these build logs a bit more verbose won't hurt.

The #803242 is exposed by having packages built with multiple python versions, 
so maybe it would have been found by a testsuite, or some autopkg tests.  A 
testsuite for the pybuild features would be very nice to have.

Matthias

Thread

dh-python (pybuild + dh_py*) documentation Piotr Ożarowski <piotr@debian.org> - 2015-10-26 12:40 +0100
  Re: dh-python (pybuild + dh_py*) documentation Raphael Hertzog <hertzog@debian.org> - 2015-10-26 18:30 +0100
    Re: dh-python (pybuild + dh_py*) documentation Barry Warsaw <barry@debian.org> - 2015-10-27 20:20 +0100
    Re: dh-python (pybuild + dh_py*) documentation Piotr Ożarowski <piotr@debian.org> - 2015-10-28 14:10 +0100
      Re: dh-python (pybuild + dh_py*) documentation Nikolaus Rath <Nikolaus@rath.org> - 2015-10-28 17:40 +0100
        Re: dh-python (pybuild + dh_py*) documentation Piotr Ożarowski <piotr@debian.org> - 2015-10-28 18:00 +0100
          Re: dh-python (pybuild + dh_py*) documentation Barry Warsaw <barry@debian.org> - 2015-10-28 19:30 +0100
  Re: dh-python (pybuild + dh_py*) documentation Matthias Klose <doko@debian.org> - 2015-10-28 13:30 +0100
    Re: dh-python (pybuild + dh_py*) documentation Brian May <bam@debian.org> - 2015-10-28 22:50 +0100

csiph-web