Merge branch 'nd/maint-relative' into maint
[gitweb.git] / Documentation / git-sh-setup.txt
index 2b2abebd608be337db35a3de4b83d37d43061acb..3da241304b0d2fdaa376bca740beb024a36b2cb6 100644 (file)
@@ -7,7 +7,7 @@ git-sh-setup - Common git shell script setup code
 
 SYNOPSIS
 --------
-'git-sh-setup'
+'. "$(git --exec-path)/git-sh-setup"'
 
 DESCRIPTION
 -----------
@@ -16,7 +16,7 @@ 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
+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.
 
@@ -44,6 +44,11 @@ set_reflog_action::
        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
@@ -57,6 +62,10 @@ require_work_tree::
        if so.  Used by scripts that require working tree
        (e.g. `checkout`).
 
+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.
+
 
 Author
 ------
@@ -68,5 +77,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite