git-sh-setup: make require_clean_work_tree part of the interface
92c62a3 (Porcelain scripts: Rewrite cryptic "needs update" error message, 2010-10-19) refactored git's own checking to a function in git-sh-setup. This is a very useful thing for script writers, so document it. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Thomas Rast committed
Dec 20, 2011 at 22:42 UTC
d577cd216e0adb9cbc726dddd1a0858b4ab4e6e3
1 file changed
+10
Documentation/git-sh-setup.txt
+10
@@ -62,6 +62,16 @@ require_work_tree::
62
if so. Used by scripts that require working tree
63
(e.g. `checkout`).
64
65
+require_clean_work_tree <action> [<hint>]::
66
+ checks that the working tree and index associated with the
67
+ repository have no uncommitted changes to tracked files.
68
+ Otherwise it emits an error message of the form `Cannot
69
+ <action>: <reason>. <hint>`, and dies. Example:
70
++
71
+----------------
72
+require_clean_work_tree rebase "Please commit or stash them."
73
+----------------
74
+
75
get_author_ident_from_commit::
76
outputs code for use with eval to set the GIT_AUTHOR_NAME,
77
GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.