chiark / gitweb /
changelog: start 2.10~
[dgit.git] / dgit-maint-gbp.7.pod
1 =head1 NAME
2
3 dgit - tutorial for package maintainers already using git-buildpackage(1)
4
5 =head1 INTRODUCTION
6
7 This document explains how B<dgit> can be incorporated into a
8 git-buildpackage(1) package-maintenance workflow.  This should be read
9 jointly with git-buildpackage(1)'s documentation.  Some reasons why
10 you might want to incorporate B<dgit> into your existing workflow:
11
12 =over 4
13
14 =item
15
16 Benefit from dgit's safety catches.  In particular, ensure that your
17 upload always matches exactly your git HEAD.
18
19 =item
20
21 Provide a better, more detailed git history to downstream dgit users,
22 such as people using dgit to do an NMU (see dgit-nmu-simple(7) and
23 dgit-user(7)).
24
25 =back
26
27 Note that we assume a patches-unapplied repository: the upstream
28 source committed to the git repository is unpatched.
29 git-buildpackage(1) can work with patched-applied repositories, but is
30 normally used with patches-unapplied.
31
32 =head1 GIT CONFIGURATION
33
34 If you run
35
36 =over 4
37
38     % git config dgit.default.quilt-mode gbp
39
40 =back
41
42 in your repository, you can omit I<--gbp> wherever it occurs below.
43
44 Note that this does require that you always work from your gbp master
45 branch, never the dgit patches-applied branch.
46
47 =head1 BUILDING
48
49 If you use gbp-buildpackage(1) to generate your orig tarballs, you
50 will need to perform the first build with gbp-buildpackage(1) directly
51 (this is due to Debian bug #841084).
52
53 Otherwise, you can perform builds like this:
54
55 =over 4
56
57     % dgit [--allow-dirty] gbp-build [OPTIONS]
58
59 =back
60
61 where I<--allow-dirty> is needed for testing uncommitted changes, and
62 I<OPTIONS> are any further options to be passed on to
63 gbp-buildpackage(1).
64
65 When you are ready to build for upload, you will probably want to use
66 sbuild(1) or pbuilder(1), or do a source-only upload.  Either
67
68 =over 4
69
70     % dgit --rm-old-changes --gbp sbuild
71
72 =back
73
74 or
75
76 =over 4
77
78     % dgit --rm-old-changes gbp-build --git-pbuilder
79
80 =back
81
82 or
83
84 =over 4
85
86     % dgit --rm-old-changes --gbp build-source
87
88 =back
89
90 We use I<--rm-old-changes> to ensure that there is exactly one changes
91 file corresponding to this package, so we can be confident we're
92 uploading what we intend (though B<dgit push> will do some safety
93 checks).
94
95 Note that all of the commands in this section are not required to
96 upload with dgit.  You can invoke gbp-buildpackage(1), pbuilder(1) and
97 sbuild(1) directly.  However, the defaults for these tools may leave
98 you with something that dgit will refuse to upload because it doesn't
99 match your git HEAD.  As a general rule, leave all signing and tagging
100 to dgit.
101
102 =head1 UPLOADING
103
104 Don't use I<--git-tag>: B<dgit push> will do this for you.  To upload:
105
106 =over 4
107
108     % dgit --gbp push
109
110 =back
111
112 This will push your git history to the dgit-repos, but you probably
113 want to follow it up with a push to alioth.
114
115 You will need to pass I<--overwrite> if the previous upload was not
116 performed with dgit.
117
118 =head1 INCORPORATING NMUS
119
120 B<dgit pull> can't yet incorporate NMUs into patches-unapplied gbp
121 branches.  You can just apply the NMU diff the traditional way.  The
122 next upload will require I<--overwrite>.
123
124 =head1 SEE ALSO
125
126 dgit(1), dgit(7)
127
128 =head1 AUTHOR
129
130 This tutorial was written and is maintained by Sean Whitton <spwhitton@spwhitton.name>.