chiark / gitweb /
dgit-sponsorship(7): Correct sponsee/sponsor
[dgit.git] / dgit-sponsorship.7.pod
index 71fb2054286d2ad832dbfaff985e5f6c851f37a2..67d064767eb200e5f25c87a12a96c8f7c50d890c 100644 (file)
@@ -6,7 +6,7 @@ dgit-sponsorship - tutorial for Debian upload sponsorship, using git
 
 This tutorial describes how a Debian sponsored contributor
 and
-their sponsoring DD (or DM)
+a sponsoring DD (or DM)
 can collaborate and publish using git.
 
 The sponsor must to be intending to use dgit for the upload.
@@ -75,7 +75,8 @@ Any .orig tarballs which will be needed.
 
 =item *
 
-Any dgit --quilt= (or --gbp or --dpm) option needed
+A sample dgit push command, containing
+any dgit --quilt=, --gbp or --dpm option needed
 
 =item *
 
@@ -88,6 +89,8 @@ constraints about upload timing, etc.
 
 If the handoff is done by email,
 the elements above should be a in a single, signed, message.
+This could be an RFS submission
+against the sponsorship-requests pseudo-package.
 
 =head2 git branch
 
@@ -101,7 +104,7 @@ and on the server, do not matter.
 
 The sponsee should not make a C<debian/>I<version> tag.
 
-Instead, the sponsor should include the
+Instead, the sponsee should include the
 git commit id of their HEAD
 in their handover email.
 
@@ -110,8 +113,23 @@ in their handover email.
 If there are any .origs that are not in the archive already,
 the sponsor will need them as part of the upload.
 
-The sponsee can put them on a suitable webserver,
-or attach to an email.
+The simplest approach is to
+commit them with pristine-tar(1), e.g.
+
+=over 4
+
+    % pristine-tar commit ../foo_1.2.3.orig.tar.xz upstream/1.2.3
+
+=back
+
+and be sure to push the pristine-tar branch.
+If you are using git-buildpackage(1), just pass
+I<--git-pristine-tar> and I<--git-pristine-tar-commit>.
+
+Alternatively,
+the sponsee can put them on a suitable webserver,
+or attach to the e-mail,
+if they are small.
 
 The sponsee should quote sha256sums of the .origs in their
 handoff email.
@@ -121,11 +139,22 @@ handoff email.
 Some workflows involve git branches which are not natively
 dgit-compatible.
 Normally dgit will convert them as needed, during push.
-You need to tell your sponsor if they need to use
+
+Supply a sample "dgit push" command
+including any
 C<--gbp> (aka C<--quilt=gbp>),
 C<--dpm> (aka C<--quilt=dpm>),
-or one of the other C<--quilt=> options.
+or other C<--quilt=> option
+they need to use.
+e.g.
+
+=over 4
+
+    % dgit --gbp push
 
+=back
+
+=back
 
 =head1 SPONSOR WORKFLOW
 
@@ -135,9 +164,11 @@ This part is addressed to the sponsor:
 
 You should check the signature on the email.
 
-Use C<git fetch> to fetch the git branch
+Use C<git fetch> or C<git clone> to obtain the git branch
 prepared by your sponsee,
-and obtain any .origs mentioned by the sponsee.
+and obtain any .origs mentioned by the sponsee
+(to extract .origs committed with pristine-tar,
+you can use origtargz(1).)
 
 Check the git commit ID of the sponsee's branch tip,
 and the sha256sums of the .origs,