aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-05-26 10:31:47 -0700
committerJunio C Hamano <gitster@pobox.com>2011-05-26 10:31:47 -0700
commit0a2a5d889dcd0982de31e1d4faee3242854d7b9d (patch)
tree76982d8341e539d7280990a7dd7df8181c94702a /Documentation
parent1dcfb2ac65cec5a706784d92523f0c53de0a8d95 (diff)
parente2eb527345d48881dac0d88e6bdfc0a267a2eb62 (diff)
downloadgit-0a2a5d889dcd0982de31e1d4faee3242854d7b9d.tar.gz
git-0a2a5d889dcd0982de31e1d4faee3242854d7b9d.tar.xz
Merge branch 'jc/require-work-tree-exists'
* jc/require-work-tree-exists: require-work-tree wants more than what its name says
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-sh-setup.txt11
1 files changed, 8 insertions, 3 deletions
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index 053df505b..27fd8ba85 100644
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -58,9 +58,14 @@ cd_to_toplevel::
runs chdir to the toplevel of the working tree.
require_work_tree::
- checks if the repository is a bare repository, and dies
- if so. Used by scripts that require working tree
- (e.g. `checkout`).
+ checks if the current directory is within the working tree
+ of the repository, and otherwise dies.
+
+require_work_tree_exists::
+ checks if the working tree associated with the repository
+ exists, and otherwise dies. Often done before calling
+ cd_to_toplevel, which is impossible to do if there is no
+ working tree.
get_author_ident_from_commit::
outputs code for use with eval to set the GIT_AUTHOR_NAME,