[PATCH v2] git-sh-setup: make require_clean_work_tree part of the interface
- From
Thomas Rast <trast@student.ethz.ch>
- Date
- Dec 20, 2011, 20:29 UTC
- Message-ID
- <23d761193dcf25f36206adc3d392e8578c566cd7.1324412815.git.trast@student.ethz.ch>
- In-Reply-To
- <7vwr9rjbaq.fsf@alter.siamese.dyndns.org>
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> --- Documentation/git-sh-setup.txt | 10 ++++++++++ 1 files changed, 10 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index a2f346c..9a0e574 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 associated with the repository + has 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.
-- 1.7.8.484.gdad4270