Differences between revisions 10 and 137 (spanning 127 versions)
Revision 10 as of 2007-06-11 06:17:31
Size: 11292
Editor: Mac
Comment:
Revision 137 as of 2019-09-10 18:44:27
Size: 12621
Editor: ?SebastianRamacher
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
DebianMultimedia #format wiki
#language en
<<BR>>

||<tablestyle="float:right; font-size: 0.9em; width:40%; background:#F1F1ED; margin: 0 0 1em 1em;" style="border:0; padding:0em;"><<TableOfContents(2)>>||
||<style="border:0; padding:0.5em;"><<Navigation(siblings,1)>>||

= Develop Packaging =

= Packages maintained by the Debian Multimedia Team =

Here you can find a list of packages maintained by the Debian Multimedia Team:

https://qa.debian.org/developer.php?login=debian-multimedia@lists.debian.org

https://qa.debian.org/developer.php?login=pkg-multimedia-maintainers@lists.alioth.debian.org ([[https://lists.debian.org/debian-multimedia/2018/01/msg00000.html|deprecated]])

New packages should set the Maintainer field to {{{Debian Multimedia Maintainers <debian-multimedia@lists.debian.org>}}}. Existing packages should move to using that address on a best-effort basis.

All source packages must be hosted at [[https://salsa.debian.org/multimedia-team/|multimedia-team]] on Salsa.

= How to help with packaging =

The Debian Multimedia Maintainers need help to create new Debian packages and maintain the existing ones. If you want to contribute to this effort, but you are new to the Debian packaging systems, here follows some information to get you started. Also see [[DebianMultimedia/Sponsoring]] for Best Practices with regard to obtaining sponsorship for your uploads if you are not a DD or DM.

== Packaging guidelines ==
  * Packages should use git, as mentioned above. Desirable is being able to use DebianPkg:git-buildpackage.
  * Upstream sources should be kept in the ''upstream'' branch and the the debian packaging in the ''master'' branch.
  * DebianPkg:quilt should be used for patch management, and the ''master'' branch should only differ from the ''upstream'' branch in files inside the debian/ directory. This means no direct changes to the source in the master branch.
  * In order to keep patches uniform, maintainers should configure DebianPkg:quilt by means of a {{{~/.quiltrc}}} file in accordance with the [[http://www.debian.org/doc/manuals/maint-guide/modify.en.html#quiltrc|Debian New Maintainers' Guide]]. Torsten Glaser suggested a more sophisticated {{{~/.quiltrc}}} file resulting from the team's discussion, the Perl and Maintainer’s Guide suggestions in ''clean'' POSIX shell on the [[http://lists.alioth.debian.org/pipermail/pkg-multimedia-maintainers/2012-June/027969.html|pkg-multimedia-maintainers list]].
  * Patches should have a [[http://dep.debian.net/deps/dep3/|DEP-3]] compliant header, and should be submitted upstream (if relevant) before uploading to Debian.
  * The maintainer field should be set to {{{Debian Multimedia Maintainers <debian-multimedia@lists.debian.org>}}}
  * The git repository should be hosted on salsa, under the multimedia-team project. It should forward commit messages to {{{dispatch+}}}''package''{{{_vcs@tracker.debian.org}}}.
  * The control file should use the Vcs-Git and Vcs-Browser tags.

== Workflow guidelines ==
  * '''One change per commit'''. This is very important, it eases review, cherry picking, bisecting (and thus debugging) and backporting.
  * Do not commit `debian/changelog` along with the changes. This practice makes cherry picking and backporting changes unnecessarily hard. The changelog is generated with [[DebianMan:1/git-dch|git-dch(1)]] at the time of upload. Also, packages should use the changelog release heuristic of [[DebianMan:1/dch|dch(1)]].
  * The commit message should have a short (<78 characters) summary of the change followed by a newline. After that, you can elaborate on the change. The summary is treated specially by various tools like [[DebianMan:1/git-dch|git-dch(1)]], or the commitdiff mailer.
  * After each upload to the Debian FTP servers, the first commit should be creating a new changelog entry, to ease testing of unreleased packages.
  * Tags should be created (and signed) by the uploading DD, in the case of the debian tags in the master branch, and by the person importing the upstream sources in the case of upstream tags.
  * To indicate that the package is ready for upload, update debian/changelog to include the target distribution (i.e. 'unstable' or 'experimental'). Otherwise just leave 'UNRELEASED'. If you want a review or help, just ask on this mailing list.

== Documentation ==

  * [[http://www.debian.org/doc/devel-manuals#maint-guide|Debian New Maintainers' Guide]]
  * [[http://www.debian.org/doc/devel-manuals#devref|Debian Developer's Reference]]
  * [[http://www.debian.org/doc/devel-manuals#policy|Debian Policy Manual]]
  * [[http://wiki.debian.org/Alioth/Git|Using git on Alioth]]
  * [[http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.html | git-buildpackage online documentation]] (offline: /usr/share/doc/git-buildpackage/manual-html)
  * [[http://www.netfort.gr.jp/~dancer/column/libpkg-guide/libpkg-guide.html|Debian Library Packaging guide]]

== Proposing new packages for pkg-multimedia ==

 * Don't bother with git for packaging new software. Instead, package it properly following DebianPolicy and the [[ http://www.debian.org/doc/developers-reference/ | DevelopersReference ]].

 * If you are confident with your package, propose it for review on the pkg-multimedia-maintainers mailing list. Link to your package preferably in a way that can be easily used with [[dget]]. The [[https://mentors.debian.net|Debian Mentors]] site is a good place.

 * Members of the team will then review your package and give you hints how to improve it. If the package is "good enough" (at the reviewer's discretion), they will setup a repository on git.debian.org and integrate your package while preserving attribution.

== Working on existing packages with git for newbies ==

 * As a very basic introduction, first read [[PackagingWithGit]].

 * We generally follow the workflow and defaults of [[ http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.html | git-buildpackage ]]. Besides `gbp-import-orig(1)`, the use of `git-buildpackage` is up to you. Using `git` works as well.

 * Locate the packaging branch on https://salsa.debian.org/multimedia-team.

 * Use [[ http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.man.gbp.clone.html | gbp-clone(1) ]] to get a copy of the repository. E.g.

{{{
$ gbp clone --pristine-tar git@salsa.debian.org:multimedia-team/jack-audio-connection-kit.git
}}}

 * Do changes to that branch, build the package, test your changes, and commit early and often!

 * If someone else has committed while you are working on the branch, you need to integrate his changes. For this you have 2 options:

 * If your local changes are rather minor and clean, rebase when using [[ http://www.kernel.org/pub/software/scm/git/docs/git-pull.html | git-pull(1) ]]:
{{{
$ git pull --rebase origin
}}}

 * If you rather don't want to break your history because you think that your changes are rather large and are likely to interfere with the other changes, better merge them with:

{{{
$ git pull origin
}}}

 * In case you want to cleanup your local commits before pushing, use [[ http://www.kernel.org/pub/software/scm/git/docs/git-rebase.html | git-rebase(1) ]]:

{{{
$ git rebase -i origin/master
}}}

   You will be presented a textfile where you can specify what of your local commits you want to modify, drop or squish (merge with the previous one). You can also improve your commit message here.

   Make sure that you don't rewrite already published commits.

 * In order to get comments on your (preferably cleaned up) commits, use use merge requests on [[https://salsa.debian.org|salsa]] or use [[ http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html | git-format-patch(1) ]] to generate patches of your commits and email them to the mailing list.

 * None of the steps above require membership in the multimedia-team group. All of that can be done totally anonymously!

= Common tasks for team members =

== Uploading proposed package to the team git repository ==

 * First create a repository on [[https://salsa.debian.org|Salsa]].

 * Then import the sources locally, register the remote archive and push your commits (i.e. upload changes) with the following commands:

{{{
$ cd /path/to/sources/
$ gbp import-dsc --pristine-tar <project>_0.0.1-1.dsc
$ cd <project>
$ git remote add origin git@salsa.debian.org:multimedia-team/<project>.git
$ git push origin master upstream pristine-tar --follow-tags
}}}

 * If the package hasn't been uploaded yet, then debian tag should be deleted: (thus debian tag can be created on upload)

{{{
$ git tag -d debian/0.0.1-1
}}}

== Uploading new upstream version to existing repository ==

 * Updating a git branch: {{{
$ git checkout master
$ git pull
}}} or by running: {{{
$ gbp pull
}}}

 * Updating local branches without switching to them: {{{
$ git remote update
$ git fetch origin upstream:upstream pristine-tar:pristine-tar
}}}

 * Merging a new upstream version: {{{
$ gbp import-orig --pristine-tar /path/to/<package>_0.0.1.orig.tar.bz
}}}

 * Resolving merge conflicts, review your changes e.g. with `git`: {{{
$ git commit
}}}

 * Pushing new revisions: {{{
$ git push origin master upstream pristine-tar --follow-tags --dry-run
}}} If you are happy, remove the --dry-run parameter. Alternatively: {{{
$ gbp push
}}}

 * '''Assumptions in all cases'''
 * in the source tree
 * the remote 'origin' is setup properly


== Removing/Adding debian tags to repository ==

 * Removing debian tag: {{{
$ git tag -d debian/0.0.1-1
}}}

 * Adding debian tag: {{{
$ gbp buildpackage --git-tag-only
}}} Alternatively, it's possible to create tags by hand: {{{
$ git tag [-a|-s] "debian/0.0.1-1" -m "Debian release 0.0.1-1"
}}}
  * -s (or -u <key>) for GPG-signed tag
  * -a for unsigned tag

 * Pushing tags: {{{
$ git push origin master --follow-tags
}}}

 * Replacing a previously set tag: {{{
$ git tag -f [-a|-s] "debian/1.2.3-1" -m "Debian release 1.2.3-1"
}}}

== Common configuration options ==

These parameters should be placed in the `debian/gbp.conf` file.
(uncomment compression line if upstream tarball(s) are not gzip-compressed)
{{{
[DEFAULT]
pristine-tar = True
#compression = bzip2
}}}

'''If you adopt the dpkg source format ''3.0 (quilt)'' you should:'''

* Add this to debian/source/format file

{{{
3.0 (quilt)
}}}

* Add this to .gitignore file

{{{
.pc
}}}

== Bugs for packages found in DMO ==

If there is a bug that is not found in the Debian version of a package but found only in the DMO version of the package, it is helpful to mark such bugs with a usertag. The procedure we take to mark such bugs is as follows.

Send an email to close the bug (NNNNN-done@bugs.debian.org) and also to the BTS bug control interface (control@bugs.debian.org). Closing the bug will automatically notify the submitter of the bug as well. The contents of the email must begin with the following lines.

{{{
user debian-multimedia@lists.debian.org
usertags NNNNNN dmo
tags NNNNNN = unreproducible
notfound NNNNNN <version1>
notfound NNNNNN <version2>
...
notfixed NNNNNN <version1>
notfixed NNNNNN <version2>
...
stop
}}}

These lines are read by the BTS bug control interface. The 'user' line must be set to 'debian-multimedia@lists.debian.org' so that the usertag can be set. The 'usertags' marks the bug with the usertag 'dmo'. The 'tags' line will reset all tags on the bug so that it will only contain one tag, the 'unreproducible' tag. The 'notfound' lines removes all instances where the BTS says the bug is found. These lines need to be added for each version the BTS says the bug is found against. In case the BTS says there are versions of the package the bug is fixed, the 'notfixed' lines must also be added just like the 'notfound' lines to unmark all versions where the BTS says the bug is fixed. Finally, the 'stop' line stops processing for the BTS control interface.

After the 'stop' line, write a message explaining that this bug does not exist against the version of the package in Debian and is being close and marked as such. It's also helpful to recommend users to report the bug to dmo.

All such marked bugs can be viewed at http://bugs.debian.org/cgi-bin/pkgreport.cgi?tag=dmo;users=debian-multimedia@lists.debian.org.
Line 3: Line 231:
{{{ This page is outdated and contains
information already on other pages.
Help is welcome to remove the duplicate parts,
and to update or remove the obsolete parts.
No need to ask before editing. }}}

This page thanks to great work from tim hall, shamelessly re-used by dancerj

= Packages maintained by the Debian Multimedia Team =

Here you can find a list of packages maintained by the Debian Multimedia Team:

http://qa.debian.org/developer.php?login=debian-multimedia@lists.debian.org

All source packages are kept in the [http://svn.debian.org/wsvn/demudi demudi SVN project]

= How to help with packaging =

The A/!DeMuDi project needs help to create new Debian packages and maintain the existing ones. If you want to contribute to this effort, but you are new to the Debian packaging systems, here follows some information to get you started.

== Documentation ==

  * [http://www.debian.org/doc/devel-manuals#maint-guide Debian New Maintainers' Guide]
  * [http://www.debian.org/doc/devel-manuals#devref Debian Developer's Reference]
  * [http://www.debian.org/doc/devel-manuals#policy Debian Policy Manual]
 
== Lists of packages and applications ==
 
  * [http://www.debian.org/devel/wnpp/ Work-Needing and Prospective Packages]

Key to status column

  * '''O''' - The package has been ‘Orphaned’. It needs a new maintainer as soon as possible. If the package has a Priority higher or equal to standard, the severity should be set to important.
  * '''RFA''' - This is a ‘Request for Adoption’. Due to lack of time, resources, interest or something similar, the current maintainer is asking for someone else to maintain this package. They will maintain it in the meantime, but perhaps not in the best possible way. In short: the package needs a new maintainer.
  * '''RFH''' - This is a ‘Request For Help’. The current maintainer wants to continue to maintain this package, but they need some help to do this, because their time is limited or the package is quite big and needs several maintainers.
  * '''ITP''' - This is an ‘Intent To Package’. Please submit a package description along with copyright and URL in such a report.
  * '''RFP''' - This is a ‘Request For Package’. Someone has found an interesting piece of software and would like someone else to maintain it for Debian. Please submit a package description along with copyright and URL in such a report.
  * '''not in WNPP''' - That's because you haven't submitted an RFP for it yet (see above).

You can click on the links in this column to bring up the full bug reports.

== Audio and multimedia applications which need help ==

'''The table below could be better managed through BTS's user tags. This would allow syncing this info with the current one in BTS without duplicated work.'''


|| '''Package''' || '''Status''' || '''Upstream''' || '''Comment''' ||
|| alsa-firmware || [http://bugs.debian.org/276798 RFP:] || Wishlist || part of ALSA and needed for several cards ||
|| banshee (sonance) || [http://bugs.debian.org/296467 ITP] || [http://sonance.aaronbock.net/ http://sonance.aaronbock.net/] || GNOME audio player based on GStreamer and Mono ||
|| [http://bugs.debian.org/cantus cantus] || [http://bugs.debian.org/287985 O] || [http://cvs.gna.org/cvsweb/?cvsroot=cantus http://cvs.gna.org/cvsweb/?cvsroot=cantus] || Gnome tool to mass-rename/tag mp3 and ogg files - Has a couple of minor bugs that probably wouldn't be hard to fix. Orphaned 2004-12-31. ||
|| didgeridoo || not in WNPP || [http://www.linux-sound.org/rtsynth/ http://www.linux-sound.org/rtsynth/] || voice controlled resonance instrument for the jack-audio-connection-kit ||
|| dirac || not in WNPP || [http://dirac.sf.net/ http://dirac.sf.net/] || video codec that provides general-purpose video compression and decompression tools comparable with state-of-the-art systems ||
|| dssi || [http://bugs.debian.org/280165 ITP:] ||http://www.student.nada.kth.se/~d00-llu/music_dssi.php || See all the other dssi0.9 ITPs. ||
|| dssi0.9-plugin-fluidsynth || [http://bugs.debian.org/321465 ITP:] || || DSSI wrapper for the !FluidSynth SoundFont-playing software synthesizer. ||
|| dssi0.9-plugin-hexter || [http://bugs.debian.org/321469 ITP:] || || Yamaha DX7 modeling DSSI plugin. ||
|| dssi0.9-plugin-ll-scope || [http://bugs.debian.org/321468 ITP:] || || An oscilloscope DSSI plugin. ||
|| dssi0.9-plugin-sineshaper || [http://bugs.debian.org/321488 ITP:] || || Monophonic synth plugin with two oscillators and waveshapers. ||
|| dssi0.9-plugin-vst || [http://bugs.debian.org/321463 ITP:] || || Wrapper plugin for Windows VSTs to function as DSSI plugin. ||
|| dssi0.9-plugin-xsynth || [http://bugs.debian.org/321464 ITP:] || || classic-analog (VCOs-VCF-VCA) style software synthesizer. ||
|| [http://bugs.debian.org/em8300 em8300] || [http://bugs.debian.org/346583 RFA:] || || Drivers for DXR3/Hollywood+ decoder cards - Debian maintainer has become upstream too & needs help. ||
|| [http://bugs.debian.org/freebirth freebirth] || [http://bugs.debian.org/302897 ITA] || Dead upstream page || Bass synthesizer/sample player/sequencer similar to Rebirth ||
|| freecycle || [http://bugs.debian.org/303307 ITP:] || || a beat slicer ||
|| freewheeling || [http://bugs.debian.org/291493 ITP] || [http://freewheeling.sf.net/ http://freewheeling.sf.net/] || live looping musical instrument ||
|| [http://bugs.debian.org/freqtweak freqtweak] || [http://bugs.debian.org/352540 O:] || || Realtime audio frequency spectral manipulation ||
|| [http://bugs.debian.org/gcombust gcombust] || [http://bugs.debian.org/288267 O:] || || GTK+ based CD mastering and burning program ||
|| gmorgan || [http://bugs.debian.org/338691 ITP:] || || MIDI rhythm station emulator software ||
|| gplflash || not in WNPP || [http://gplflash.sourceforge.net/ http://gplflash.sourceforge.net/] || a fully Flash 7-compliant replacement for the restrictively licensed [:FlashPlayer:Adobe/Macromedia Flash Player and browser plugin] ||
|| [http://bugs.debian.org/icecast-client icecast-client] || [http://bugs.debian.org/279526 O:] || || Streaming Mpeg Layer III feeder - deprecated & to be removed. ||
|| [http://bugs.debian.org/kino kino] || [http://bugs.debian.org/298106 RFA] || [http://kino.schirmacher.de/ http://kino.schirmacher.de/] || Non-linear editor for Digital Video data ||
|| ktoon || [http://bugs.debian.org/295760 ITP:] || http://ktoon.toonka.com/ || 2d animation toolkit - being held up by libming licensing issues, help? ||
|| latencytest || not in WNPP || [http://www.alsa-project.org/~iwai/alsa.html#LatencyTest http://www.alsa-project.org/~iwai/alsa.html#LatencyTest] || Tool to measure kernel latency ||
|| lives || [http://bugs.debian.org/247337 ITP] || [http://www.xs4all.nl/~salsaman/lives/ http://www.xs4all.nl/~salsaman/lives/] || LiVES is the Linux Video Editing System ||
|| [http://bugs.debian.org/mctools-lite mctools-lite] || [http://bugs.debian.org/352538 O:] || || A CD player and audio mixer for X ||
|| midicomp || not in WNPP || [http://midicomp.opensrc.org/ http://midicomp.opensrc.org/] || utility to "compile" and "decompile" midi files from/to text files ||
|| [http://bugs.debian.org/music123 music123] || [http://bugs.debian.org/285163 O:] || || A command-line shell for sound-file players ||
|| [http://bugs.debian.org/nas nas] || [http://bugs.debian.org/354174 RFH:] || || The Network Audio System ||
|| om || not in WNPP || [http://www.nongnu.org/om-synth/ http://www.nongnu.org/om-synth/] || modular synthesizer for GNU/Linux audio systems using the Jack audio server and LADSPA or DSSI plugins ||
|| pvoc || [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=282644 RFP] || [http://quitte.de/dsp/pvoc.html http://quitte.de/dsp/pvoc.html] || LADSPA plugins and command line utilities for time stretching/pitch shifting ||
|| qsampler || [http://bugs.debian.org/280576 ITP:] || http://qsampler.sourceforge.net/qsampler-index.html#Downloads || A !LinuxSampler Qt GUI Interface ||
|| [http://bugs.debian.org/rawrec rawrec] || [http://bugs.debian.org/288215 O:] || || Buffered raw audio recorder/player - looks dead. ||
|| rivendell || not in WNPP || [http://www.salemradiolabs.com/rivendell/ http://www.salemradiolabs.com/rivendell/] || complete radio broadcast automation solution ||
|| [http://bugs.debian.org/rosegarden2 rosegarden2] || [http://bugs.debian.org/352537 O:] || || An integrated MIDI sequencer and musical notation editor - no longer in development, to be removed? ||
|| [http://bugs.debian.org/rosegarden4 rosegarden4] || [http://bugs.debian.org/352541 ITA:] || || music editor and MIDI/audio sequencer - being adopted. ||
|| [http://bugs.debian.org/rosegarden rosegarden] || [http://bugs.debian.org/352543 O:] || || An integrated MIDI sequencer and musical notation editor, will be adapted to rosegarden4 ||
|| rtirq || [http://bugs.debian.org/307786 ITP:] || || Startup script for realtime-preempt enabled kernels ||
|| rtsynth || not in WNPP || [http://www.linux-sound.org/rtsynth/ http://www.linux-sound.org/rtsynth/] || a midi event triggered real time synth for Linux ||
|| [http://bugs.debian.org/sfront sfront] || [http://bugs.debian.org/352542 O:] || || MPEG 4 Structured Audio decoder ||
|| [http://bugs.debian.org/slimp3 slimp3] || [http://bugs.debian.org/303617 ITA:] || || MPEG Layer III Streaming Server ||
|| [http://bugs.debian.org/soundgrab soundgrab] || [http://bugs.debian.org/288216 O:] || || play a raw audio file and interactively select and save pieces - looks dead. ||
|| [http://bugs.debian.org/sound-recorder sound-recorder] || [http://bugs.debian.org/288211 O:] || || Direct-to-disk recording and play-back programs. - looks dead. ||
|| [http://bugs.debian.org/tapiir tapiir] || [http://bugs.debian.org/352539 O:] || || A tool for real time audio delay and feedback effects ||
|| [http://bugs.debian.org/volume.app volume.app] || [http://bugs.debian.org/274281 ITA:][http://bugs.debian.org/304826 merged with 304826] || || A dockapp enabling easy control of the volume level - looks like it's been adopted. ||
|| [http://bugs.debian.org/vstream vstream] || [http://bugs.debian.org/349197 O:] || || bttv video capture utility aimed at making MPEGs - no longer developed upstream. ||
|| wasp || not in WNPP || [http://artemiolabs.com/software/wasp/ http://artemiolabs.com/software/wasp/] || LADSPA plugins ||
|| wavbreaker || [http://bugs.debian.org/282456 ITP:] || http://huli.org/wavbreaker || Takes a wave file and break it up into multiple wave files ||
|| [http://bugs.debian.org/xfonts-artwiz xfonts-artwiz] || [http://bugs.debian.org/344396 O:] || || Artwiz X11 fonts - no longer work with Xorg ||
|| yatm || not in WNPP || [http://delysid.org/yatm.html http://delysid.org/yatm.html] || Ogg and mp3 player with time stretching capabilities ||
|| [http://bugs.debian.org/zinf zinf] || [http://bugs.debian.org/328956 RFA:] || || Extensible, cross-platform audio player - Upstream may be dead? ||
|| opledit || not in WNPP || [http://repetae.net/john/computer/opledit/] || OPL2 and OPL3 patch editor ||
Work in progress : We're checking all the WNPP bugs and updating infos on this page.
 -- [[billitch]]


1. Develop Packaging

2. Packages maintained by the Debian Multimedia Team

Here you can find a list of packages maintained by the Debian Multimedia Team:

https://qa.debian.org/developer.php?login=debian-multimedia@lists.debian.org

https://qa.debian.org/developer.php?login=pkg-multimedia-maintainers@lists.alioth.debian.org (deprecated)

New packages should set the Maintainer field to Debian Multimedia Maintainers <debian-multimedia@lists.debian.org>. Existing packages should move to using that address on a best-effort basis.

All source packages must be hosted at multimedia-team on Salsa.

3. How to help with packaging

The Debian Multimedia Maintainers need help to create new Debian packages and maintain the existing ones. If you want to contribute to this effort, but you are new to the Debian packaging systems, here follows some information to get you started. Also see DebianMultimedia/Sponsoring for Best Practices with regard to obtaining sponsorship for your uploads if you are not a DD or DM.

3.1. Packaging guidelines

  • Packages should use git, as mentioned above. Desirable is being able to use git-buildpackage.

  • Upstream sources should be kept in the upstream branch and the the debian packaging in the master branch.

  • quilt should be used for patch management, and the master branch should only differ from the upstream branch in files inside the debian/ directory. This means no direct changes to the source in the master branch.

  • In order to keep patches uniform, maintainers should configure quilt by means of a ~/.quiltrc file in accordance with the Debian New Maintainers' Guide. Torsten Glaser suggested a more sophisticated ~/.quiltrc file resulting from the team's discussion, the Perl and Maintainer’s Guide suggestions in clean POSIX shell on the pkg-multimedia-maintainers list.

  • Patches should have a DEP-3 compliant header, and should be submitted upstream (if relevant) before uploading to Debian.

  • The maintainer field should be set to Debian Multimedia Maintainers <debian-multimedia@lists.debian.org>

  • The git repository should be hosted on salsa, under the multimedia-team project. It should forward commit messages to dispatch+package_vcs@tracker.debian.org.

  • The control file should use the Vcs-Git and Vcs-Browser tags.

3.2. Workflow guidelines

  • One change per commit. This is very important, it eases review, cherry picking, bisecting (and thus debugging) and backporting.

  • Do not commit debian/changelog along with the changes. This practice makes cherry picking and backporting changes unnecessarily hard. The changelog is generated with git-dch(1) at the time of upload. Also, packages should use the changelog release heuristic of dch(1).

  • The commit message should have a short (<78 characters) summary of the change followed by a newline. After that, you can elaborate on the change. The summary is treated specially by various tools like git-dch(1), or the commitdiff mailer.

  • After each upload to the Debian FTP servers, the first commit should be creating a new changelog entry, to ease testing of unreleased packages.
  • Tags should be created (and signed) by the uploading DD, in the case of the debian tags in the master branch, and by the person importing the upstream sources in the case of upstream tags.
  • To indicate that the package is ready for upload, update debian/changelog to include the target distribution (i.e. 'unstable' or 'experimental'). Otherwise just leave 'UNRELEASED'. If you want a review or help, just ask on this mailing list.

3.3. Documentation

3.4. Proposing new packages for pkg-multimedia

  • Don't bother with git for packaging new software. Instead, package it properly following DebianPolicy and the DevelopersReference.

  • If you are confident with your package, propose it for review on the pkg-multimedia-maintainers mailing list. Link to your package preferably in a way that can be easily used with ?dget. The Debian Mentors site is a good place.

  • Members of the team will then review your package and give you hints how to improve it. If the package is "good enough" (at the reviewer's discretion), they will setup a repository on git.debian.org and integrate your package while preserving attribution.

3.5. Working on existing packages with git for newbies

$ gbp clone --pristine-tar git@salsa.debian.org:multimedia-team/jack-audio-connection-kit.git
  • Do changes to that branch, build the package, test your changes, and commit early and often!
  • If someone else has committed while you are working on the branch, you need to integrate his changes. For this you have 2 options:
  • If your local changes are rather minor and clean, rebase when using git-pull(1):

$ git pull --rebase origin
  • If you rather don't want to break your history because you think that your changes are rather large and are likely to interfere with the other changes, better merge them with:

$ git pull origin
  • In case you want to cleanup your local commits before pushing, use git-rebase(1):

$ git rebase -i origin/master
  • You will be presented a textfile where you can specify what of your local commits you want to modify, drop or squish (merge with the previous one). You can also improve your commit message here. Make sure that you don't rewrite already published commits.
  • In order to get comments on your (preferably cleaned up) commits, use use merge requests on salsa or use git-format-patch(1) to generate patches of your commits and email them to the mailing list.

  • None of the steps above require membership in the multimedia-team group. All of that can be done totally anonymously!

4. Common tasks for team members

4.1. Uploading proposed package to the team git repository

  • First create a repository on Salsa.

  • Then import the sources locally, register the remote archive and push your commits (i.e. upload changes) with the following commands:

$ cd /path/to/sources/
$ gbp import-dsc --pristine-tar <project>_0.0.1-1.dsc
$ cd <project>
$ git remote add origin git@salsa.debian.org:multimedia-team/<project>.git
$ git push origin master upstream pristine-tar --follow-tags
  • If the package hasn't been uploaded yet, then debian tag should be deleted: (thus debian tag can be created on upload)

$ git tag -d debian/0.0.1-1

4.2. Uploading new upstream version to existing repository

  • Updating a git branch:

    $ git checkout master
    $ git pull

    or by running:

    $ gbp pull
  • Updating local branches without switching to them:

    $ git remote update
    $ git fetch origin upstream:upstream pristine-tar:pristine-tar
  • Merging a new upstream version:

    $ gbp import-orig --pristine-tar /path/to/<package>_0.0.1.orig.tar.bz
  • Resolving merge conflicts, review your changes e.g. with git:

    $ git commit
  • Pushing new revisions:

    $ git push origin master upstream pristine-tar --follow-tags --dry-run

    If you are happy, remove the --dry-run parameter. Alternatively:

    $ gbp push
  • Assumptions in all cases

  • in the source tree
  • the remote 'origin' is setup properly

4.3. Removing/Adding debian tags to repository

  • Removing debian tag:

    $ git tag -d debian/0.0.1-1
  • Adding debian tag:

    $ gbp buildpackage --git-tag-only

    Alternatively, it's possible to create tags by hand:

    $ git tag [-a|-s] "debian/0.0.1-1" -m "Debian release 0.0.1-1"
    • -s (or -u <key>) for GPG-signed tag

    • -a for unsigned tag
  • Pushing tags:

    $ git push origin master --follow-tags
  • Replacing a previously set tag:

    $ git tag -f [-a|-s] "debian/1.2.3-1" -m "Debian release 1.2.3-1"

4.4. Common configuration options

These parameters should be placed in the debian/gbp.conf file. (uncomment compression line if upstream tarball(s) are not gzip-compressed)

[DEFAULT]
pristine-tar = True
#compression = bzip2

If you adopt the dpkg source format 3.0 (quilt) you should:

* Add this to debian/source/format file

3.0 (quilt)

* Add this to .gitignore file

.pc

4.5. Bugs for packages found in DMO

If there is a bug that is not found in the Debian version of a package but found only in the DMO version of the package, it is helpful to mark such bugs with a usertag. The procedure we take to mark such bugs is as follows.

Send an email to close the bug (NNNNN-done@bugs.debian.org) and also to the BTS bug control interface (control@bugs.debian.org). Closing the bug will automatically notify the submitter of the bug as well. The contents of the email must begin with the following lines.

user debian-multimedia@lists.debian.org
usertags NNNNNN dmo
tags NNNNNN = unreproducible
notfound NNNNNN <version1>
notfound NNNNNN <version2>
...
notfixed NNNNNN <version1>
notfixed NNNNNN <version2>
...
stop

These lines are read by the BTS bug control interface. The 'user' line must be set to 'debian-multimedia@lists.debian.org' so that the usertag can be set. The 'usertags' marks the bug with the usertag 'dmo'. The 'tags' line will reset all tags on the bug so that it will only contain one tag, the 'unreproducible' tag. The 'notfound' lines removes all instances where the BTS says the bug is found. These lines need to be added for each version the BTS says the bug is found against. In case the BTS says there are versions of the package the bug is fixed, the 'notfixed' lines must also be added just like the 'notfound' lines to unmark all versions where the BTS says the bug is fixed. Finally, the 'stop' line stops processing for the BTS control interface.

After the 'stop' line, write a message explaining that this bug does not exist against the version of the package in Debian and is being close and marked as such. It's also helpful to recommend users to report the bug to dmo.

All such marked bugs can be viewed at http://bugs.debian.org/cgi-bin/pkgreport.cgi?tag=dmo;users=debian-multimedia@lists.debian.org.


Work in progress : We're checking all the WNPP bugs and updating infos on this page.


CategorySound