chiark / gitweb /
git-debrebase: Rename new-upstream-v0 command to new-upstream
[dgit.git] / dgit-maint-debrebase.7.pod
index ec58507e6d6e8386d0c69f074a6d7d617d15b512..e49276848d294691b26ee46a6fa093cf10172261 100644 (file)
@@ -262,7 +262,7 @@ The first dgit push will require I<--overwrite>.
 
 =head1 GIT CONFIGURATION
 
-git-debrebase does not yet support using B<git merge> to merge
+git-debrebase(1) does not yet support using B<git merge> to merge
 divergent branches of development (see "OTHER MERGES" in
 git-debrebase(5)).  You should configure git such that B<git pull>
 does not try to merge:
@@ -323,7 +323,7 @@ or if you have a working watch file
 
 =over 4
 
-    % git debrebase new-upstream-v0 1.2.3
+    % git debrebase new-upstream 1.2.3
 
 =back
 
@@ -456,7 +456,7 @@ For the first upstream release that requires DFSG filtering:
     % git commit -m "upstream version 1.2.3 DFSG-cleaned"
     % git tag -s 1.2.3+dfsg
     % git checkout master
-    % # proceed with "Importing the release"
+    % # proceed with "Importing the release" on 1.2.3+dfsg tag
 
 =back
 
@@ -467,10 +467,10 @@ And for subsequent releases (whether or not they require filtering):
     % git checkout upstream-dfsg
     % git merge 1.2.4
     % git rm further-evil.bin # if needed
-    % git commit -m "upstream version 1.2.4 DFSG-cleaned"
+    % git commit -m "upstream version 1.2.4 DFSG-cleaned" # if needed
     % git tag -s 1.2.4+dfsg
     % git checkout master
-    % # proceed with "Importing the release"
+    % # proceed with "Importing the release" on 1.2.4+dfsg tag
 
 =back
 
@@ -567,15 +567,22 @@ than sending files from I<debian/patches>.
 
 =head2 Upstream branches
 
-Except in the case where upstream releases only tarballs, or we
-require DFSG filtering, we do not maintain a separate 'upstream'
-branch (unless you also happen to be involved in upstream
-development).  We work with upstream tags rather than any branches
-(except temporary branches used to prepare patches for forwarding
-upstream, for example).
+In this workflow, we specify upstream tags rather than any branches.
+
+Except when (i) upstream releases only tarballs, (ii) we require DFSG
+filtering, or (iii) you also happen to be involved in upstream
+development, we do not maintain any local branch corresponding to
+upstream, except temporary branches used to prepare patches for
+forwarding, and the like.
 
 The idea here is that from Debian's point of view, upstream releases
-are immutable points in history, and so better represented by tags.
+are immutable points in history.  We want to make sure that we are
+basing our Debian package on a properly identified upstream version,
+rather than some arbitrary commit on some branch.  Tags are more
+useful for this.
+
+Upstream's branches remain available as the git remote tracking
+branches for your upstream remote, e.g. I<remotes/upstream/master>.
 
 =head2 The first ever dgit push
 
@@ -621,7 +628,7 @@ rebase too early.
 
 =head1 SEE ALSO
 
-dgit(1), dgit(7)
+dgit(1), dgit(7), git-debrebase(1), git-debrebase(5)
 
 =head1 AUTHOR