1git-sh-setup(1) 2=============== 3 4NAME 5---- 6git-sh-setup - Common git shell script setup code 7 8SYNOPSIS 9-------- 10'. "$(git --exec-path)/git-sh-setup"' 11 12DESCRIPTION 13----------- 14 15This is not a command the end user would want to run. Ever. 16This documentation is meant for people who are studying the 17Porcelain-ish scripts and/or are writing new ones. 18 19The 'git sh-setup' scriptlet is designed to be sourced (using 20`.`) by other shell scripts to set up some variables pointing at 21the normal git directories and a few helper shell functions. 22 23Before sourcing it, your script should set up a few variables; 24`USAGE` (and `LONG_USAGE`, if any) is used to define message 25given by `usage()` shell function. `SUBDIRECTORY_OK` can be set 26if the script can run from a subdirectory of the working tree 27(some commands do not). 28 29The scriptlet sets `GIT_DIR` and `GIT_OBJECT_DIRECTORY` shell 30variables, but does *not* export them to the environment. 31 32FUNCTIONS 33--------- 34 35die:: 36 exit after emitting the supplied error message to the 37 standard error stream. 38 39usage:: 40 die with the usage message. 41 42set_reflog_action:: 43 set the message that will be recorded to describe the 44 end-user action in the reflog, when the script updates a 45 ref. 46 47git_editor:: 48 runs an editor of user's choice (GIT_EDITOR, core.editor, VISUAL or 49 EDITOR) on a given file, but error out if no editor is specified 50 and the terminal is dumb. 51 52is_bare_repository:: 53 outputs `true` or `false` to the standard output stream 54 to indicate if the repository is a bare repository 55 (i.e. without an associated working tree). 56 57cd_to_toplevel:: 58 runs chdir to the toplevel of the working tree. 59 60require_work_tree:: 61 checks if the repository is a bare repository, and dies 62 if so. Used by scripts that require working tree 63 (e.g. `checkout`). 64 65get_author_ident_from_commit:: 66 outputs code for use with eval to set the GIT_AUTHOR_NAME, 67 GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit. 68 69 70Author 71------ 72Written by Linus Torvalds <torvalds@osdl.org> 73 74Documentation 75-------------- 76Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. 77 78GIT 79--- 80Part of the linkgit:git[1] suite