diff options
author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2016-10-30 23:35:28 +0000 |
---|---|---|
committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2016-10-30 23:36:39 +0000 |
commit | ee8bb6a7f4f808b5cb798897c0d5995ce1da888d (patch) | |
tree | 6a60333e1e0d4f04bd896bacf2a2788e79fb5431 /dgit-maint-native.7.pod | |
parent | f2244d496c5655a03462cd4014321a37c98e34c6 (diff) |
dgit-maint-native(7): New manpage
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
Diffstat (limited to 'dgit-maint-native.7.pod')
-rw-r--r-- | dgit-maint-native.7.pod | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/dgit-maint-native.7.pod b/dgit-maint-native.7.pod new file mode 100644 index 0000000..31da00b --- /dev/null +++ b/dgit-maint-native.7.pod @@ -0,0 +1,111 @@ +=head1 NAME + +dgit - tutorial for package maintainers of Debian-native packages + +=head1 INTRODUCTION + +This document describes elements of a workflow for maintaining a +native Debian package using B<dgit>. + +=over 4 + +=item + +We expect that your git history is fast-forwarding. + +=item + +You must be prepared to tolerate a small amount of +ugliness in your git history +in the form of merges which stitch +the dgit-generated archive view +into your maintainer history. + +=back + +=head2 Benefits + +=over 4 + +=item + +Benefit from dgit's safety catches. In particular, ensure that your +upload always matches exactly your git HEAD. + +=item + +Provide a better, +more detailed history +to downstream dgit users. + +=item + +Incorporate an NMU with one command. + +=back + +=head1 FIRST PUSH WITH DGIT + +You do not need to do anything special to your tree +to push with dgit. + +Simply prepare your git tree in the usual way, and then: + +=over 4 + + % dgit -wgf sbuild -A -c sid + % dgit -wgf --overwrite push + +=back + +(Do not make any tags yourself: dgit push will do that.) + +The --overwrite option tells dgit that you are expecting +that your git history is not a descendant of the +history which dgit synthesised from the previous +non-dgit uploads. + +dgit will make a merge commit +on your branch +but without making any code changes +(ie, a pseudo-merge) +so that your history, +which will be pushed to the dgit git server, +is fast forward from the dgit archive view. + +=head1 SUBSEQUENT PUSHES + +=over 4 + + % dgit -wgf push + +=back + +That's it. + +=head1 INCORPORATING AN NMU + +=over 4 + + % dgit pull + +=back + +That's it. + +Or, if you would prefer to review the changes, +you can do this: + +=over 4 + + % dgit fetch + % dgit diff HEAD..dgit/dgit/sid + +=back + +If you do not merge the NMU into your own git history, +the next push will then require I<--overwrite>. + +=head1 SEE ALSO + +dgit(1), dgit(7) |