table of contents
other versions
- wheezy 1:1.7.10.4-1+wheezy3
- wheezy-backports 1:1.9.1-1~bpo70+2
- jessie 1:2.1.4-2.1+deb8u2
- jessie-backports 1:2.11.0-3~bpo8+1
- testing 1:2.11.0-3
- unstable 1:2.11.0-4
- experimental 1:2.13.1+next.20170610-1
GIT-SH-SETUP(1) | Git Manual | GIT-SH-SETUP(1) |
NAME¶
git-sh-setup - Common git shell script setup codeSYNOPSIS¶
. "$(git --exec-path)/git-sh-setup"
DESCRIPTION¶
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.FUNCTIONS¶
dieexit after emitting the supplied error message
to the standard error stream.
usage
die with the usage message.
set_reflog_action
set the message that will be recorded to
describe the end-user action in the reflog, when the script updates a
ref.
git_editor
runs an editor of user’s 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_repository
outputs 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_toplevel
runs chdir to the toplevel of the working
tree.
require_work_tree
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:
get_author_ident_from_commit
require_clean_work_tree rebase "Please commit or stash them."
outputs code for use with eval to set the
GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given
commit.
GIT¶
Part of the git(1) suite03/19/2016 | Git 1.7.10.4 |