X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=dgit.git;a=blobdiff_plain;f=dgit-maint-merge.7.pod;h=0d8b2daa9a37b3813bef116d67a8626f4c22e750;hp=71f701e196a2196db084db9c106587b269a424a3;hb=a4e7ac2715ea7077ccedb190a783c64c06a9c539;hpb=7d4857e62a0fc915143aeb943567476c13dfd0df diff --git a/dgit-maint-merge.7.pod b/dgit-maint-merge.7.pod index 71f701e1..0d8b2daa 100644 --- a/dgit-maint-merge.7.pod +++ b/dgit-maint-merge.7.pod @@ -16,8 +16,6 @@ Git histories should be the non-linear histories produced by git-merge(1), preserving all information about divergent development that was later brought together. -If you prefer linear histories, see dgit-maint-rebase(7). - =item Maintaining convenient and powerful git workflows takes priority over @@ -36,31 +34,11 @@ that upstream makes available for download. =back -=head1 GIT CONFIGURATION - -Add the following to your ~/.gitconfig to teach git-archive(1) how to -compress orig tarballs: - -=over 4 - - [tar "tar.xz"] - command = xz -c - [tar "tar.gz"] - command = gzip -c - -=back - =head1 INITIAL DEBIANISATION -=head2 When upstream tags releases in git and releases identical tarballs - -Ideally upstream would make git tags, and tarball releases, which are -completely identical to each other. If this is the case then you can -use the upstream tarballs directly. - -If you're not sure, use the procedure below under "When upstream -releases only tarballs" only with a different upstream tag name. Then -use git diff to check that there are no differences. +This section explains how to start using this workflow with a new +package. It should be skipped when converting an existing package to +this workflow. =head2 When upstream tags releases in git @@ -102,20 +80,36 @@ unless you also happen to be involved in upstream development. We work with upstream tags rather than any branches, except when forwarding patches (see FORWARDING PATCHES UPSTREAM, below). -Finally, you need an orig tarball. Generate one with git-archive(1): +Finally, you need an orig tarball: =over 4 - % git archive -o ../foo_1.2.2.orig.tar.xz 1.2.2 + % git deborig =back -If you are using the version 1.0 source package format, replace 'xz' -with 'gz'. +See git-deborig(1) if this fails. This tarball is ephemeral and easily regenerated, so we don't commit it anywhere (e.g. with tools like pristine-tar(1)). +=head3 Verifying upstream's tarball releases + +=over 4 + +It can be a good idea to compare upstream's released tarballs with the +release tags, at least for the first upload of the package. If they +are different, you might need to add some additional steps to your +I, such as running autotools. + +A convenient way to perform this check is to import the tarball as +described in the following section, using a different value for +'upstream-tag', and then use git-diff(1) to compare the imported +tarball to the release tag. If they are the same, you can use +upstream's tarball instead of running git-deborig(1). + +=back + =head2 When upstream releases only tarballs We need a virtual upstream branch with virtual release tags. @@ -167,6 +161,50 @@ branches: =back +=head1 CONVERTING AN EXISTING PACKAGE + +This section explains how to convert an existing Debian package to +this workflow. It should be skipped when debianising a new package. + +=head2 No existing git history + +=over 4 + + % dgit clone foo + % cd foo + % git remote add -f upstream https://some.upstream/foo.git + +=back + +=head2 Existing git history using another workflow + +First, dump any existing patch queue: + +=over 4 + + % git rm -rf debian/patches + % git commit -m "drop existing quilt patch queue" + +=back + +Then make new upstream tags available: + +=over 4 + + % git remote add -f upstream https://some.upstream/foo.git + +=back + +Now you simply need to ensure that your git HEAD is dgit-compatible, +i.e., it is exactly what you would get if you ran B and then unpacked the resultant source package. + +To achieve this, you might need to delete +I. One way to have dgit check your +progress is to run B. + +The first dgit push will require I<--overwrite>. + =head1 SOURCE PACKAGE CONFIGURATION =head2 debian/source/options @@ -185,7 +223,7 @@ source: You don't need to create this file if you are using the version 1.0 source package format. -=head2 Sample text for README.source +=head2 Sample text for debian/source/patch-header It is a good idea to explain how a user can obtain a break down of the changes to the upstream source: @@ -194,7 +232,7 @@ changes to the upstream source: The Debian packaging of foo is maintained using dgit. For the sake of an efficient workflow, Debian modifications to the upstream source are -squashed into a single patch, rather than a series of quilt patches. +squashed into a single diff, rather than a series of quilt patches. To obtain a patch queue for package version 1.2.3-1: =over 4 @@ -210,6 +248,10 @@ See dgit(1), dgit(7) and dgit-maint-merge(7) for more information. =back +Alternatively, this text could be added to README.source. However, +this might distract from more important information present in the +latter file. + =head1 BUILDING AND UPLOADING Use B, B, B, and B from "When upstream releases only +tarballs", above. + +Then, either =over 4 @@ -307,6 +349,7 @@ Before merging the new 1.2.3+dfsg tag to master, you should first determine whether it would be legally dangerous for the non-free material to be publicly accessible in the git history on B. + If it would be dangerous, there is a big problem; in this case please consult your archive administrators (for Debian this is the dgit administrator dgit-owner@debian.org