[PATCH] doc/config: do a better job of introducing 'worktree.guessRemote'
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Dec 23, 2018, 19:24 UTC
- Message-ID
- <20181223192435.24803-1-sunshine@sunshineco.com>
The documentation for this option jumps right in with "With `add`", without explaining that `add` is a sub-command of "git worktree". Together with rather odd grammatical structure of the remainder of the sentence, the description can be difficult for newcomers to understand. Clarify by improving the grammar and mentioning "git worktree add" explicitly.
Reported-by: Олег Самойлов <splarv@ya.ru> Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> ---
Reference: https://public-inbox.org/git/0E640233-B2CB-465D-9713-BBECE331CA80@ya.ru/
Documentation/config/worktree.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/worktree.txt b/Documentation/config/worktree.txt index b853798fc2..048e349482 100644 --- a/Documentation/config/worktree.txt +++ b/Documentation/config/worktree.txt @@ -1,6 +1,6 @@ worktree.guessRemote:: - With `add`, if no branch argument, and neither of `-b` nor - `-B` nor `--detach` are given, the command defaults to + If no branch is specified and neither `-b` nor `-B` nor + `--detach` is used, then `git worktree add` defaults to creating a new branch from HEAD. If `worktree.guessRemote` is set to true, `worktree add` tries to find a remote-tracking branch whose name uniquely matches the new branch name. If
-- 2.20.1.415.g653613c723