Documentation: minor grammatical fixes in git-branch.txt.
Signed-off-by: David J. Mellor <dmellor@whistlingcat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
David J. Mellor committed
Mar 16, 2009 at 23:16 UTC
e5ac1217eb2639df1d39fdcd249a35d99e8a7a8e
1 file changed
+25
-25
Documentation/git-branch.txt
+25
-25
@@ -18,19 +18,19 @@ SYNOPSIS
18
DESCRIPTION
19
-----------
20
21
-With no arguments, existing branches are listed, the current branch will
21
+With no arguments, existing branches are listed and the current branch will
22
be highlighted with an asterisk. Option `-r` causes the remote-tracking
23
branches to be listed, and option `-a` shows both.
24
25
-With `--contains`, shows only the branches that contains the named commit
26
-(in other words, the branches whose tip commits are descendant of the
25
+With `--contains`, shows only the branches that contain the named commit
26
+(in other words, the branches whose tip commits are descendants of the
27
named commit). With `--merged`, only branches merged into the named
28
commit (i.e. the branches whose tip commits are reachable from the named
29
commit) will be listed. With `--no-merged` only branches not merged into
30
-the named commit will be listed. Missing <commit> argument defaults to
31
-'HEAD' (i.e. the tip of the current branch).
30
+the named commit will be listed. If the <commit> argument is missing it
31
+defaults to 'HEAD' (i.e. the tip of the current branch).
32
33
-In its second form, a new branch named <branchname> will be created.
33
+In the command's second form, a new branch named <branchname> will be created.
34
It will start out with a head equal to the one given as <start-point>.
35
If no <start-point> is given, the branch will be created with a head
36
equal to that of the currently checked out branch.
@@ -57,9 +57,9 @@ has a reflog then the reflog will also be deleted.
57
58
Use -r together with -d to delete remote-tracking branches. Note, that it
59
only makes sense to delete remote-tracking branches if they no longer exist
60
-in remote repository or if 'git-fetch' was configured not to fetch
61
-them again. See also 'prune' subcommand of linkgit:git-remote[1] for way to
62
-clean up all obsolete remote-tracking branches.
60
+in the remote repository or if 'git-fetch' was configured not to fetch
61
+them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
62
+way to clean up all obsolete remote-tracking branches.
63
64
65
OPTIONS
@@ -83,7 +83,7 @@ OPTIONS
83
Move/rename a branch and the corresponding reflog.
84
85
-M::
86
- Move/rename a branch even if the new branchname already exists.
86
+ Move/rename a branch even if the new branch name already exists.
87
88
--color::
89
Color branches to highlight current, local, and remote branches.
@@ -103,17 +103,17 @@ OPTIONS
103
Show sha1 and commit subject line for each head.
104
105
--abbrev=<length>::
106
- Alter minimum display length for sha1 in output listing,
107
- default value is 7.
106
+ Alter the sha1's minimum display length in the output listing.
107
+ The default value is 7.
108
109
--no-abbrev::
110
- Display the full sha1s in output listing rather than abbreviating them.
110
+ Display the full sha1s in the output listing rather than abbreviating them.
111
112
--track::
113
- When creating a new branch, set up configuration so that 'git-pull'
113
+ When creating a new branch, set up the configuration so that 'git-pull'
114
will automatically retrieve data from the start point, which must be
115
a branch. Use this if you always pull from the same upstream branch
116
- into the new branch, and if you don't want to use "git pull
116
+ into the new branch, and if you do not want to use "git pull
117
<repository> <refspec>" explicitly. This behavior is the default
118
when the start point is a remote branch. Set the
119
branch.autosetupmerge configuration variable to `false` if you want
@@ -149,13 +149,13 @@ OPTIONS
149
150
<newbranch>::
151
The new name for an existing branch. The same restrictions as for
152
- <branchname> applies.
152
+ <branchname> apply.
153
154
155
Examples
156
--------
157
158
-Start development off of a known tag::
158
+Start development from a known tag::
159
+
160
------------
161
$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
@@ -167,7 +167,7 @@ $ git checkout my2.6.14
167
<1> This step and the next one could be combined into a single step with
168
"checkout -b my2.6.14 v2.6.14".
169
170
-Delete unneeded branch::
170
+Delete an unneeded branch::
171
+
172
------------
173
$ git clone git://git.kernel.org/.../git.git my.git
@@ -176,21 +176,21 @@ $ git branch -d -r origin/todo origin/html origin/man <1>
176
$ git branch -D test <2>
177
------------
178
+
179
-<1> Delete remote-tracking branches "todo", "html", "man". Next 'fetch' or
180
-'pull' will create them again unless you configure them not to. See
181
-linkgit:git-fetch[1].
182
-<2> Delete "test" branch even if the "master" branch (or whichever branch is
183
-currently checked out) does not have all commits from test branch.
179
+<1> Delete the remote-tracking branches "todo", "html" and "man". The next
180
+'fetch' or 'pull' will create them again unless you configure them not to.
181
+See linkgit:git-fetch[1].
182
+<2> Delete the "test" branch even if the "master" branch (or whichever branch
183
+is currently checked out) does not have all commits from the test branch.
184
185
186
Notes
187
-----
188
189
-If you are creating a branch that you want to immediately checkout, it's
189
+If you are creating a branch that you want to checkout immediately, it is
190
easier to use the git checkout command with its `-b` option to create
191
a branch and check it out with a single command.
192
193
-The options `--contains`, `--merged` and `--no-merged` serves three related
193
+The options `--contains`, `--merged` and `--no-merged` serve three related
194
but different purposes:
195
196
- `--contains <commit>` is used to find all branches which will need