diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2011-12-22 15:30:29 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2011-12-22 15:30:29 -0800 |
| commit | f0ede8435ab161b3aba3e5e306239d6bd74dd9b8 (patch) | |
| tree | b0e0279f02ef77ab26bf66351f1f67a361092e23 | |
| parent | Merge branch 'rr/revert-cherry-pick' (diff) | |
| parent | git-sh-setup: make require_clean_work_tree part of the interface (diff) | |
| download | tgif-f0ede8435ab161b3aba3e5e306239d6bd74dd9b8.tar.xz | |
Merge branch 'tr/doc-sh-setup'
* tr/doc-sh-setup:
git-sh-setup: make require_clean_work_tree part of the interface
| -rw-r--r-- | 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 a2f346ca71..5e5f1c8964 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. |