{"thread":{"id":"53971","subject":"[PATCH 0/4] git-worktree documentation cleanups","startedAt":"2020-08-03T05:37:17Z","lastAt":"2020-08-04T05:23:16Z","messageCount":20,"participants":["Eric Sunshine","Taylor Blau","Junio C Hamano","Martin Ågren"],"isPatch":true,"patchVersion":1,"patchTotal":4},"messages":[{"id":"402673","messageId":"20200803053612.50095-1-sunshine@sunshineco.com","threadId":"53971","inReplyTo":null,"subject":"[PATCH 0/4] git-worktree documentation cleanups","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2020-08-03T05:36:08Z","receivedAt":"2020-08-03T05:37:17Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"This series fixes some problems I ran across in the git-worktree\ndocumentation while working on another worktree-related topic. Since\nthese fixes are distinct from that topic, I'm submitting them\nseparately.\n\nEric Sunshine (4):\n git-worktree.txt: employ fixed-width typeface consistently\n git-worktree.txt: consistently use term \"working tree\"\n git-worktree.txt: fix minor grammatical issues\n git-worktree.txt: make start of new sentence more obvious\n\n Documentation/git-worktree.txt | 96 +++++++++++++++++-----------------\n 1 file changed, 48 insertions(+), 48 deletions(-)\n\n-- \n2.28.0.236.gb10cc79966\n\n"},{"id":"402674","messageId":"20200803053612.50095-3-sunshine@sunshineco.com","threadId":"53971","inReplyTo":"20200803053612.50095-1-sunshine@sunshineco.com","subject":"[PATCH 2/4] git-worktree.txt: consistently use term \"working tree\"","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2020-08-03T05:36:10Z","receivedAt":"2020-08-03T05:37:19Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"As originally composed, git-worktree.txt employed a mix of \"worktree\"\nand \"working tree\" which was inconsistent and potentially confusing to\nreaders. bc483285b7 (Documentation/git-worktree: consistently use term\n\"linked working tree\", 2015-07-20) undertook the task of employing the\nterm \"working tree\" consistently throughout the document and avoiding\n\"worktree\" altogether for descriptive text. Since that time, some\ninstances of \"worktree\" have crept back in. Continue the work of\nbc483285b7 by transforming these to \"working tree\", as well.\n\nSigned-off-by: Eric Sunshine \n---\n Documentation/git-worktree.txt | 22 +++++++++++-----------\n 1 file changed, 11 insertions(+), 11 deletions(-)\n\ndiff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt\nindex 810fc8b5e1..cd762876f0 100644\n--- a/Documentation/git-worktree.txt\n+++ b/Documentation/git-worktree.txt\n@@ -70,20 +70,20 @@ branches from there if `` is ambiguous but exists on the\n linkgit:git-config[1].\n +\n If `` is omitted and neither `-b` nor `-B` nor `--detach` used,\n-then, as a convenience, the new worktree is associated with a branch\n+then, as a convenience, the new working tree is associated with a branch\n (call it ``) named after `$(basename )`. If ``\n doesn't exist, a new branch based on HEAD is automatically created as\n if `-b ` was given. If `` does exist, it will be\n-checked out in the new worktree, if it's not checked out anywhere\n-else, otherwise the command will refuse to create the worktree (unless\n+checked out in the new working tree, if it's not checked out anywhere\n+else, otherwise the command will refuse to create the working tree (unless\n `--force` is used).\n \n list::\n \n-List details of each worktree. The main worktree is listed first, followed by\n-each of the linked worktrees. The output details include if the worktree is\n-bare, the revision currently checked out, and the branch currently checked out\n-(or \"detached HEAD\" if none).\n+List details of each working tree. The main working tree is listed first,\n+followed by each of the linked working trees. The output details include\n+if the working tree is bare, the revision currently checked out, and the\n+branch currently checked out (or \"detached HEAD\" if none).\n \n lock::\n \n@@ -202,7 +202,7 @@ This can also be set up as the default behaviour by using the\n \tabsolute.\n +\n If the last path components in the working tree's path is unique among\n-working trees, it can be used to identify worktrees. For example if\n+working trees, it can be used to identify working trees. For example if\n you only have two working trees, at `/abc/def/ghi` and `/abc/def/ggg`,\n then `ghi` or `def/ghi` is enough to point to the former working tree.\n \n@@ -221,7 +221,7 @@ shared.\n \n Refs that are per working tree can still be accessed from another\n working tree via two special paths, `main-worktree` and `worktrees`. The\n-former gives access to per-worktree refs of the main working tree,\n+former gives access to per-working tree refs of the main working tree,\n while the latter to all linked working trees.\n \n For example, `main-worktree/HEAD` or `main-worktree/refs/bisect/good`\n@@ -335,8 +335,8 @@ Porcelain Format\n The porcelain format has a line per attribute. Attributes are listed with a\n label and value separated by a single space. Boolean attributes (like `bare`\n and `detached`) are listed as a label only, and are only present if and only\n-if the value is true. The first attribute of a worktree is always `worktree`,\n-an empty line indicates the end of the record. For example:\n+if the value is true. The first attribute of a working tree is always\n+`worktree`, an empty line indicates the end of the record. For example:\n \n ------------\n $ git worktree list --porcelain\n-- \n2.28.0.236.gb10cc79966\n\n"},{"id":"402675","messageId":"20200803053612.50095-2-sunshine@sunshineco.com","threadId":"53971","inReplyTo":"20200803053612.50095-1-sunshine@sunshineco.com","subject":"[PATCH 1/4] git-worktree.txt: employ fixed-width typeface consistently","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2020-08-03T05:36:09Z","receivedAt":"2020-08-03T05:37:19Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"git-worktree documentation generally does a good job of formatting\nliteral text using a fixed-width typeface, however, some instances of\nunformatted literal text have crept in over time. Fix these.\n\nWhile at it, also fix a few incorrect typefaces resulting from wrong\nchoice of Asciidoc quotes.\n\nSigned-off-by: Eric Sunshine \n---\n Documentation/git-worktree.txt | 66 +++++++++++++++++-----------------\n 1 file changed, 33 insertions(+), 33 deletions(-)\n\ndiff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt\nindex 4796c3c05e..810fc8b5e1 100644\n--- a/Documentation/git-worktree.txt\n+++ b/Documentation/git-worktree.txt\n@@ -51,7 +51,7 @@ is linked to the current repository, sharing everything except working\n directory specific files such as HEAD, index, etc. `-` may also be\n specified as ``; it is synonymous with `@{-1}`.\n +\n-If is a branch name (call it ``) and is not found,\n+If `` is a branch name (call it ``) and is not found,\n and neither `-b` nor `-B` nor `--detach` are used, but there does\n exist a tracking branch in exactly one remote (call it ``)\n with a matching name, treat as equivalent to:\n@@ -83,7 +83,7 @@ list::\n List details of each worktree. The main worktree is listed first, followed by\n each of the linked worktrees. The output details include if the worktree is\n bare, the revision currently checked out, and the branch currently checked out\n-(or 'detached HEAD' if none).\n+(or \"detached HEAD\" if none).\n \n lock::\n \n@@ -100,7 +100,7 @@ or linked working trees containing submodules cannot be moved.\n \n prune::\n \n-Prune working tree information in $GIT_DIR/worktrees.\n+Prune working tree information in `$GIT_DIR/worktrees`.\n \n remove::\n \n@@ -128,7 +128,7 @@ OPTIONS\n `move` refuses to move a locked working tree unless `--force` is specified\n twice. If the destination is already assigned to some other working tree but is\n missing (for instance, if `` was deleted manually), then `--force`\n-allows the move to proceed; use --force twice if the destination is locked.\n+allows the move to proceed; use `--force` twice if the destination is locked.\n +\n `remove` refuses to remove an unclean working tree unless `--force` is used.\n To remove a locked working tree, specify `--force` twice.\n@@ -203,8 +203,8 @@ This can also be set up as the default behaviour by using the\n +\n If the last path components in the working tree's path is unique among\n working trees, it can be used to identify worktrees. For example if\n-you only have two working trees, at \"/abc/def/ghi\" and \"/abc/def/ggg\",\n-then \"ghi\" or \"def/ghi\" is enough to point to the former working tree.\n+you only have two working trees, at `/abc/def/ghi` and `/abc/def/ggg`,\n+then `ghi` or `def/ghi` is enough to point to the former working tree.\n \n REFS\n ----\n@@ -214,24 +214,24 @@ working trees. This section is about the sharing rules and how to access\n refs of one working tree from another.\n \n In general, all pseudo refs are per working tree and all refs starting\n-with \"refs/\" are shared. Pseudo refs are ones like HEAD which are\n-directly under GIT_DIR instead of inside GIT_DIR/refs. There is one\n-exception to this: refs inside refs/bisect and refs/worktree is not\n+with `refs/` are shared. Pseudo refs are ones like HEAD which are\n+directly under `$GIT_DIR` instead of inside `$GIT_DIR/refs`. There is one\n+exception to this: refs inside `refs/bisect` and `refs/worktree` is not\n shared.\n \n Refs that are per working tree can still be accessed from another\n-working tree via two special paths, main-worktree and worktrees. The\n+working tree via two special paths, `main-worktree` and `worktrees`. The\n former gives access to per-worktree refs of the main working tree,\n while the latter to all linked working trees.\n \n-For example, main-worktree/HEAD or main-worktree/refs/bisect/good\n+For example, `main-worktree/HEAD` or `main-worktree/refs/bisect/good`\n resolve to the same value as the main working tree's HEAD and\n-refs/bisect/good respectively. Similarly, worktrees/foo/HEAD or\n-worktrees/bar/refs/bisect/bad are the same as\n-GIT_COMMON_DIR/worktrees/foo/HEAD and\n-GIT_COMMON_DIR/worktrees/bar/refs/bisect/bad.\n+`refs/bisect/good` respectively. Similarly, `worktrees/foo/HEAD` or\n+`worktrees/bar/refs/bisect/bad` are the same as\n+`$GIT_COMMON_DIR/worktrees/foo/HEAD` and\n+`$GIT_COMMON_DIR/worktrees/bar/refs/bisect/bad`.\n \n-To access refs, it's best not to look inside GIT_DIR directly. Instead\n+To access refs, it's best not to look inside `$GIT_DIR` directly. Instead\n use commands such as linkgit:git-rev-parse[1] or linkgit:git-update-ref[1]\n which will handle refs correctly.\n \n@@ -255,7 +255,7 @@ configuration in this file with `git config --worktree`. Older Git\n versions will refuse to access repositories with this extension.\n \n Note that in this file, the exception for `core.bare` and `core.worktree`\n-is gone. If you have them in $GIT_DIR/config before, you must move\n+is gone. If you have them in `$GIT_DIR/config` before, you must move\n them to the `config.worktree` of the main working tree. You may also\n take this opportunity to review and move other configuration that you\n do not want to share to all working trees:\n@@ -268,7 +268,7 @@ do not want to share to all working trees:\n DETAILS\n -------\n Each linked working tree has a private sub-directory in the repository's\n-$GIT_DIR/worktrees directory. The private sub-directory's name is usually\n+`$GIT_DIR/worktrees` directory. The private sub-directory's name is usually\n the base name of the linked working tree's path, possibly appended with a\n number to make it unique. For example, when `$GIT_DIR=/path/main/.git` the\n command `git worktree add /path/other/test-next next` creates the linked\n@@ -276,51 +276,51 @@ working tree in `/path/other/test-next` and also creates a\n `$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1`\n if `test-next` is already taken).\n \n-Within a linked working tree, $GIT_DIR is set to point to this private\n+Within a linked working tree, `$GIT_DIR` is set to point to this private\n directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and\n-$GIT_COMMON_DIR is set to point back to the main working tree's $GIT_DIR\n+`$GIT_COMMON_DIR` is set to point back to the main working tree's `$GIT_DIR`\n (e.g. `/path/main/.git`). These settings are made in a `.git` file located at\n the top directory of the linked working tree.\n \n Path resolution via `git rev-parse --git-path` uses either\n-$GIT_DIR or $GIT_COMMON_DIR depending on the path. For example, in the\n+`$GIT_DIR` or `$GIT_COMMON_DIR` depending on the path. For example, in the\n linked working tree `git rev-parse --git-path HEAD` returns\n `/path/main/.git/worktrees/test-next/HEAD` (not\n `/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git\n rev-parse --git-path refs/heads/master` uses\n-$GIT_COMMON_DIR and returns `/path/main/.git/refs/heads/master`,\n-since refs are shared across all working trees, except refs/bisect and\n-refs/worktree.\n+`$GIT_COMMON_DIR` and returns `/path/main/.git/refs/heads/master`,\n+since refs are shared across all working trees, except `refs/bisect` and\n+`refs/worktree`.\n \n See linkgit:gitrepository-layout[5] for more information. The rule of\n thumb is do not make any assumption about whether a path belongs to\n-$GIT_DIR or $GIT_COMMON_DIR when you need to directly access something\n-inside $GIT_DIR. Use `git rev-parse --git-path` to get the final path.\n+`$GIT_DIR` or `$GIT_COMMON_DIR` when you need to directly access something\n+inside `$GIT_DIR`. Use `git rev-parse --git-path` to get the final path.\n \n-If you manually move a linked working tree, you need to update the 'gitdir' file\n+If you manually move a linked working tree, you need to update the `gitdir` file\n in the entry's directory. For example, if a linked working tree is moved\n to `/newpath/test-next` and its `.git` file points to\n `/path/main/.git/worktrees/test-next`, then update\n `/path/main/.git/worktrees/test-next/gitdir` to reference `/newpath/test-next`\n instead.\n \n-To prevent a $GIT_DIR/worktrees entry from being pruned (which\n+To prevent a `$GIT_DIR/worktrees` entry from being pruned (which\n can be useful in some situations, such as when the\n entry's working tree is stored on a portable device), use the\n `git worktree lock` command, which adds a file named\n-'locked' to the entry's directory. The file contains the reason in\n+`locked` to the entry's directory. The file contains the reason in\n plain text. For example, if a linked working tree's `.git` file points\n to `/path/main/.git/worktrees/test-next` then a file named\n `/path/main/.git/worktrees/test-next/locked` will prevent the\n `test-next` entry from being pruned. See\n linkgit:gitrepository-layout[5] for details.\n \n-When extensions.worktreeConfig is enabled, the config file\n+When `extensions.worktreeConfig` is enabled, the config file\n `.git/worktrees//config.worktree` is read after `.git/config` is.\n \n LIST OUTPUT FORMAT\n ------------------\n-The worktree list command has two output formats. The default format shows the\n+The `worktree list` command has two output formats. The default format shows the\n details on a single line with columns. For example:\n \n ------------\n@@ -333,8 +333,8 @@ $ git worktree list\n Porcelain Format\n ~~~~~~~~~~~~~~~~\n The porcelain format has a line per attribute. Attributes are listed with a\n-label and value separated by a single space. Boolean attributes (like 'bare'\n-and 'detached') are listed as a label only, and are only present if and only\n+label and value separated by a single space. Boolean attributes (like `bare`\n+and `detached`) are listed as a label only, and are only present if and only\n if the value is true. The first attribute of a worktree is always `worktree`,\n an empty line indicates the end of the record. For example:\n \n-- \n2.28.0.236.gb10cc79966\n\n"},{"id":"402676","messageId":"20200803053612.50095-4-sunshine@sunshineco.com","threadId":"53971","inReplyTo":"20200803053612.50095-1-sunshine@sunshineco.com","subject":"[PATCH 3/4] git-worktree.txt: fix minor grammatical issues","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2020-08-03T05:36:11Z","receivedAt":"2020-08-03T05:37:20Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"Fix a few grammatical problems to improve the reading experience.\n\nSigned-off-by: Eric Sunshine \n---\n Documentation/git-worktree.txt | 18 +++++++++---------\n 1 file changed, 9 insertions(+), 9 deletions(-)\n\ndiff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt\nindex cd762876f0..49422454d1 100644\n--- a/Documentation/git-worktree.txt\n+++ b/Documentation/git-worktree.txt\n@@ -82,7 +82,7 @@ list::\n \n List details of each working tree. The main working tree is listed first,\n followed by each of the linked working trees. The output details include\n-if the working tree is bare, the revision currently checked out, and the\n+whether the working tree is bare, the revision currently checked out, and the\n branch currently checked out (or \"detached HEAD\" if none).\n \n lock::\n@@ -171,7 +171,7 @@ This can also be set up as the default behaviour by using the\n --lock::\n \tKeep the working tree locked after creation. This is the\n \tequivalent of `git worktree lock` after `git worktree add`,\n-\tbut without race condition.\n+\tbut without a race condition.\n \n -n::\n --dry-run::\n@@ -202,21 +202,21 @@ This can also be set up as the default behaviour by using the\n \tabsolute.\n +\n If the last path components in the working tree's path is unique among\n-working trees, it can be used to identify working trees. For example if\n+working trees, it can be used to identify a working tree. For example if\n you only have two working trees, at `/abc/def/ghi` and `/abc/def/ggg`,\n then `ghi` or `def/ghi` is enough to point to the former working tree.\n \n REFS\n ----\n In multiple working trees, some refs may be shared between all working\n-trees, some refs are local. One example is HEAD is different for all\n-working trees. This section is about the sharing rules and how to access\n+trees and some refs are local. One example is HEAD which is different for each\n+working tree. This section is about the sharing rules and how to access\n refs of one working tree from another.\n \n In general, all pseudo refs are per working tree and all refs starting\n with `refs/` are shared. Pseudo refs are ones like HEAD which are\n-directly under `$GIT_DIR` instead of inside `$GIT_DIR/refs`. There is one\n-exception to this: refs inside `refs/bisect` and `refs/worktree` is not\n+directly under `$GIT_DIR` instead of inside `$GIT_DIR/refs`. There are\n+exceptions, however: refs inside `refs/bisect` and `refs/worktree` are not\n shared.\n \n Refs that are per working tree can still be accessed from another\n@@ -255,7 +255,7 @@ configuration in this file with `git config --worktree`. Older Git\n versions will refuse to access repositories with this extension.\n \n Note that in this file, the exception for `core.bare` and `core.worktree`\n-is gone. If you have them in `$GIT_DIR/config` before, you must move\n+is gone. If they exist in `$GIT_DIR/config`, you must move\n them to the `config.worktree` of the main working tree. You may also\n take this opportunity to review and move other configuration that you\n do not want to share to all working trees:\n@@ -334,7 +334,7 @@ Porcelain Format\n ~~~~~~~~~~~~~~~~\n The porcelain format has a line per attribute. Attributes are listed with a\n label and value separated by a single space. Boolean attributes (like `bare`\n-and `detached`) are listed as a label only, and are only present if and only\n+and `detached`) are listed as a label only, and are present only\n if the value is true. The first attribute of a working tree is always\n `worktree`, an empty line indicates the end of the record. For example:\n \n-- \n2.28.0.236.gb10cc79966\n\n"},{"id":"402677","messageId":"20200803053612.50095-5-sunshine@sunshineco.com","threadId":"53971","inReplyTo":"20200803053612.50095-1-sunshine@sunshineco.com","subject":"[PATCH 4/4] git-worktree.txt: make start of new sentence more obvious","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2020-08-03T05:36:12Z","receivedAt":"2020-08-03T05:37:21Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"When reading the rendered description of `add`, it's easy to trip over\nand miss the end of one sentence and the start of the next, making it\nseem as if they are part of the same statement, separated only by a\ndash:\n\n ... specific files such as HEAD, index, etc. - may also be\n specified as ; it is synonymous with...\n\nThis can be particularly confusing since the thoughts expressed by the\ntwo sentences are unrelated. Reduce the likelihood of confusion by\nmaking it obvious that the two sentences are distinct.\n\nSigned-off-by: Eric Sunshine \n---\n Documentation/git-worktree.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt\nindex 49422454d1..260bfe9105 100644\n--- a/Documentation/git-worktree.txt\n+++ b/Documentation/git-worktree.txt\n@@ -48,8 +48,8 @@ add []::\n \n Create `` and checkout `` into it. The new working directory\n is linked to the current repository, sharing everything except working\n-directory specific files such as HEAD, index, etc. `-` may also be\n-specified as ``; it is synonymous with `@{-1}`.\n+directory specific files such as HEAD, index, etc. As a convenience,\n+`` may be a bare \"`-`\", which is synonymous with `@{-1}`.\n +\n If `` is a branch name (call it ``) and is not found,\n and neither `-b` nor `-B` nor `--detach` are used, but there does\n-- \n2.28.0.236.gb10cc79966\n\n"},{"id":"402692","messageId":"20200803161102.GB50799@syl.lan","threadId":"53971","inReplyTo":"20200803053612.50095-1-sunshine@sunshineco.com","subject":"Re: [PATCH 0/4] git-worktree documentation cleanups","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2020-08-03T16:11:02Z","receivedAt":"2020-08-03T16:11:07Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"Hi Eric,\n\nOn Mon, Aug 03, 2020 at 01:36:08AM -0400, Eric Sunshine wrote:\n> This series fixes some problems I ran across in the git-worktree\n> documentation while working on another worktree-related topic. Since\n> these fixes are distinct from that topic, I'm submitting them\n> separately.\n>\n> Eric Sunshine (4):\n> git-worktree.txt: employ fixed-width typeface consistently\n> git-worktree.txt: consistently use term \"working tree\"\n> git-worktree.txt: fix minor grammatical issues\n> git-worktree.txt: make start of new sentence more obvious\n>\n> Documentation/git-worktree.txt | 96 +++++++++++++++++-----------------\n> 1 file changed, 48 insertions(+), 48 deletions(-)\n\nAll looks good to me. Thanks.\n\n Reviewed-by: Taylor Blau \n\n> --\n> 2.28.0.236.gb10cc79966\n\nThanks,\nTaylor\n"},{"id":"402702","messageId":"xmqq3653wt17.fsf@gitster.c.googlers.com","threadId":"53971","inReplyTo":"20200803161102.GB50799@syl.lan","subject":"Re: [PATCH 0/4] git-worktree documentation cleanups","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2020-08-03T17:14:44Z","receivedAt":"2020-08-03T17:14:47Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Taylor Blau writes:\n\n> Hi Eric,\n>\n> On Mon, Aug 03, 2020 at 01:36:08AM -0400, Eric Sunshine wrote:\n>> This series fixes some problems I ran across in the git-worktree\n>> documentation while working on another worktree-related topic. Since\n>> these fixes are distinct from that topic, I'm submitting them\n>> separately.\n>>\n>> Eric Sunshine (4):\n>> git-worktree.txt: employ fixed-width typeface consistently\n>> git-worktree.txt: consistently use term \"working tree\"\n>> git-worktree.txt: fix minor grammatical issues\n>> git-worktree.txt: make start of new sentence more obvious\n>>\n>> Documentation/git-worktree.txt | 96 +++++++++++++++++-----------------\n>> 1 file changed, 48 insertions(+), 48 deletions(-)\n>\n> All looks good to me. Thanks.\n>\n> Reviewed-by: Taylor Blau \n\nYeah, they looked good to me, too. Thanks, both.\n"},{"id":"402708","messageId":"20200803175717.7465-1-martin.agren@gmail.com","threadId":"53971","inReplyTo":"20200803053612.50095-1-sunshine@sunshineco.com","subject":"Re: [PATCH 0/4] git-worktree documentation cleanups","fromName":"Martin Ågren","fromEmail":"martin.agren@gmail.com","sentAt":"2020-08-03T17:57:17Z","receivedAt":"2020-08-03T17:57:39Z","isPatch":true,"sender":{"key":"martin.agren@gmail.com","avatar":null},"body":"On Mon, 3 Aug 2020 at 07:39, Eric Sunshine wrote:\n>\n> This series fixes some problems I ran across in the git-worktree\n> documentation while working on another worktree-related topic. Since\n> these fixes are distinct from that topic, I'm submitting them\n> separately.\n\nAll of these look correct to me. Thanks for polishing the docs. Extra\nthanks for injecting a \"$\" where we talk about the actual value of an\nenvironment variable.\n\nI offer the following suggestions on top. If you agree with them, or\nsome of them, you might want to squash them into the various patches.\nBut it's not like these are critical, I don't think they need to block\nthis.\n\nMartin\n\ndiff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt\nindex 260bfe9105..2000a08075 100644\n--- a/Documentation/git-worktree.txt\n+++ b/Documentation/git-worktree.txt\n@@ -25,8 +25,8 @@ Manage multiple working trees attached to the same repository.\n A git repository can support multiple working trees, allowing you to check\n out more than one branch at a time. With `git worktree add` a new working\n tree is associated with the repository. This new working tree is called a\n-\"linked working tree\" as opposed to the \"main working tree\" prepared by \"git\n-init\" or \"git clone\". A repository has one main working tree (if it's not a\n+\"linked working tree\" as opposed to the \"main working tree\" prepared by linkgit:git-init[1]\n+or linkgit:git-clone[1]. A repository has one main working tree (if it's not a\n bare repository) and zero or more linked working trees. When you are done\n with a linked working tree, remove it with `git worktree remove`.\n \n@@ -48,7 +48,7 @@ add []::\n \n Create `` and checkout `` into it. The new working directory\n is linked to the current repository, sharing everything except working\n-directory specific files such as HEAD, index, etc. As a convenience,\n+directory specific files such as `HEAD`, `index`, etc. As a convenience,\n `` may be a bare \"`-`\", which is synonymous with `@{-1}`.\n +\n If `` is a branch name (call it ``) and is not found,\n@@ -72,7 +72,7 @@ linkgit:git-config[1].\n If `` is omitted and neither `-b` nor `-B` nor `--detach` used,\n then, as a convenience, the new working tree is associated with a branch\n (call it ``) named after `$(basename )`. If ``\n-doesn't exist, a new branch based on HEAD is automatically created as\n+doesn't exist, a new branch based on `HEAD` is automatically created as\n if `-b ` was given. If `` does exist, it will be\n checked out in the new working tree, if it's not checked out anywhere\n else, otherwise the command will refuse to create the working tree (unless\n@@ -137,13 +137,13 @@ To remove a locked working tree, specify `--force` twice.\n -B ::\n \tWith `add`, create a new branch named `` starting at\n \t``, and check out `` into the new working tree.\n-\tIf `` is omitted, it defaults to HEAD.\n+\tIf `` is omitted, it defaults to `HEAD`.\n \tBy default, `-b` refuses to create a new branch if it already\n \texists. `-B` overrides this safeguard, resetting `` to\n \t``.\n \n --detach::\n-\tWith `add`, detach HEAD in the new working tree. See \"DETACHED HEAD\"\n+\tWith `add`, detach `HEAD` in the new working tree. See \"DETACHED HEAD\"\n \tin linkgit:git-checkout[1].\n \n --[no-]checkout::\n@@ -154,7 +154,7 @@ To remove a locked working tree, specify `--force` twice.\n \n --[no-]guess-remote::\n \tWith `worktree add `, without ``, instead\n-\tof creating a new branch from HEAD, if there exists a tracking\n+\tof creating a new branch from `HEAD`, if there exists a tracking\n \tbranch in exactly one remote matching the basename of ``,\n \tbase the new branch on the remote-tracking branch, and mark\n \tthe remote-tracking branch as \"upstream\" from the new branch.\n@@ -166,7 +166,7 @@ This can also be set up as the default behaviour by using the\n \tWhen creating a new branch, if `` is a branch,\n \tmark it as \"upstream\" from the new branch. This is the\n \tdefault if `` is a remote-tracking branch. See\n-\t\"--track\" in linkgit:git-branch[1] for details.\n+\t`--track` in linkgit:git-branch[1] for details.\n \n --lock::\n \tKeep the working tree locked after creation. This is the\n@@ -185,14 +185,14 @@ This can also be set up as the default behaviour by using the\n \n -q::\n --quiet::\n-\tWith 'add', suppress feedback messages.\n+\tWith `add`, suppress feedback messages.\n \n -v::\n --verbose::\n \tWith `prune`, report all removals.\n \n --expire