Re: [PATCH 1/2] git-sh-setup: make require_clean_work_tree part of the interface

From: Junio C Hamano <gitster@pobox.com>
Date: Dec 20, 2011, 19:25 UTC
Message-ID: <7vwr9rjbaq.fsf@alter.siamese.dyndns.org>
In-Reply-To: <c53feb0de8006c205fd26c2c07dcd78bd86b6c24.1324378986.git.trast@student.ethz.ch>

Thomas Rast <trast@student.ethz.ch> writes:

> 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.

Can we avoid explaining "clean" with the same word "clean", which adds no new information? IOW, what does "clean" mean in the context of this helper shell function? No untracked cruft? No un-added changes? What are the kind of dirtiness being checked?

Show 12 quoted lines

> +require_clean_work_tree <action> [<hint>]::
> +	checks if the working tree associated with the repository is
> +	clean.  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.