git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH 0/2] fix minor git-worktree.txt botches
@ 2018-02-16 20:44 Eric Sunshine
  2018-02-16 20:44 ` [PATCH 1/2] git-worktree.txt: fix missing ")" typo Eric Sunshine
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Eric Sunshine @ 2018-02-16 20:44 UTC (permalink / raw)
  To: git; +Cc: Thomas Gummerer, Mike Nordell, 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(-)

-- 
2.16.1.374.g7648891022


^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH 1/2] git-worktree.txt: fix missing ")" typo
  2018-02-16 20:44 [PATCH 0/2] fix minor git-worktree.txt botches Eric Sunshine
@ 2018-02-16 20:44 ` Eric Sunshine
  2018-02-16 20:44 ` [PATCH 2/2] git-worktree.txt: fix indentation of example and text of 'add' command Eric Sunshine
  2018-02-16 21:28 ` [PATCH 0/2] fix minor git-worktree.txt botches Junio C Hamano
  2 siblings, 0 replies; 4+ messages in thread
From: Eric Sunshine @ 2018-02-16 20:44 UTC (permalink / raw)
  To: git; +Cc: Thomas Gummerer, Mike Nordell, Eric Sunshine

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.

Reported-by: Mike Nordell <tamlin.thefirst@gmail.com>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/git-worktree.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 41585f535d..c941c48827 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -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>
 ------------
-- 
2.16.1.374.g7648891022


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* [PATCH 2/2] git-worktree.txt: fix indentation of example and text of 'add' command
  2018-02-16 20:44 [PATCH 0/2] fix minor git-worktree.txt botches Eric Sunshine
  2018-02-16 20:44 ` [PATCH 1/2] git-worktree.txt: fix missing ")" typo Eric Sunshine
@ 2018-02-16 20:44 ` Eric Sunshine
  2018-02-16 21:28 ` [PATCH 0/2] fix minor git-worktree.txt botches Junio C Hamano
  2 siblings, 0 replies; 4+ messages in thread
From: Eric Sunshine @ 2018-02-16 20:44 UTC (permalink / raw)
  To: git; +Cc: Thomas Gummerer, Mike Nordell, 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.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/git-worktree.txt | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index c941c48827..5ac3f68ab5 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -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>
 ------------
-- 
2.16.1.374.g7648891022


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH 0/2] fix minor git-worktree.txt botches
  2018-02-16 20:44 [PATCH 0/2] fix minor git-worktree.txt botches Eric Sunshine
  2018-02-16 20:44 ` [PATCH 1/2] git-worktree.txt: fix missing ")" typo Eric Sunshine
  2018-02-16 20:44 ` [PATCH 2/2] git-worktree.txt: fix indentation of example and text of 'add' command Eric Sunshine
@ 2018-02-16 21:28 ` Junio C Hamano
  2 siblings, 0 replies; 4+ messages in thread
From: Junio C Hamano @ 2018-02-16 21:28 UTC (permalink / raw)
  To: Eric Sunshine; +Cc: git, Thomas Gummerer, Mike Nordell

Eric Sunshine <sunshine@sunshineco.com> writes:

> 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.

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2018-02-16 21:28 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-02-16 20:44 [PATCH 0/2] fix minor git-worktree.txt botches Eric Sunshine
2018-02-16 20:44 ` [PATCH 1/2] git-worktree.txt: fix missing ")" typo Eric Sunshine
2018-02-16 20:44 ` [PATCH 2/2] git-worktree.txt: fix indentation of example and text of 'add' command Eric Sunshine
2018-02-16 21:28 ` [PATCH 0/2] fix minor git-worktree.txt botches Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).