Skip to contentSkip to conversation

fix minor git-worktree.txt botches

PATCH In review Eric Sunshine 2 participants 4 messages Feb 16, 2018 Documentation

lore
Share & tools
lore
#0 lore raw

cover fix minor git-worktree.txt botches

This patch series fixes a couple git-worktree.txt botches from 4e85333197 (worktree: make add <path> <branch> dwim, 2017-11-26).

Eric Sunshine (2):
git-worktree.txt: fix missing ")" typo
git-worktree.txt: fix indentation of example and text of 'add' command

 Documentation/git-worktree.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Signature · 1 line
2.16.1.374.g7648891022
#1 lore raw

PATCH 1/2 git-worktree.txt: fix missing ")" typo

Add the closing ")" to a parenthetical phrase introduced by 4e85333197 (worktree: make add <path> <branch> dwim, 2017-11-26).

While at it, add a missing ":" at the end of the same sentence since it precedes an example literal command block.

---
 Documentation/git-worktree.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/git-worktree.txt +2 -2
index 41585f535d..c941c48827 100644
@@ -52,10 +52,10 @@ is linked to the current repository, sharing everything except working
 directory specific files such as HEAD, index, etc. `-` may also be
 specified as `<commit-ish>`; it is synonymous with `@{-1}`.
 +
-If <commit-ish> is a branch name (call it `<branch>` and is not found,
+If <commit-ish> is a branch name (call it `<branch>`) and is not found,
 and neither `-b` nor `-B` nor `--detach` are used, but there does
 exist a tracking branch in exactly one remote (call it `<remote>`)
-with a matching name, treat as equivalent to
+with a matching name, treat as equivalent to:
 ------------
 $ git worktree add --track -b <branch> <path> <remote>/<branch>
 ------------
Signature · 1 line
2.16.1.374.g7648891022
#2 lore raw

PATCH 2/2 git-worktree.txt: fix indentation of example and text of 'add' command

In reply to Eric Sunshine

When 4e85333197 (worktree: make add <path> <branch> dwim, 2017-11-26) added an example command in a literal code block, it neglected to insert a mandatory "+" line before the block. This omission resulted in both the literal code block and the (existing) paragraph following the block to be outdented, even though they should be indented under the 'add' sub-command along with the rest of the text pertaining to that command. Furthermore, the mandatory "+" line separating the code block from the following text got rendered as a leading character on the line ("+ If <commit-ish>...") rather than being treated as a formatting directive.

Fix these problems by adding the missing "+" line before the example code block.

---
 Documentation/git-worktree.txt | 1 +
 1 file changed, 1 insertion(+)
Documentation/git-worktree.txt +1 -0
index c941c48827..5ac3f68ab5 100644
@@ -56,6 +56,7 @@ If <commit-ish> is a branch name (call it `<branch>`) and is not found,
 and neither `-b` nor `-B` nor `--detach` are used, but there does
 exist a tracking branch in exactly one remote (call it `<remote>`)
 with a matching name, treat as equivalent to:
++
 ------------
 $ git worktree add --track -b <branch> <path> <remote>/<branch>
 ------------
Signature · 1 line
2.16.1.374.g7648891022
#3 lore raw
In reply to Eric Sunshine
Quoted 9 lines · Eric Sunshine

This patch series fixes a couple git-worktree.txt botches from 4e85333197 (worktree: make add <path> <branch> dwim, 2017-11-26).

Eric Sunshine (2):
git-worktree.txt: fix missing ")" typo
git-worktree.txt: fix indentation of example and text of 'add' command

 Documentation/git-worktree.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Both patches looked trivially correct; thanks.