Differences between revisions 92 and 139 (spanning 47 versions)
Revision 92 as of 2010-08-25 09:53:43
Size: 10106
Comment: Only declare non-default options in gbp.conf.
Revision 139 as of 2020-01-14 09:31:49
Size: 12765
Editor: ?umlaeute
Comment: add `gbp import-orig --uscan` as the preferred way to import a new upstream.
Deletions are marked like this. Additions are marked like this.
Line 10: Line 10:
This page thanks to great work from [[TimHall]], shamelessly re-used by dancerj, updated by [[billitch]].
Line 16: Line 14:
http://qa.debian.org/developer.php?login=debian-multimedia@lists.debian.org

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

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

All source packages shoud use the [[http://git.debian.org/git/pkg-multimedia/|pkg-multimedia git area]] in alioth.
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.
Line 26: Line 24:
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 [[http://wiki.debian.org/DebianMultimedia/Sponsoring|DebianMultimedia/Sponsoring]] for Best Practices with regard to obtaining sponsorship for your uploads if you are not a DD or DM. 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.
Line 32: Line 30:
  * 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]].
Line 33: Line 32:
  * The maintainer field should be set to {{{Debian Multimedia Maintainers <pkg-multimedia-maintainers@lists.alioth.debian.org>}}}
  * The git repository should be hosted in alioth, under the pkg-multimedia project. It should forward commit messages to {{{pkg-multimedia-commits@lists.alioth.debian.org}}} and ''package''{{{_cvs@packages.qa.debian.org}}}
   * You can use the setup-repository script in /git/pkg-multimedia to create the bare repository with commit messages enabled. The repository should be named as the source package name for the message forwarding to work (eg, the repository for source package liblo is named liblo.git).
  * 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}}}.
Line 37: Line 35:
Line 41: Line 38:
  * 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.   * 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)]].
Line 45: Line 42:
  * 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.
Line 51: Line 49:
  * [[http://wiki.debian.org/Alioth/Git | Using git on Alioth]]   * [[http://wiki.debian.org/Alioth/Git|Using git on Alioth]]
Line 55: Line 53:
== Proposing new packages for pkg-multimedia == == Proposing new packages for the Multimedia Team ==
Line 59: Line 57:
 * 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 [[ http://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), he will setup a repository on git.debian.org and integrate your package while preserving attribution.
 * 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.
Line 65: Line 63:
  * 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 ]]

 * locate the packaging branch on http://git.debian.org. All pkg-multimedia branches have pkg-multimedia in their url. Click on the leftmost link in that line. That will bring you to the summary of the project.

 * Note the metadata just above the shortlog, it contains 2 URLs, one of
   them starting with `git://`

 * then [[ http://www.kernel.org/pub/software/scm/git/docs/git-clone.html | git-clone(1) ]] to get a copy of the repository. E.g.

{{{
$ git clone git://git.debian.org/pkg-multimedia/jack-audio-connection-kit.git
 * 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
Line 84: Line 79:
 * 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) ]]:  * 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) ]]:
Line 89: Line 84:
 * 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:  * 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:
Line 105: Line 100:
 * In order to get comments on your (preferably cleaned up) commits, 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. Any committer can do this while preserving attribution.

 * None of the steps above require membership in the pkg-multimedia alioth group. All of that can be done totally anonymously!
 * 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!
Line 113: Line 108:
 * First create a repository on git.debian.org:

{{{
$ ssh git.debian.org /git/pkg-multimedia/setup-repository <project>
}}}
 * First create a repository on [[https://salsa.debian.org|Salsa]].
Line 124: Line 114:

$ git-import-dsc --pristine-tar <project>_0.0.1-1.dsc
$ gbp import-dsc --pristine-tar <project>_0.0.1-1.dsc
Line 128: Line 116:

$ git remote add alioth ssh://user@git.debian.org/git/pkg-multimedia/<project>.git

$ git push alioth master upstream pristine-tar --tags
$ 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
Line 137: Line 128:
 * Updating a git branch

{{{
 * Updating a git branch: {{{
Line 142: Line 130:
Line 144: Line 131:

}}}

 * update local branches without switching to them

{{{
}}} or by running: {{{
$ gbp pull

}}}

 * Updating local branches without switching to them: {{{
Line 152: Line 137:

$ git fetch alioth upstream:upstream pristine-tar:pristine-tar

}}}

 * merging a new upstream version

{{{

$ git-import-orig --pristine-tar /path/to/<package>_0.0.1.orig.tar.bz

}}}

 * resolve merge conflicts, review your changes e.g. with `gitk`

{{{
$ git fetch origin upstream:upstream pristine-tar:pristine-tar
}}}

 * Merging a new upstream version: {{{
$ gbp import-orig --pristine-tar --uscan
}}} or, if you `uscan` does not work for some reasons, you can also import a local tarball: {{{
$ gbp
import-orig --pristine-tar /path/to/<package>_0.0.1.orig.tar.bz
}}}

 * Resolving merge conflicts, review your changes e.g. with `git`: {{{
Line 170: Line 148:

}}}

 * pushing new revisions

{{{

$ git push alioth master upstream pristine-tar --tags --dry-run

}}}

 * if happy, remove the --dry-run parameter

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

 * 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
Line 190: Line 163:
 * Removing debian tag

{{{
 * Removing debian tag: {{{
Line 195: Line 165:

}}}

 * Adding debian tag

{{{
}}}

 * Adding debian tag: {{{
$ gbp buildpackage --git-tag-only
}}} Alternatively, it's possible to create tags by hand: {{{
Line 203: Line 171:

}}}

* -s (or -u <key>) for GPG-signed tag
 * -a for unsigned tag

{{{

$ git push alioth master

}}}

 * Replacing a previously set tag:

{{{
}}}
  * -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: {{{
Line 220: Line 181:
Line 226: Line 186:
(uncomment compression line if upstream tarball(s) are not gzip-compressed)
Line 229: Line 190:

# Enable the following lines if the upstream tarball compression type is bzip2.
#[git-buildpackage]
Line 235: Line 193:
If you adopt the dpkg source format ''3.0 (quilt)'' you should consider appending the following line to the `.gitignore` file: '''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
Line 239: Line 206:

== 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.


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 the Multimedia Team

  • 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 --uscan

    or, if you uscan does not work for some reasons, you can also import a local tarball:

    $ 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