blob: 5e5f1c89646cf4389bfd30ba8e90eb0552e80aab (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
git-sh-setup(1)
===============
NAME
----
git-sh-setup - Common git shell script setup code
SYNOPSIS
--------
[verse]
'. "$(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.
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.
FUNCTIONS
---------
die::
exit 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:
+
----------------
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.
GIT
---
Part of the linkgit:git[1] suite
|
