git-sh-setup - Common git shell script setup code
. "$(git --exec-path)/git-sh-setup"
This is not a command the end user would want to run. Ever. This documentation is meant for people who are studying the Porcelain-ish scripts and/or are writing new ones.
The git sh-setup scriptlet is designed to be sourced (using .) by other shell scripts to set up some variables pointing at the normal git directories and a few helper shell functions.
Before sourcing it, your script should set up a few variables; USAGE (and LONG_USAGE, if any) is used to define message given by usage() shell function. SUBDIRECTORY_OK can be set if the script can run from a subdirectory of the working tree (some commands do not).
The scriptlet sets GIT_DIR and GIT_OBJECT_DIRECTORY shell variables, but does not export them to the environment.
dieexit after emitting the supplied error message to the standard error stream.
usagedie with the usage message.
set_reflog_actionset the message that will be recorded to describe the end-user action in the reflog, when the script updates a ref.
git_editorruns an editor of users choice (GIT_EDITOR, core.editor, VISUAL or EDITOR) on a given file, but error out if no editor is specified and the terminal is dumb.
is_bare_repositoryoutputs true or false to the standard output stream to indicate if the repository is a bare repository (i.e. without an associated working tree).
cd_to_toplevelruns chdir to the toplevel of the working tree.
require_work_treechecks if the current directory is within the working tree of the repository, and otherwise dies.
require_work_tree_existschecks 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_commitoutputs code for use with eval to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.
Part of the git(1) suite
|Git 22.214.171.124||GIT-SH-SETUP (1)||11/24/2012|