From: Martin Ågren Date: Mon, 03 Aug 2020 17:57:17 GMT Subject: Re: [PATCH 0/4] git-worktree documentation cleanups Message-ID: <20200803175717.7465-1-martin.agren@gmail.com> In-Reply-To: <20200803053612.50095-1-sunshine@sunshineco.com> On Mon, 3 Aug 2020 at 07:39, Eric Sunshine wrote: > > This series fixes some problems I ran across in the git-worktree > documentation while working on another worktree-related topic. Since > these fixes are distinct from that topic, I'm submitting them > separately. All of these look correct to me. Thanks for polishing the docs. Extra thanks for injecting a "$" where we talk about the actual value of an environment variable. I offer the following suggestions on top. If you agree with them, or some of them, you might want to squash them into the various patches. But it's not like these are critical, I don't think they need to block this. Martin diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt index 260bfe9105..2000a08075 100644 --- a/Documentation/git-worktree.txt +++ b/Documentation/git-worktree.txt @@ -25,8 +25,8 @@ Manage multiple working trees attached to the same repository. A git repository can support multiple working trees, allowing you to check out more than one branch at a time. With `git worktree add` a new working tree is associated with the repository. This new working tree is called a -"linked working tree" as opposed to the "main working tree" prepared by "git -init" or "git clone". A repository has one main working tree (if it's not a +"linked working tree" as opposed to the "main working tree" prepared by linkgit:git-init[1] +or linkgit:git-clone[1]. A repository has one main working tree (if it's not a bare repository) and zero or more linked working trees. When you are done with a linked working tree, remove it with `git worktree remove`. @@ -48,7 +48,7 @@ add []:: Create `` and checkout `` into it. The new working directory is linked to the current repository, sharing everything except working -directory specific files such as HEAD, index, etc. As a convenience, +directory specific files such as `HEAD`, `index`, etc. As a convenience, `` may be a bare "`-`", which is synonymous with `@{-1}`. + If `` is a branch name (call it ``) and is not found, @@ -72,7 +72,7 @@ linkgit:git-config[1]. If `` is omitted and neither `-b` nor `-B` nor `--detach` used, then, as a convenience, the new working tree is associated with a branch (call it ``) named after `$(basename )`. If `` -doesn't exist, a new branch based on HEAD is automatically created as +doesn't exist, a new branch based on `HEAD` is automatically created as if `-b ` was given. If `` does exist, it will be checked out in the new working tree, if it's not checked out anywhere else, otherwise the command will refuse to create the working tree (unless @@ -137,13 +137,13 @@ To remove a locked working tree, specify `--force` twice. -B :: With `add`, create a new branch named `` starting at ``, and check out `` into the new working tree. - If `` is omitted, it defaults to HEAD. + If `` is omitted, it defaults to `HEAD`. By default, `-b` refuses to create a new branch if it already exists. `-B` overrides this safeguard, resetting `` to ``. --detach:: - With `add`, detach HEAD in the new working tree. See "DETACHED HEAD" + With `add`, detach `HEAD` in the new working tree. See "DETACHED HEAD" in linkgit:git-checkout[1]. --[no-]checkout:: @@ -154,7 +154,7 @@ To remove a locked working tree, specify `--force` twice. --[no-]guess-remote:: With `worktree add `, without ``, instead - of creating a new branch from HEAD, if there exists a tracking + of creating a new branch from `HEAD`, if there exists a tracking branch in exactly one remote matching the basename of ``, base the new branch on the remote-tracking branch, and mark the remote-tracking branch as "upstream" from the new branch. @@ -166,7 +166,7 @@ This can also be set up as the default behaviour by using the When creating a new branch, if `` is a branch, mark it as "upstream" from the new branch. This is the default if `` is a remote-tracking branch. See - "--track" in linkgit:git-branch[1] for details. + `--track` in linkgit:git-branch[1] for details. --lock:: Keep the working tree locked after creation. This is the @@ -185,14 +185,14 @@ This can also be set up as the default behaviour by using the -q:: --quiet:: - With 'add', suppress feedback messages. + With `add`, suppress feedback messages. -v:: --verbose:: With `prune`, report all removals. --expire