summaryrefslogtreecommitdiff
path: root/Documentation/git-sh-setup.txt
blob: 1ea1faa1b57adecea4269fa6d0c2c4afdee9b3da (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
git-sh-setup(1)
===============
 
NAME
----
git-sh-setup - Common git shell script setup code
 
SYNOPSIS
--------
'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.
 
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 repository is a bare repository, and dies
	if so.  Used by scripts that require working tree
	(e.g. `checkout`).
 
 
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
 
Documentation
--------------
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
GIT
---
Part of the gitlink:git[7] suite