review request: firmware-tools, ubuntu/debian sponsor needed

Michael E Brown Michael_E_Brown at Dell.com
Thu May 24 01:30:37 CDT 2007


On Thu, May 24, 2007 at 01:07:57AM -0500, B, Sadhana - Authorized Dell Representative wrote:
> Can we move the MANIFEST.in generation out of setup.py?

We could, but I dont see much point. Inside setup.py we already need to
know all the info that goes in MANIFEST.in. Either change the debian
rules to run a make distclean for the clean target, or change the clean
target in the Makefile to remove the manifest.

--
Michael

ps. Did you see the note about the move of python packages into
firmwaretools/?

pps. this should be on firmware-tools-devel. adding to cc.

> 
> -----Original Message-----
> From: B, Sadhana - Authorized Dell Representative 
> Sent: Thursday, May 24, 2007 10:52 AM
> To: Brown, Michael E
> Cc: Shandilya, Sandeep K
> Subject: RE: review request: firmware-tools, ubuntu/debian sponsor
> needed
> 
>  
> What to do about the auto generated MANIFEST.in file in
> build/firmware-*/ ?
> 
> -----Original Message-----
> From: Martin Pitt [mailto:martin.pitt at ubuntu.com]
> Sent: Wednesday, May 16, 2007 7:51 PM
> To: Brown, Michael E
> Cc: Scott James Remnant; B, Sadhana - Authorized Dell Representative;
> Shandilya, Sandeep K; Martin Pitt
> Subject: Re: review request: firmware-tools, ubuntu/debian sponsor
> needed
> 
> Hi Michael, hey Sadhana,
> 
> (keeping Scott in CC for the initial 'bonding'. We can drop him out of
> CC for the following technical discussions).
> 
> glad to get to know you!
> 
> Michael E Brown [2007-05-15 23:56 -0500]:
> > Martin, Scott,
> > 
> >     I met Scott a couple weeks ago when he came to Dell with Mark to 
> > give an Ubuntu tech presentation. At that point, Scott helped me with 
> > the packaging for firmware-tools (thanks!). Sadhana and I have done 
> > some work on it since then and need some help and guidance on how to
> proceed.
> 
> I'm happy to help you with becoming developers and guide you through the
> processes. I can help you with Debian as well, but let's settle the
> package in Ubuntu first since it will be much quicker (both package
> processing and becoming an official developer).
> 
> >  -- package review for firmware-tools and firmware-addon-dell (to be 
> > posted I'm working on the final details now). We have only a small 
> > amount of Debian/Ubuntu experience.
> 
> I have reviewed them and still have some comments. I'll just quote the
> source package .diff.gz here and put comments at the right spot:
> 
> 
> ===== firmware-tools =====
> 
> | --- firmware-tools-1.2.6.orig/debian/control
> | +++ firmware-tools-1.2.6/debian/control
> | @@ -0,0 +1,20 @@
> | +Source: firmware-tools
> | +Section: admin
> | +Priority: extra
> | +Maintainer: Sadhana B <sadhana_b at dell.com>
> | +Build-Depends: debhelper (>= 5), python-all-dev (>= 2.3.5-11), cdbs 
> | +(>= 0.4.43), python-support (>= 0.5.3)
> | +XS-Python-Version: all
> 
> This should probably be 'current', depending on whether you want public
> or private Python modules. Please see the discussion for debian/rules
> below for details.
> 
> | --- firmware-tools-1.2.6.orig/debian/changelog
> | +++ firmware-tools-1.2.6/debian/changelog
> | @@ -0,0 +1,5 @@
> | +firmware-tools (1.2.6-1) unstable; urgency=low
> 
> This would be fine for Debian. For Ubuntu you need to specify the
> current development release, which is 'gutsy' at the moment.
> 
> | + -- Michael Brown
> | + <michael_e_brown at debian-sarge-i386.linuxdev.us.dell.com>  Mon, 30 
> | + Apr 2007 03:28:59 -0500
> 
> This should be a more official email address. I guess the host name can
> be dropped? Also, if Sadhana is the official package maintainer, then it
> is more common to have his email address here. (This is a requirement
> for Debian, and just common practice for Ubuntu)
> 
> | --- firmware-tools-1.2.6.orig/debian/copyright
> | +++ firmware-tools-1.2.6/debian/copyright
> | @@ -0,0 +1,11 @@
> | [...]
> | +Upstream source is dual licensed GPL/OSL.
> 
> This file needs at least the usual GPL stub and a pointer to the
> complete file. I. e. just append this:
> 
> --------- snip ------------
>   This program is free software; you can redistribute it and/or modify
>   it under the terms of the GNU General Public License as published by
>   the Free Software Foundation; either version 2 of the License, or
>   (at your option) any later version.
> 
>   This program is distributed in the hope that it will be useful,
>   but WITHOUT ANY WARRANTY; without even the implied warranty of
>   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>   GNU General Public License for more details.
> 
>   You should have received a copy of the GNU General Public License
>   along with this program; if not, write to the Free Software
>   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
> USA
> 
> On Debian systems, the complete text of the GNU General Public License
> can be found in `/usr/share/common-licenses/GPL'.
> --------- snip ------------
> 
> | --- firmware-tools-1.2.6.orig/debian/firmware-tools.postinst
> | +++ firmware-tools-1.2.6/debian/firmware-tools.postinst
> | @@ -0,0 +1,5 @@
> | +#!/bin/sh
> | +
> | +set -e
> | +
> | +#DEBHELPER#
> | --- firmware-tools-1.2.6.orig/debian/firmware-tools.prerm
> | +++ firmware-tools-1.2.6/debian/firmware-tools.prerm
> | @@ -0,0 +1,6 @@
> | +#!/bin/sh
> | +
> | +set -e
> | +
> | +#DEBHELPER#
> | +
> 
> Those should be removed. You only need maintainer scripts if you
> actually want to do custom stuff in them. If debhelper wants to expand
> #DEBHELPER# to do something, then it will create scripts from scratch if
> it needs to. Right now you have to empty scripts.
> 
> | --- firmware-tools-1.2.6.orig/debian/rules
> | +++ firmware-tools-1.2.6/debian/rules
> | @@ -0,0 +1,9 @@
> | +#!/usr/bin/make -f
> | +# -*- makefile -*-
> | +# vim:noet:ts=8:sw=8:filetype=make
> | +
> | +DEB_PYTHON_SYSTEM=pysupport
> | +include /usr/share/cdbs/1/rules/debhelper.mk
> | +include /usr/share/cdbs/1/rules/simple-patchsys.mk
> | +include /usr/share/cdbs/1/class/python-distutils.mk
> 
> Right in general, but this is set up (by default) for public python
> modules. Thus the modules land in
> /usr/share/python-support/firmware-tools/, where they can be directly
> imported with e. g. 'import repository' from any python program. The
> module names are way too generic for this (repository, package, etc.).
> Also, if they are useful for other packages, public Python
> modules/packages should be shipped in a separarate binary package
> python-<module_or_package_name>.
> 
> So you should either:
> 
>  - put those modules into a python package 'firmware_tools' to get a
>    proper namespace for them.
> 
> or
> 
>  - ship them as private python modules in /usr/share/firmware-tools/
>    and specify that path as pysupport argument, and
>  - use 'XS-Python-Version: current' in debian/control (since they do
>    not need to be provided for *all* available python versions)
> 
>  - Alternatively you can stop using python-support and just install
>    them manually into the right place. 
> 
>  - In both cases you need to add the directory to sys.path in the
> source.
> 
> Please see [1] for details.
> 
> | --- firmware-tools-1.2.6.orig/MANIFEST.in
> | +++ firmware-tools-1.2.6/MANIFEST.in
> 
> This is a new file, and looks like auto-generated. It seems that
> debian/rules clean should remove this? If it's intended to be there, it
> should be part of the orig.tar.gz. Ideally the package diff.gz only
> contains files in debian/.
> 
> ==== firmware-addon-dell ====
> 
> | --- firmware-addon-dell-1.2.13.orig/debian/control
> | +++ firmware-addon-dell-1.2.13/debian/control
> | @@ -0,0 +1,18 @@
> | +Source: firmware-addon-dell
> | +Section: admin
> | +Priority: extra
> | +Maintainer: Sadhana B <sadhana_b at dell.com>
> | +Build-Depends: debhelper (>= 5), python-all-dev (>= 2.3.5-11), cdbs 
> | +(>= 0.4.43), python-support (>= 0.5.3)
> | +XS-Python-Version: all
> 
> Same considerations wrt. Python policy as for firmware-tools.
> 
> | +Package: firmware-addon-dell
> | +Architecture: any
> 
> There is nothing platform dependent in the package, so this should be
> 'all'.
> 
> | +Depends: ${python:Depends}, libsmbios-bin, firmware-tools (> 0:1.1)
> 
> It is against common practice to specify '0' epochs, so just '1.1'.
> Also, since that package is not in Debian/Ubuntu yet, you do not need to
> specify versions for now.
> 
> | --- firmware-addon-dell-1.2.13.orig/debian/copyright
> | +++ firmware-addon-dell-1.2.13/debian/copyright
> | @@ -0,0 +1,11 @@
> | [...]
> | +Upstream source is dual licensed GPL/OSL.
> 
> Same problem as in firmware-tools.
> 
> | --- firmware-addon-dell-1.2.13.orig/debian/rules
> | +++ firmware-addon-dell-1.2.13/debian/rules
> | @@ -0,0 +1,9 @@
> | +#!/usr/bin/make -f
> | +# -*- makefile -*-
> | +# vim:noet:ts=8:sw=8:filetype=make
> | +
> | +DEB_PYTHON_SYSTEM=pysupport
> | +include /usr/share/cdbs/1/rules/debhelper.mk
> | +include /usr/share/cdbs/1/rules/simple-patchsys.mk
> | +include /usr/share/cdbs/1/class/python-distutils.mk
> 
> Same considerations wrt. Python policy as for firmware-tools. Please
> either use private modules or a proper namespace.
> 
> | --- firmware-addon-dell-1.2.13.orig/debian/changelog
> | +++ firmware-addon-dell-1.2.13/debian/changelog
> | @@ -0,0 +1,6 @@
> | +firmware-addon-dell (1.2.13-1) unstable; urgency=low
> 
> Should be 'gutsy' for an Ubuntu upload.
> 
> | ---
> | firmware-addon-dell-1.2.13.orig/debian/firmware-addon-dell.postinst
> | +++ firmware-addon-dell-1.2.13/debian/firmware-addon-dell.postinst
> | @@ -0,0 +1,5 @@
> | +#!/bin/sh
> | +
> | +set -e
> | +
> | +#DEBHELPER#
> | --- firmware-addon-dell-1.2.13.orig/debian/firmware-addon-dell.prerm
> | +++ firmware-addon-dell-1.2.13/debian/firmware-addon-dell.prerm
> | @@ -0,0 +1,6 @@
> | +#!/bin/sh
> | +
> | +set -e
> | +
> | +#DEBHELPER#
> | +
> 
> See above, these should be removed.
> 
> | --- firmware-addon-dell-1.2.13.orig/MANIFEST.in
> | +++ firmware-addon-dell-1.2.13/MANIFEST.in
> 
> Same problem as in firmware-tools.
> 
> The package also contains a lot of files which seem irrelevant for
> Ubuntu:
>   /etc/yum/
>   /etc/yum/pluginconf.d/
>   /etc/yum/pluginconf.d/dellsysidplugin.conf
>   /etc/sysconfig/
>   /etc/sysconfig/rhn/
>   /etc/sysconfig/rhn/dell-hardware.conf
>   /usr/bin/up2date_repo_autoconf
>   /usr/lib/yum-plugins/
>   /usr/lib/yum-plugins/dellsysidplugin.py
> 
> Usually, upstream install scripts should not ship distro specific files.
> 
> This looks a bit strange:
>   /etc/firmware/firmware.d/
>   /etc/firmware/firmware.d/firmware-addon-dell.conf
> 
> It might be a bit easier to just have
> /etc/firmware/firmware-addon-dell.conf? (NB that I don't know anything
> about the guts of those packages, so I might be talking nonsense).
> 
> Let me know if you have any further questions about those issues, I'll
> be glad to help you.
> 
> >  -- sponsor for firmware-tools and firmware-addon-dell for Ubuntu and 
> > Debian. Scott indicated that it would possibly be easier to get into 
> > Ubuntu to start.
> 
> I agree. Once the packages are in a releasable state (i. e. above
> concerns are addressed), I'll take care of uploading them and shoving
> them through the NEW queues. When the package has been tested a bit, I
> can sponsor it to Debian as well.
> 
> >  -- a sponsor to help guide Sadhana through the debian/ubuntu new 
> > maintainer process. Sadhana will be the maintainer for this package. I
> 
> > am the upstream maintainer.
> 
> I guess that is supposed to be 'mentor'. Yes, I can do that for Ubuntu.
> For Debian I can eventually become an advocate, but due to the different
> work style in Debian I generally expect a high degree of packaging
> experience before I do so. But don't worry, we'll get there :)
> 
> >  -- answers to any other questions that I dont know to ask right now 
> > since I am very new to debian/ubuntu.
> 
> No problem, just mail me or catch me in IRC. I am 'pitti' in
> #ubuntu-devel on Freenode.
> 
> Tomorrow is a public holiday, so I won't be online. I'll answer to any
> reply at Friday.
> 
> Greetings, and have fun with learning packaging!
> 
> Thanks,
> 
> Martin
> 
> [1] http://www.debian.org/doc/packaging-manuals/python-policy/index.html
> 
> -- 
> Martin Pitt        http://www.piware.de
> Ubuntu Developer   http://www.ubuntu.com
> Debian Developer   http://www.debian.org


More information about the firmware-tools-devel mailing list