Improve description of git-branch -d and -D in man page.
Some users expect that deleting a remote-tracking branch would prevent fetch from creating it again, so be explcit about that it's not the case. Also be a little more explicit about what fully merged means. Signed-off-by: Jan Hudec <bulb@ucw.cz> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jan Hudec committed
Nov 17, 2007 at 20:51 UTC
1e72a40de99be24809eba5abdab4c0b00846b9b5
1 file changed
+14
-7
Documentation/git-branch.txt
+14
-7
@@ -45,17 +45,22 @@ to happen.
45
46
With a `-d` or `-D` option, `<branchname>` will be deleted. You may
47
specify more than one branch for deletion. If the branch currently
48
-has a reflog then the reflog will also be deleted. Use -r together with -d
49
-to delete remote-tracking branches.
48
+has a reflog then the reflog will also be deleted.
49
+
50
+Use -r together with -d to delete remote-tracking branches. Note, that it
51
+only makes sense to delete remote-tracking branches if they no longer exist
52
+in remote repository or if gitlink:git-fetch[1] was configured not to fetch
53
+them again. See also 'prune' subcommand of gitlink:git-remote[1] for way to
54
+clean up all obsolete remote-tracking branches.
55
56
57
OPTIONS
58
-------
59
-d::
55
- Delete a branch. The branch must be fully merged.
60
+ Delete a branch. The branch must be fully merged in HEAD.
61
62
-D::
58
- Delete a branch irrespective of its index status.
63
+ Delete a branch irrespective of its merged status.
64
65
-l::
66
Create the branch's reflog. This activates recording of
@@ -153,9 +158,11 @@ $ git branch -d -r origin/todo origin/html origin/man <1>
158
$ git branch -D test <2>
159
------------
160
+
156
-<1> Delete remote-tracking branches "todo", "html", "man"
157
-<2> Delete "test" branch even if the "master" branch does not have all
158
-commits from test branch.
161
+<1> Delete remote-tracking branches "todo", "html", "man". Next 'fetch' or
162
+'pull' will create them again unless you configure them not to. See
163
+gitlink:git-fetch[1].
164
+<2> Delete "test" branch even if the "master" branch (or whichever branch is
165
+currently checked out) does not have all commits from test branch.
166
167
168
Notes