aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-worktree.txt
diff options
context:
space:
mode:
authorEric Sunshine <sunshine@sunshineco.com>2020-08-03 20:55:34 -0400
committerJunio C Hamano <gitster@pobox.com>2020-08-03 21:32:25 -0700
commit1933f6ce4399262c0e4eac33e9d2893bf9824e7f (patch)
treed0ff4a7070cdbf250cc51af951323fee6b175273 /Documentation/git-worktree.txt
parentff1ce500f72c1fd7b92d2d402235dbd28d8f7bb4 (diff)
downloadgit-1933f6ce4399262c0e4eac33e9d2893bf9824e7f.tar.gz
git-worktree.txt: make start of new sentence more obvious
When reading the rendered description of `add`, it's easy to trip over and miss the end of one sentence and the start of the next, making it seem as if they are part of the same statement, separated only by a dash: ... specific files such as HEAD, index, etc. - may also be specified as <commit-ish>; it is synonymous with... This can be particularly confusing since the thoughts expressed by the two sentences are unrelated. Reduce the likelihood of confusion by making it obvious that the two sentences are distinct. Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Reviewed-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-worktree.txt')
-rw-r--r--Documentation/git-worktree.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index ce2d40ee4c..544464f949 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -48,8 +48,8 @@ add <path> [<commit-ish>]::
Create `<path>` and checkout `<commit-ish>` into it. The new working directory
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}`.
+directory specific files such as `HEAD`, `index`, etc. As a convenience,
+`<commit-ish>` may be a bare "`-`", which is synonymous with `@{-1}`.
+
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