chiark / gitweb /
dgit-nmu-simple(7): Sample `dch` commands
[dgit.git] / dgit-sponsorship.7.pod
index e6c773044e772b53567bbf68492fb384475c44d6..3b8c3a8b3ad54a42e09a0150bae9f22be921052a 100644 (file)
@@ -6,7 +6,7 @@ dgit-sponsorship - tutorial for Debian upload sponsorship, using git
 
 This tutorial describes how a Debian sponsored contributor
 and
 
 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.
 can collaborate and publish using git.
 
 The sponsor must to be intending to use dgit for the upload.
@@ -59,7 +59,7 @@ options to dgit, or
 C<dgit --gbp> or C<dgit --dpm>,
 you must specify that in your handoff email - see below.
 
 C<dgit --gbp> or C<dgit --dpm>,
 you must specify that in your handoff email - see below.
 
-=head1 GIT+ORIGS BASED HANDOFF
+=head2 git+origs based handoff
 
 The elements of the handoff consists of:
 
 
 The elements of the handoff consists of:
 
@@ -75,7 +75,8 @@ Any .orig tarballs which will be needed.
 
 =item *
 
 
 =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 *
 
 
 =item *
 
@@ -88,8 +89,12 @@ constraints about upload timing, etc.
 
 If the handoff is done by email,
 the elements above should be a in a single, signed, message.
 
 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
+=head3 git branch
+
+=over 4
 
 The sponsee should push their HEAD as a git branch
 to any suitable git server.
 
 The sponsee should push their HEAD as a git branch
 to any suitable git server.
@@ -101,11 +106,15 @@ and on the server, do not matter.
 
 The sponsee should not make a C<debian/>I<version> tag.
 
 
 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.
 
 git commit id of their HEAD
 in their handover email.
 
-=head2 orig tarballs
+=back
+
+=head3 orig tarballs
+
+=over 4
 
 If there are any .origs that are not in the archive already,
 the sponsor will need them as part of the upload.
 
 If there are any .origs that are not in the archive already,
 the sponsor will need them as part of the upload.
@@ -131,16 +140,31 @@ if they are small.
 The sponsee should quote sha256sums of the .origs in their
 handoff email.
 
 The sponsee should quote sha256sums of the .origs in their
 handoff email.
 
-=head2 quilt options
+=back
+
+=head3 quilt options
+
+=over 4
 
 Some workflows involve git branches which are not natively
 dgit-compatible.
 Normally dgit will convert them as needed, during push.
 
 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>),
 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
 
 
 =head1 SPONSOR WORKFLOW
 
@@ -150,7 +174,7 @@ This part is addressed to the sponsor:
 
 You should check the signature on the email.
 
 
 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
 (to extract .origs committed with pristine-tar,
 prepared by your sponsee,
 and obtain any .origs mentioned by the sponsee
 (to extract .origs committed with pristine-tar,