All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v2 0/5] mh: worktree-related doc fixes
@ 2015-07-20  5:29 Eric Sunshine
  2015-07-20  5:29 ` [PATCH v2 1/5] Documentation/git-worktree: consistently use term "linked working tree" Eric Sunshine
                   ` (5 more replies)
  0 siblings, 6 replies; 9+ messages in thread
From: Eric Sunshine @ 2015-07-20  5:29 UTC (permalink / raw)
  To: git; +Cc: Michael Haggerty, Duy Nguyen, Junio C Hamano, Eric Sunshine

This re-roll of Michael Haggerty's worktree-related documentation
tweaks[1] takes my review comments into account and adds one new patch.
A v1 to v2 interdiff is included below.

Changes since v1:

patch 1/5: fix additional instances of "worktree" -> "working tree"

patch 2/5: don't rename "git worktree lock" command to "git worktree
    locked" when renaming incorrect worktrees/<id>/lock to
    worktrees/<id>/locked

patch 4/5: further refine .git/worktrees and .git/worktrees/<id>/locked
    descriptions

patch 5/5 (new/optional): based upon a review comment tangent, rename
    config variable gc.pruneWorktreesExpire to gc.worktreePruneExpire;
    can be dropped if not deemed worthwhile

A couple of Michael's v1 patches were also dropped:

patch 2/6: these changes are already in master: 4d5a3c5
    (Documentation/git-worktree: fix stale "git checkout --to"
    references, 2015-07-16)

patch 4/6: incorrectly dropped unimplemented user-interface command
    "git worktree lock" from BUGS section, conflating it with low-level
    locking functionality which is already implemented

A few commit messages were also reworded.

[1]: http://thread.gmane.org/gmane.comp.version-control.git/274190

Eric Sunshine (1):
  config: rename "gc.pruneWorktreesExpire" to "gc.worktreePruneExpire"

Michael Haggerty (4):
  Documentation/git-worktree: consistently use term "linked working
    tree"
  Documentation/git-worktree: fix incorrect reference to file "locked"
  Documentation/config: fix stale "git prune --worktree" reference
  Documentation/git-worktree: wordsmith worktree-related manpages

 Documentation/config.txt               | 12 +++++-----
 Documentation/git-worktree.txt         | 40 +++++++++++++++++-----------------
 Documentation/gitrepository-layout.txt | 22 +++++++++----------
 builtin/gc.c                           |  2 +-
 4 files changed, 38 insertions(+), 38 deletions(-)

-- 
2.5.0.rc2.386.g87d813d

---- 8< ----
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 10bc351..746d292 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1291,7 +1291,7 @@ gc.pruneExpire::
 	"now" may be used to disable this  grace period and always prune
 	unreachable objects immediately.
 
-gc.pruneWorktreesExpire::
+gc.worktreePruneExpire::
 	When 'git gc' is run, it calls
 	'git worktree prune --expire 3.months.ago'.
 	This config variable can be used to set a different grace
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index dfac758..3234459 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -3,7 +3,7 @@ git-worktree(1)
 
 NAME
 ----
-git-worktree - Manage multiple worktrees
+git-worktree - Manage multiple working trees
 
 
 SYNOPSIS
@@ -15,7 +15,7 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-Manage multiple worktrees attached to the same repository.
+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
@@ -27,7 +27,7 @@ bare repository) and zero or more linked working trees.
 When you are done with a linked working tree you can simply delete it.
 The working tree's administrative files in the repository (see
 "DETAILS" below) will eventually be removed automatically (see
-`gc.pruneworktreesexpire` in linkgit::git-config[1]), or you can run
+`gc.worktreePruneExpire` in linkgit::git-config[1]), or you can run
 `git worktree prune` in the main or any linked working tree to
 clean up any stale administrative files.
 
@@ -64,22 +64,22 @@ OPTIONS
 
 -f::
 --force::
-	By default, `add` refuses to create a new worktree when	`<branch>`
-	is already checked out by another worktree. This option overrides
+	By default, `add` refuses to create a new working tree when `<branch>`
+	is already checked out by another working tree. This option overrides
 	that safeguard.
 
 -b <new-branch>::
 -B <new-branch>::
 	With `add`, create a new branch named `<new-branch>` starting at
-	`<branch>`, and check out `<new-branch>` into the new worktree.
+	`<branch>`, and check out `<new-branch>` into the new working tree.
 	If `<branch>` is omitted, it defaults to HEAD.
 	By default, `-b` refuses to create a new branch if it already
 	exists. `-B` overrides this safeguard, resetting `<new-branch>` to
 	`<branch>`.
 
 --detach::
-	With `add`, detach HEAD in the new worktree. See "DETACHED HEAD" in
-	linkgit:git-checkout[1].
+	With `add`, detach HEAD in the new working tree. See "DETACHED HEAD"
+	in linkgit:git-checkout[1].
 
 -n::
 --dry-run::
@@ -91,7 +91,7 @@ OPTIONS
 	With `prune`, report all removals.
 
 --expire <time>::
-	With `prune`, only expire unused worktrees older than <time>.
+	With `prune`, only expire unused working trees older than <time>.
 
 DETAILS
 -------
@@ -138,9 +138,9 @@ EXAMPLES
 --------
 You are in the middle of a refactoring session and your boss comes in and
 demands that you fix something immediately. You might typically use
-linkgit:git-stash[1] to store your changes away temporarily; however, your
-worktree is in such a state of disarray (with new, moved, and removed files,
-and other bits and pieces strewn around) that you don't want to risk
+linkgit:git-stash[1] to store your changes away temporarily, however, your
+working tree is in such a state of disarray (with new, moved, and removed
+files, and other bits and pieces strewn around) that you don't want to risk
 disturbing any of it. Instead, you create a temporary linked working tree to
 make the emergency fix, remove it when done, and then resume your earlier
 refactoring session.
@@ -165,9 +165,11 @@ git-worktree could provide more automation for tasks currently
 performed manually, such as:
 
 - `remove` to remove a linked working tree and its administrative files (and
-  warn if the worktree is dirty)
-- `mv` to move or rename a worktree and update its administrative files
+  warn if the working tree is dirty)
+- `mv` to move or rename a working tree and update its administrative files
 - `list` to list linked working trees
+- `lock` to prevent automatic pruning of administrative files (for instance,
+  for a working tree on a portable device)
 
 GIT
 ---
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index fe7d4bb..577ee84 100644
--- a/Documentation/gitrepository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -251,8 +251,8 @@ modules::
 	Contains the git-repositories of the submodules.
 
 worktrees::
-	Contains worktree-specific information for linked working
-	trees. Each subdirectory contains the worktree-related
+	Contains administrative data for linked
+	working trees. Each subdirectory contains the working tree-related
 	part of a linked working tree. This directory is ignored if
 	$GIT_COMMON_DIR is set, in which case
 	"$GIT_COMMON_DIR/worktrees" will be used instead.
@@ -267,9 +267,9 @@ worktrees/<id>/gitdir::
 worktrees/<id>/locked::
 	If this file exists, the linked working tree may be on a
 	portable device and not available. The presence of this file
-	prevents `worktrees/<id>` from being pruned by `git worktree
-	prune`. The file may contain a string explaining why the
-	repository is locked.
+	prevents `worktrees/<id>` from being pruned either automatically
+	or manually by `git worktree prune`. The file may contain a string
+	explaining why the repository is locked.
 
 worktrees/<id>/link::
 	If this file exists, it is a hard link to the linked .git
diff --git a/builtin/gc.c b/builtin/gc.c
index 4957c39..bcc75d9 100644
--- a/builtin/gc.c
+++ b/builtin/gc.c
@@ -85,7 +85,7 @@ static void gc_config(void)
 	git_config_get_int("gc.autopacklimit", &gc_auto_pack_limit);
 	git_config_get_bool("gc.autodetach", &detach_auto);
 	git_config_date_string("gc.pruneexpire", &prune_expire);
-	git_config_date_string("gc.pruneworktreesexpire", &prune_worktrees_expire);
+	git_config_date_string("gc.worktreepruneexpire", &prune_worktrees_expire);
 	git_config(git_default_config, NULL);
 }
 
---- 8< ----

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

* [PATCH v2 1/5] Documentation/git-worktree: consistently use term "linked working tree"
  2015-07-20  5:29 [PATCH v2 0/5] mh: worktree-related doc fixes Eric Sunshine
@ 2015-07-20  5:29 ` Eric Sunshine
  2015-07-20  5:29 ` [PATCH v2 2/5] Documentation/git-worktree: fix incorrect reference to file "locked" Eric Sunshine
                   ` (4 subsequent siblings)
  5 siblings, 0 replies; 9+ messages in thread
From: Eric Sunshine @ 2015-07-20  5:29 UTC (permalink / raw)
  To: git; +Cc: Michael Haggerty, Duy Nguyen, Junio C Hamano, Eric Sunshine

From: Michael Haggerty <mhagger@alum.mit.edu>

Sometimes linked working trees were called "linked working
directories" or "linked worktrees". Always refer to them as "linked
working trees" for consistency.

[es: fix additional occurrences]

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/git-worktree.txt         | 36 +++++++++++++++++-----------------
 Documentation/gitrepository-layout.txt | 10 +++++-----
 2 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 3387e2f..60e5cf9 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -3,7 +3,7 @@ git-worktree(1)
 
 NAME
 ----
-git-worktree - Manage multiple worktrees
+git-worktree - Manage multiple working trees
 
 
 SYNOPSIS
@@ -15,7 +15,7 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-Manage multiple worktrees attached to the same repository.
+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
@@ -31,9 +31,9 @@ The working tree's administrative files in the repository (see
 `git worktree prune` in the main or any linked working tree to
 clean up any stale administrative files.
 
-If you move a linked working directory to another file system, or
+If you move a linked working tree to another file system, or
 within a file system that does not support hard links, you need to run
-at least one git command inside the linked working directory
+at least one git command inside the linked working tree
 (e.g. `git status`) in order to update its administrative files in the
 repository so that they do not get automatically pruned.
 
@@ -64,22 +64,22 @@ OPTIONS
 
 -f::
 --force::
-	By default, `add` refuses to create a new worktree when	`<branch>`
-	is already checked out by another worktree. This option overrides
+	By default, `add` refuses to create a new working tree when `<branch>`
+	is already checked out by another working tree. This option overrides
 	that safeguard.
 
 -b <new-branch>::
 -B <new-branch>::
 	With `add`, create a new branch named `<new-branch>` starting at
-	`<branch>`, and check out `<new-branch>` into the new worktree.
+	`<branch>`, and check out `<new-branch>` into the new working tree.
 	If `<branch>` is omitted, it defaults to HEAD.
 	By default, `-b` refuses to create a new branch if it already
 	exists. `-B` overrides this safeguard, resetting `<new-branch>` to
 	`<branch>`.
 
 --detach::
-	With `add`, detach HEAD in the new worktree. See "DETACHED HEAD" in
-	linkgit:git-checkout[1].
+	With `add`, detach HEAD in the new working tree. See "DETACHED HEAD"
+	in linkgit:git-checkout[1].
 
 -n::
 --dry-run::
@@ -91,7 +91,7 @@ OPTIONS
 	With `prune`, report all removals.
 
 --expire <time>::
-	With `prune`, only expire unused worktrees older than <time>.
+	With `prune`, only expire unused working trees older than <time>.
 
 DETAILS
 -------
@@ -139,9 +139,9 @@ EXAMPLES
 You are in the middle of a refactoring session and your boss comes in and
 demands that you fix something immediately. You might typically use
 linkgit:git-stash[1] to store your changes away temporarily, however, your
-worktree is in such a state of disarray (with new, moved, and removed files,
-and other bits and pieces strewn around) that you don't want to risk
-disturbing any of it. Instead, you create a temporary linked worktree to
+working tree is in such a state of disarray (with new, moved, and removed
+files, and other bits and pieces strewn around) that you don't want to risk
+disturbing any of it. Instead, you create a temporary linked working tree to
 make the emergency fix, remove it when done, and then resume your earlier
 refactoring session.
 
@@ -164,12 +164,12 @@ checkouts of a superproject.
 git-worktree could provide more automation for tasks currently
 performed manually, such as:
 
-- `remove` to remove a linked worktree and its administrative files (and
-  warn if the worktree is dirty)
-- `mv` to move or rename a worktree and update its administrative files
-- `list` to list linked worktrees
+- `remove` to remove a linked working tree and its administrative files (and
+  warn if the working tree is dirty)
+- `mv` to move or rename a working tree and update its administrative files
+- `list` to list linked working trees
 - `lock` to prevent automatic pruning of administrative files (for instance,
-  for a worktree on a portable device)
+  for a working tree on a portable device)
 
 GIT
 ---
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index 7173b38..b53979c 100644
--- a/Documentation/gitrepository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -251,9 +251,9 @@ modules::
 	Contains the git-repositories of the submodules.
 
 worktrees::
-	Contains worktree specific information of linked
-	checkouts. Each subdirectory contains the worktree-related
-	part of a linked checkout. This directory is ignored if
+	Contains working tree specific information of linked
+	working trees. Each subdirectory contains the working tree-related
+	part of a linked working tree. This directory is ignored if
 	$GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/worktrees" will be
 	used instead.
 
@@ -265,9 +265,9 @@ worktrees/<id>/gitdir::
 	updated every time the linked repository is accessed.
 
 worktrees/<id>/locked::
-	If this file exists, the linked repository may be on a
+	If this file exists, the linked working tree may be on a
 	portable device and not available. It does not mean that the
-	linked repository is gone and `worktrees/<id>` could be
+	linked working tree is gone and `worktrees/<id>` could be
 	removed. The file's content contains a reason string on why
 	the repository is locked.
 
-- 
2.5.0.rc2.386.g87d813d

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

* [PATCH v2 2/5] Documentation/git-worktree: fix incorrect reference to file "locked"
  2015-07-20  5:29 [PATCH v2 0/5] mh: worktree-related doc fixes Eric Sunshine
  2015-07-20  5:29 ` [PATCH v2 1/5] Documentation/git-worktree: consistently use term "linked working tree" Eric Sunshine
@ 2015-07-20  5:29 ` Eric Sunshine
  2015-07-20  5:29 ` [PATCH v2 3/5] Documentation/config: fix stale "git prune --worktree" reference Eric Sunshine
                   ` (3 subsequent siblings)
  5 siblings, 0 replies; 9+ messages in thread
From: Eric Sunshine @ 2015-07-20  5:29 UTC (permalink / raw)
  To: git; +Cc: Michael Haggerty, Duy Nguyen, Junio C Hamano, Eric Sunshine

From: Michael Haggerty <mhagger@alum.mit.edu>

The administrative file to suppress pruning is named "locked", not "lock".

[es: don't touch unrelated "git worktree lock" command; reword commit
message]

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/git-worktree.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 60e5cf9..a6d8ad7 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -39,7 +39,7 @@ repository so that they do not get automatically pruned.
 
 If a linked working tree is stored on a portable device or network share
 which is not always mounted, you can prevent its administrative files from
-being pruned by creating a file named 'lock' alongside the other
+being pruned by creating a file named 'locked' alongside the other
 administrative files, optionally containing a plain text reason that
 pruning should be suppressed. See section "DETAILS" for more information.
 
-- 
2.5.0.rc2.386.g87d813d

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

* [PATCH v2 3/5] Documentation/config: fix stale "git prune --worktree" reference
  2015-07-20  5:29 [PATCH v2 0/5] mh: worktree-related doc fixes Eric Sunshine
  2015-07-20  5:29 ` [PATCH v2 1/5] Documentation/git-worktree: consistently use term "linked working tree" Eric Sunshine
  2015-07-20  5:29 ` [PATCH v2 2/5] Documentation/git-worktree: fix incorrect reference to file "locked" Eric Sunshine
@ 2015-07-20  5:29 ` Eric Sunshine
  2015-07-20  5:29 ` [PATCH v2 4/5] Documentation/git-worktree: wordsmith worktree-related manpages Eric Sunshine
                   ` (2 subsequent siblings)
  5 siblings, 0 replies; 9+ messages in thread
From: Eric Sunshine @ 2015-07-20  5:29 UTC (permalink / raw)
  To: git; +Cc: Michael Haggerty, Duy Nguyen, Junio C Hamano, Eric Sunshine

From: Michael Haggerty <mhagger@alum.mit.edu>

This should have been changed to "git worktree prune" by df0b6cf
(worktree: new place for "git prune --worktrees", 2015-06-29)

[es: reword commit message]

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/config.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 3e37b93..7f65dbb 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1293,7 +1293,7 @@ gc.pruneExpire::
 
 gc.pruneWorktreesExpire::
 	When 'git gc' is run, it will call
-	'prune --worktrees --expire 3.months.ago'.
+	'git worktree prune --expire 3.months.ago'.
 	Override the grace period with this config variable. The value
 	"now" may be used to disable the grace period and prune
 	$GIT_DIR/worktrees immediately.
-- 
2.5.0.rc2.386.g87d813d

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

* [PATCH v2 4/5] Documentation/git-worktree: wordsmith worktree-related manpages
  2015-07-20  5:29 [PATCH v2 0/5] mh: worktree-related doc fixes Eric Sunshine
                   ` (2 preceding siblings ...)
  2015-07-20  5:29 ` [PATCH v2 3/5] Documentation/config: fix stale "git prune --worktree" reference Eric Sunshine
@ 2015-07-20  5:29 ` Eric Sunshine
  2015-07-20  5:29 ` [PATCH v2 5/5] config: rename "gc.pruneWorktreesExpire" to "gc.worktreePruneExpire" Eric Sunshine
  2015-07-20 15:31 ` [PATCH v2 0/5] mh: worktree-related doc fixes Michael Haggerty
  5 siblings, 0 replies; 9+ messages in thread
From: Eric Sunshine @ 2015-07-20  5:29 UTC (permalink / raw)
  To: git; +Cc: Michael Haggerty, Duy Nguyen, Junio C Hamano, Eric Sunshine

From: Michael Haggerty <mhagger@alum.mit.edu>

[es: reword .git/worktrees and .git/worktrees/<id>/locked descriptions]

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/config.txt               |  8 ++++----
 Documentation/gitrepository-layout.txt | 16 ++++++++--------
 2 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 7f65dbb..10bc351 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1292,11 +1292,11 @@ gc.pruneExpire::
 	unreachable objects immediately.
 
 gc.pruneWorktreesExpire::
-	When 'git gc' is run, it will call
+	When 'git gc' is run, it calls
 	'git worktree prune --expire 3.months.ago'.
-	Override the grace period with this config variable. The value
-	"now" may be used to disable the grace period and prune
-	$GIT_DIR/worktrees immediately.
+	This config variable can be used to set a different grace
+	period. The value "now" may be used to disable the grace
+	period and prune $GIT_DIR/worktrees immediately.
 
 gc.reflogExpire::
 gc.<pattern>.reflogExpire::
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index b53979c..577ee84 100644
--- a/Documentation/gitrepository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -251,25 +251,25 @@ modules::
 	Contains the git-repositories of the submodules.
 
 worktrees::
-	Contains working tree specific information of linked
+	Contains administrative data for linked
 	working trees. Each subdirectory contains the working tree-related
 	part of a linked working tree. This directory is ignored if
-	$GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/worktrees" will be
-	used instead.
+	$GIT_COMMON_DIR is set, in which case
+	"$GIT_COMMON_DIR/worktrees" will be used instead.
 
 worktrees/<id>/gitdir::
 	A text file containing the absolute path back to the .git file
 	that points to here. This is used to check if the linked
 	repository has been manually removed and there is no need to
-	keep this directory any more. mtime of this file should be
+	keep this directory any more. The mtime of this file should be
 	updated every time the linked repository is accessed.
 
 worktrees/<id>/locked::
 	If this file exists, the linked working tree may be on a
-	portable device and not available. It does not mean that the
-	linked working tree is gone and `worktrees/<id>` could be
-	removed. The file's content contains a reason string on why
-	the repository is locked.
+	portable device and not available. The presence of this file
+	prevents `worktrees/<id>` from being pruned either automatically
+	or manually by `git worktree prune`. The file may contain a string
+	explaining why the repository is locked.
 
 worktrees/<id>/link::
 	If this file exists, it is a hard link to the linked .git
-- 
2.5.0.rc2.386.g87d813d

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

* [PATCH v2 5/5] config: rename "gc.pruneWorktreesExpire" to "gc.worktreePruneExpire"
  2015-07-20  5:29 [PATCH v2 0/5] mh: worktree-related doc fixes Eric Sunshine
                   ` (3 preceding siblings ...)
  2015-07-20  5:29 ` [PATCH v2 4/5] Documentation/git-worktree: wordsmith worktree-related manpages Eric Sunshine
@ 2015-07-20  5:29 ` Eric Sunshine
  2015-07-20 15:31 ` [PATCH v2 0/5] mh: worktree-related doc fixes Michael Haggerty
  5 siblings, 0 replies; 9+ messages in thread
From: Eric Sunshine @ 2015-07-20  5:29 UTC (permalink / raw)
  To: git; +Cc: Michael Haggerty, Duy Nguyen, Junio C Hamano, Eric Sunshine

As of df0b6cf (worktree: new place for "git prune --worktrees",
2015-06-29), linked worktree pruning functionality moved from
"git prune --worktrees" to "git worktree prune". Rename the
associated configuration variable accordingly.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---

I'm not convinced this is worth the churn. Can be easily dropped if not
deemed worthwhile.

 Documentation/config.txt       | 2 +-
 Documentation/git-worktree.txt | 2 +-
 builtin/gc.c                   | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 10bc351..746d292 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1291,7 +1291,7 @@ gc.pruneExpire::
 	"now" may be used to disable this  grace period and always prune
 	unreachable objects immediately.
 
-gc.pruneWorktreesExpire::
+gc.worktreePruneExpire::
 	When 'git gc' is run, it calls
 	'git worktree prune --expire 3.months.ago'.
 	This config variable can be used to set a different grace
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index a6d8ad7..3234459 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -27,7 +27,7 @@ bare repository) and zero or more linked working trees.
 When you are done with a linked working tree you can simply delete it.
 The working tree's administrative files in the repository (see
 "DETAILS" below) will eventually be removed automatically (see
-`gc.pruneworktreesexpire` in linkgit::git-config[1]), or you can run
+`gc.worktreePruneExpire` in linkgit::git-config[1]), or you can run
 `git worktree prune` in the main or any linked working tree to
 clean up any stale administrative files.
 
diff --git a/builtin/gc.c b/builtin/gc.c
index 4957c39..bcc75d9 100644
--- a/builtin/gc.c
+++ b/builtin/gc.c
@@ -85,7 +85,7 @@ static void gc_config(void)
 	git_config_get_int("gc.autopacklimit", &gc_auto_pack_limit);
 	git_config_get_bool("gc.autodetach", &detach_auto);
 	git_config_date_string("gc.pruneexpire", &prune_expire);
-	git_config_date_string("gc.pruneworktreesexpire", &prune_worktrees_expire);
+	git_config_date_string("gc.worktreepruneexpire", &prune_worktrees_expire);
 	git_config(git_default_config, NULL);
 }
 
-- 
2.5.0.rc2.386.g87d813d

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

* Re: [PATCH v2 0/5] mh: worktree-related doc fixes
  2015-07-20  5:29 [PATCH v2 0/5] mh: worktree-related doc fixes Eric Sunshine
                   ` (4 preceding siblings ...)
  2015-07-20  5:29 ` [PATCH v2 5/5] config: rename "gc.pruneWorktreesExpire" to "gc.worktreePruneExpire" Eric Sunshine
@ 2015-07-20 15:31 ` Michael Haggerty
  2015-07-24  0:10   ` Eric Sunshine
  5 siblings, 1 reply; 9+ messages in thread
From: Michael Haggerty @ 2015-07-20 15:31 UTC (permalink / raw)
  To: Eric Sunshine, git; +Cc: Duy Nguyen, Junio C Hamano

On 07/19/2015 10:29 PM, Eric Sunshine wrote:
> This re-roll of Michael Haggerty's worktree-related documentation
> tweaks[1] takes my review comments into account and adds one new patch.

Eric,

Thanks for separating the wheat from the chaff. I'm still traveling,
which I'll claim as an excuse for my poor responsiveness.

All of your changes look good.

I was wondering one thing: is there a value like "never" or "false" to
which "gc.worktreepruneexpire" can be set to turn off pruning entirely?
If so, it might be nice to mention it in the config manpage. Similarly
for the other expiration grace time settings.

But it's definitely not a blocker.

Michael

-- 
Michael Haggerty
mhagger@alum.mit.edu

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

* Re: [PATCH v2 0/5] mh: worktree-related doc fixes
  2015-07-20 15:31 ` [PATCH v2 0/5] mh: worktree-related doc fixes Michael Haggerty
@ 2015-07-24  0:10   ` Eric Sunshine
  2015-07-24  0:51     ` Junio C Hamano
  0 siblings, 1 reply; 9+ messages in thread
From: Eric Sunshine @ 2015-07-24  0:10 UTC (permalink / raw)
  To: Michael Haggerty; +Cc: Git List, Duy Nguyen, Junio C Hamano

On Mon, Jul 20, 2015 at 11:31 AM, Michael Haggerty <mhagger@alum.mit.edu> wrote:
> On 07/19/2015 10:29 PM, Eric Sunshine wrote:
>> This re-roll of Michael Haggerty's worktree-related documentation
>> tweaks[1] takes my review comments into account and adds one new patch.
>
> Thanks for separating the wheat from the chaff. I'm still traveling,
> which I'll claim as an excuse for my poor responsiveness.
>
> All of your changes look good.
>
> I was wondering one thing: is there a value like "never" or "false" to
> which "gc.worktreepruneexpire" can be set to turn off pruning entirely?
> If so, it might be nice to mention it in the config manpage. Similarly
> for the other expiration grace time settings.
> But it's definitely not a blocker.

I browsed the code for the various "expire" settings, and it appears
that they all accept and respect "now" and "never", as well, so I'll
put together a patch as suggested.

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

* Re: [PATCH v2 0/5] mh: worktree-related doc fixes
  2015-07-24  0:10   ` Eric Sunshine
@ 2015-07-24  0:51     ` Junio C Hamano
  0 siblings, 0 replies; 9+ messages in thread
From: Junio C Hamano @ 2015-07-24  0:51 UTC (permalink / raw)
  To: Eric Sunshine; +Cc: Michael Haggerty, Git List, Duy Nguyen

Eric Sunshine <sunshine@sunshineco.com> writes:

> On Mon, Jul 20, 2015 at 11:31 AM, Michael Haggerty <mhagger@alum.mit.edu> wrote:
>> On 07/19/2015 10:29 PM, Eric Sunshine wrote:
>>> This re-roll of Michael Haggerty's worktree-related documentation
>>> tweaks[1] takes my review comments into account and adds one new patch.
>>
>> Thanks for separating the wheat from the chaff. I'm still traveling,
>> which I'll claim as an excuse for my poor responsiveness.
>>
>> All of your changes look good.
>>
>> I was wondering one thing: is there a value like "never" or "false" to
>> which "gc.worktreepruneexpire" can be set to turn off pruning entirely?
>> If so, it might be nice to mention it in the config manpage. Similarly
>> for the other expiration grace time settings.
>> But it's definitely not a blocker.
>
> I browsed the code for the various "expire" settings, and it appears
> that they all accept and respect "now" and "never", as well, so I'll
> put together a patch as suggested.

Sounds good; thanks.

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

end of thread, other threads:[~2015-07-24  0:52 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-07-20  5:29 [PATCH v2 0/5] mh: worktree-related doc fixes Eric Sunshine
2015-07-20  5:29 ` [PATCH v2 1/5] Documentation/git-worktree: consistently use term "linked working tree" Eric Sunshine
2015-07-20  5:29 ` [PATCH v2 2/5] Documentation/git-worktree: fix incorrect reference to file "locked" Eric Sunshine
2015-07-20  5:29 ` [PATCH v2 3/5] Documentation/config: fix stale "git prune --worktree" reference Eric Sunshine
2015-07-20  5:29 ` [PATCH v2 4/5] Documentation/git-worktree: wordsmith worktree-related manpages Eric Sunshine
2015-07-20  5:29 ` [PATCH v2 5/5] config: rename "gc.pruneWorktreesExpire" to "gc.worktreePruneExpire" Eric Sunshine
2015-07-20 15:31 ` [PATCH v2 0/5] mh: worktree-related doc fixes Michael Haggerty
2015-07-24  0:10   ` Eric Sunshine
2015-07-24  0:51     ` Junio C Hamano

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.