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

Bug#617854: Packaging puddletag for Debian



Hi concentricpuddle,

2011/4/5 concentricpuddle <concentricpuddle@gmail.com>:
> Hope you guys don't mind. I've mixed the emails up a bit.

no problem at all

>>- can you ship the documentation along with the source tarball?
>
> I'll be doing this from the next major release onwards. I'm currently
> in the process of converting the documentation to use Sphinx for this
> exact reason.

that's awesome!

>> If you are not familiar with the
>> creation of a manpage, we can surely point you to some very easy to
>> use documentation/light markup systems that are almost as easy to use
>> as pure plain text.
>
> Please do.

I'm attaching to some manpages template (as shipped by dh-make, a tool
that helps convert a source tarball into a debian package). Also, if
you'll provide a -h/--help cli option, then you can use 'help2man'
that generates a preliminary manpage starting from the output of
--help.

>> - I saw you're providing a deb pkg: are you interested in maintain
>> puddletag in Debian with Rogério and me?
>
> If you saw the code I use to create the deb, I'm sure you'd be wtf'ng
> way into next week. ;)

ehheh It seems you've started with something generated by stdeb, is
that correct? at least, it's a start :)

> What would maintaining the package with you entail? I have no idea
> what goes on behind the scenes at distro, so please consider me an
> idiot when you explain.

a very high-level description is: we take the upstream source tarball,
we write a bunch of files that wrap that source code up, and create a
package (both source and binary (what you install)). Starting from
here and going deeper, you'll see there's a lot of "packaging"
specific knowledge you have to master in order to correctly build the
package (debian/rules file) or setup basic information and
relationship with other pkgs (debian/control) and also the boring
legal stuff (debian/copyright, with all the copyright holders and
license of use), and more and more :)

If you want to learn how to package for debian, that might be a nice
chance to do it; else you can delegate to us (packages) the package
creation - and it would be perfectly fine (we almost always work this
way). I asked since you already provided some .deb pkgs.

>> - in the 'copyright' you mix GPL-2 with references to GPL-3 (Debian
>> file and gnu.org url) and in the README file you state it's GPL-2:
>> it's better if you clarify it (I can understand it's GPL-2, but
>> explicit is better than implicit :).
>
> GPL-3. Blame my lack of an eye for detail for missing that. ;)

great! please update every location where GPL-2 is used to refer to
GPL-3 (also not that you can choose GPL-3 or "GPL-3 or newer version
at you discretion" - choose the one that you like the most, either is
ok).

>> As soon as you can clarify this, you can grab our "distilled"
>> copyright file and use that for your future tarballs.
>
> Where would I be able to find this?

we have a SVN repository[1] where you can look at the packaging and so
also at the copyright file[2]

[1] http://svn.debian.org/wsvn/python-apps/packages/puddletag/trunk/
[2] http://svn.debian.org/wsvn/python-apps/packages/puddletag/trunk/debian/copyright

>> - you mention that puddletag uses code from Picard and CDDB-py, and
>> icons from Oxygen project: can you be a bit more specific what files
>> uses those pieces of source code and the image?
>
> Images are available via svn. They're 'compiled' in the source
> tarball...

what do you mean by compiled?

> Now that I think about it, I should probably include them.

that would help quite a lot :)

> I've renamed them though. Do you guys want them listed against what
> they originally were?

no need, we just need to know the current file name and where they were taken.

> puddlestuff/tagsources/CDDB.py is taken from CDDB.py (the project)
> puddlestuff/audioinfo/compatid.py is taken from Picard
> puddlestuff/audioinfo/wma.py is a derivative work from Picard's wma.py module.
> The image handling code in puddlestuff/audioinfo/vorbis.py is kind of
> from Picard (looked at the code to get an idea of how to do it).

awesome, I'm going to update the package copyright file

>> - the package misses a manpage; puddletag seems to have some
>> command-line options, well hidden into the code not even a -h/--help
>> switch would show them :) I can probably give a look to it, but if you
>> want to do it....
>
> I'll do it. Each option has one or two caveats that I have to sort
> out, before I can make them public.

Great! I would like also to suggest to use a proper tool to parse cli
options: optparse, or argparse that will be the preferred module from
2.7 and 3.x.

Cheers,
-- 
Sandro Tosi (aka morph, morpheus, matrixhasu)
My website: http://matrixhasu.altervista.org/
Me at Debian: http://wiki.debian.org/SandroTosi

Attachment: manpage.1.ex
Description: Binary data

Attachment: manpage.sgml.ex
Description: Binary data

Attachment: manpage.xml.ex
Description: Binary data


Reply to: