* [PATCH] Documentation update for 'git branch'
@ 2012-03-06 8:51 vfr
2012-03-06 9:00 ` Thomas Rast
2012-03-06 9:32 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Vincent van Ravesteijn
0 siblings, 2 replies; 6+ messages in thread
From: vfr @ 2012-03-06 8:51 UTC (permalink / raw)
To: git; +Cc: gitster, Vincent van Ravesteijn
From: Vincent van Ravesteijn <vfr@lyx.org>
Changes:
- add a period to a sentence,
- correct 'tag' into 'branch',
- unify the use of backticks,
- indicate that the commit parameter of --contains defaults to HEAD.
Signed-off-by: Vincent van Ravesteijn <vfr@lyx.org>
---
Documentation/git-branch.txt | 19 ++++++++++---------
1 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 0427e80..6410c3d 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -24,8 +24,8 @@ be highlighted with an asterisk. Option `-r` causes the remote-tracking
branches to be listed, and option `-a` shows both. This list mode is also
activated by the `--list` option (see below).
<pattern> restricts the output to matching branches, the pattern is a shell
-wildcard (i.e., matched using fnmatch(3))
-Multiple patterns may be given; if any of them matches, the tag is shown.
+wildcard (i.e., matched using fnmatch(3)).
+Multiple patterns may be given; if any of them matches, the branch is shown.
With `--contains`, shows only the branches that contain the named commit
(in other words, the branches whose tip commits are descendants of the
@@ -49,7 +49,7 @@ the remote-tracking branch. This behavior may be changed via the global
overridden by using the `--track` and `--no-track` options, and
changed later using `git branch --set-upstream`.
-With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>.
+With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>.
If <oldbranch> had a corresponding reflog, it is renamed to match
<newbranch>, and a reflog entry is created to remember the branch
renaming. If <newbranch> exists, -M must be used to force the rename
@@ -59,7 +59,7 @@ With a `-d` or `-D` option, `<branchname>` will be deleted. You may
specify more than one branch for deletion. If the branch currently
has a reflog then the reflog will also be deleted.
-Use -r together with -d to delete remote-tracking branches. Note, that it
+Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
only makes sense to delete remote-tracking branches if they no longer exist
in the remote repository or if 'git fetch' was configured not to fetch
them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
@@ -154,17 +154,18 @@ start-point is either a local or remote-tracking branch.
branch.autosetupmerge configuration variable is true.
--set-upstream::
- If specified branch does not exist yet or if '--force' has been
- given, acts exactly like '--track'. Otherwise sets up configuration
- like '--track' would when creating the branch, except that where
+ If specified branch does not exist yet or if `--force` has been
+ given, acts exactly like `--track`. Otherwise sets up configuration
+ like `--track` would when creating the branch, except that where
branch points to is not changed.
--edit-description::
Open an editor and edit the text to explain what the branch is
for, to be used by various other commands (e.g. `request-pull`).
---contains <commit>::
- Only list branches which contain the specified commit.
+--contains [<commit>]::
+ Only list branches which contain the specified commit (HEAD
+ if not specified).
--merged [<commit>]::
Only list branches whose tips are reachable from the
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] Documentation update for 'git branch'
2012-03-06 8:51 [PATCH] Documentation update for 'git branch' vfr
@ 2012-03-06 9:00 ` Thomas Rast
2012-03-06 9:32 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Vincent van Ravesteijn
1 sibling, 0 replies; 6+ messages in thread
From: Thomas Rast @ 2012-03-06 9:00 UTC (permalink / raw)
To: vfr; +Cc: git, gitster
Hi Vincent,
vfr@lyx.org writes:
> Changes:
> - add a period to a sentence,
> - correct 'tag' into 'branch',
> - unify the use of backticks,
> - indicate that the commit parameter of --contains defaults to HEAD.
First off, please read Documentation/SubmittingPatches. I think this
should be split into at least two commits, one for the cleanups and one
for the actual change.
As for
> - unify the use of backticks,
nice catch, and note that this is a pretty common problem across the
docs.
--
Thomas Rast
trast@{inf,student}.ethz.ch
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCHv2 1/3] Documentation/git-branch: cleanups
2012-03-06 8:51 [PATCH] Documentation update for 'git branch' vfr
2012-03-06 9:00 ` Thomas Rast
@ 2012-03-06 9:32 ` Vincent van Ravesteijn
2012-03-06 9:32 ` [PATCHv2 2/3] Documentation/git-branch: fix a typo Vincent van Ravesteijn
` (2 more replies)
1 sibling, 3 replies; 6+ messages in thread
From: Vincent van Ravesteijn @ 2012-03-06 9:32 UTC (permalink / raw)
To: git; +Cc: trast, gitster, Vincent van Ravesteijn
From: Vincent van Ravesteijn <vfr@lyx.org>
Changes:
- add a period to a sentence,
- unify the use of backticks.
Signed-off-by: Vincent van Ravesteijn <vfr@lyx.org>
---
Documentation/git-branch.txt | 12 ++++++------
1 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 0427e80..d3a923a 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -24,7 +24,7 @@ be highlighted with an asterisk. Option `-r` causes the remote-tracking
branches to be listed, and option `-a` shows both. This list mode is also
activated by the `--list` option (see below).
<pattern> restricts the output to matching branches, the pattern is a shell
-wildcard (i.e., matched using fnmatch(3))
+wildcard (i.e., matched using fnmatch(3)).
Multiple patterns may be given; if any of them matches, the tag is shown.
With `--contains`, shows only the branches that contain the named commit
@@ -49,7 +49,7 @@ the remote-tracking branch. This behavior may be changed via the global
overridden by using the `--track` and `--no-track` options, and
changed later using `git branch --set-upstream`.
-With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>.
+With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>.
If <oldbranch> had a corresponding reflog, it is renamed to match
<newbranch>, and a reflog entry is created to remember the branch
renaming. If <newbranch> exists, -M must be used to force the rename
@@ -59,7 +59,7 @@ With a `-d` or `-D` option, `<branchname>` will be deleted. You may
specify more than one branch for deletion. If the branch currently
has a reflog then the reflog will also be deleted.
-Use -r together with -d to delete remote-tracking branches. Note, that it
+Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
only makes sense to delete remote-tracking branches if they no longer exist
in the remote repository or if 'git fetch' was configured not to fetch
them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
@@ -154,9 +154,9 @@ start-point is either a local or remote-tracking branch.
branch.autosetupmerge configuration variable is true.
--set-upstream::
- If specified branch does not exist yet or if '--force' has been
- given, acts exactly like '--track'. Otherwise sets up configuration
- like '--track' would when creating the branch, except that where
+ If specified branch does not exist yet or if `--force` has been
+ given, acts exactly like `--track`. Otherwise sets up configuration
+ like `--track` would when creating the branch, except that where
branch points to is not changed.
--edit-description::
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCHv2 2/3] Documentation/git-branch: fix a typo
2012-03-06 9:32 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Vincent van Ravesteijn
@ 2012-03-06 9:32 ` Vincent van Ravesteijn
2012-03-06 9:32 ` [PATCHv2 3/3] Documentation/git-branch: add default for --contains Vincent van Ravesteijn
2012-03-06 19:43 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Junio C Hamano
2 siblings, 0 replies; 6+ messages in thread
From: Vincent van Ravesteijn @ 2012-03-06 9:32 UTC (permalink / raw)
To: git; +Cc: trast, gitster, Vincent van Ravesteijn
From: Vincent van Ravesteijn <vfr@lyx.org>
Fix a typo by replacing 'tag' with 'branch'.
Signed-off-by: Vincent van Ravesteijn <vfr@lyx.org>
---
Documentation/git-branch.txt | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index d3a923a..cfceac5 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -25,7 +25,7 @@ branches to be listed, and option `-a` shows both. This list mode is also
activated by the `--list` option (see below).
<pattern> restricts the output to matching branches, the pattern is a shell
wildcard (i.e., matched using fnmatch(3)).
-Multiple patterns may be given; if any of them matches, the tag is shown.
+Multiple patterns may be given; if any of them matches, the branch is shown.
With `--contains`, shows only the branches that contain the named commit
(in other words, the branches whose tip commits are descendants of the
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCHv2 3/3] Documentation/git-branch: add default for --contains
2012-03-06 9:32 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Vincent van Ravesteijn
2012-03-06 9:32 ` [PATCHv2 2/3] Documentation/git-branch: fix a typo Vincent van Ravesteijn
@ 2012-03-06 9:32 ` Vincent van Ravesteijn
2012-03-06 19:43 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Junio C Hamano
2 siblings, 0 replies; 6+ messages in thread
From: Vincent van Ravesteijn @ 2012-03-06 9:32 UTC (permalink / raw)
To: git; +Cc: trast, gitster, Vincent van Ravesteijn
From: Vincent van Ravesteijn <vfr@lyx.org>
Indicate that the commit parameter of --contains defaults to HEAD.
Signed-off-by: Vincent van Ravesteijn <vfr@lyx.org>
---
Documentation/git-branch.txt | 5 +++--
1 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index cfceac5..6410c3d 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -163,8 +163,9 @@ start-point is either a local or remote-tracking branch.
Open an editor and edit the text to explain what the branch is
for, to be used by various other commands (e.g. `request-pull`).
---contains <commit>::
- Only list branches which contain the specified commit.
+--contains [<commit>]::
+ Only list branches which contain the specified commit (HEAD
+ if not specified).
--merged [<commit>]::
Only list branches whose tips are reachable from the
--
1.7.5.4
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCHv2 1/3] Documentation/git-branch: cleanups
2012-03-06 9:32 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Vincent van Ravesteijn
2012-03-06 9:32 ` [PATCHv2 2/3] Documentation/git-branch: fix a typo Vincent van Ravesteijn
2012-03-06 9:32 ` [PATCHv2 3/3] Documentation/git-branch: add default for --contains Vincent van Ravesteijn
@ 2012-03-06 19:43 ` Junio C Hamano
2 siblings, 0 replies; 6+ messages in thread
From: Junio C Hamano @ 2012-03-06 19:43 UTC (permalink / raw)
To: Vincent van Ravesteijn; +Cc: git, trast
Thanks, both.
Will queue.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2012-03-06 19:43 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-03-06 8:51 [PATCH] Documentation update for 'git branch' vfr
2012-03-06 9:00 ` Thomas Rast
2012-03-06 9:32 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Vincent van Ravesteijn
2012-03-06 9:32 ` [PATCHv2 2/3] Documentation/git-branch: fix a typo Vincent van Ravesteijn
2012-03-06 9:32 ` [PATCHv2 3/3] Documentation/git-branch: add default for --contains Vincent van Ravesteijn
2012-03-06 19:43 ` [PATCHv2 1/3] Documentation/git-branch: cleanups Junio C Hamano
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).