summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-12-28 19:42:51 (GMT)
committerJunio C Hamano <gitster@pobox.com>2011-12-28 19:42:51 (GMT)
commit00754b20f931e0e85fe12e59111cf250d51d288b (patch)
tree5b5d0f5befb6b8ffed07af82faeb49e67d0c437d /Documentation
parentb42e81afe2d98faee7728ef02a558847fd08cf90 (diff)
parentd577cd216e0adb9cbc726dddd1a0858b4ab4e6e3 (diff)
downloadgit-00754b20f931e0e85fe12e59111cf250d51d288b.zip
git-00754b20f931e0e85fe12e59111cf250d51d288b.tar.gz
git-00754b20f931e0e85fe12e59111cf250d51d288b.tar.bz2
Merge branch 'tr/doc-sh-setup' into maint
* tr/doc-sh-setup: git-sh-setup: make require_clean_work_tree part of the interface
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-sh-setup.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index a2f346c..5e5f1c8 100644
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -68,6 +68,16 @@ require_work_tree_exists::
cd_to_toplevel, which is impossible to do if there is no
working tree.
+require_clean_work_tree <action> [<hint>]::
+ checks that the working tree and index associated with the
+ repository have no uncommitted changes to tracked files.
+ Otherwise it emits an error message of the form `Cannot
+ <action>: <reason>. <hint>`, and dies. Example:
++
+----------------
+require_clean_work_tree rebase "Please commit or stash them."
+----------------
+
get_author_ident_from_commit::
outputs code for use with eval to set the GIT_AUTHOR_NAME,
GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.