Merge branch 'tr/doc-sh-setup'
authorJunio C Hamano <gitster@pobox.com>
Thu, 22 Dec 2011 23:30:29 +0000 (15:30 -0800)
committerJunio C Hamano <gitster@pobox.com>
Thu, 22 Dec 2011 23:30:29 +0000 (15:30 -0800)
* tr/doc-sh-setup:
  git-sh-setup: make require_clean_work_tree part of the interface

1  2 
Documentation/git-sh-setup.txt

@@@ -59,15 -58,20 +59,25 @@@ 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.
  
+ 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.