[PATCH 6/6] worktree: wordsmith worktree-related manpages
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
Documentation/config.txt | 8 ++++----
Documentation/git-worktree.txt | 2 +-
Documentation/gitrepository-layout.txt | 18 +++++++++---------
3 files changed, 14 insertions(+), 14 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/git-worktree.txt b/Documentation/git-worktree.txt
index d5aeda0..cecb44c 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -138,7 +138,7 @@ 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
+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 working tree to
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index fe7fa96..fe7d4bb 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 worktree specific information of linked
- working trees. Each subdirectory contains the worktree-related
+ Contains worktree-specific information for linked working
+ trees. Each subdirectory contains the worktree-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 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.1.4
Michael Haggerty <mhagger@alum.mit.edu>