]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-sh-setup(1) |
2 | =============== | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
7bd7f280 | 6 | git-sh-setup - Common git shell script setup code |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
215a7ad1 | 10 | 'git-sh-setup' |
7fc9d69f JH |
11 | |
12 | DESCRIPTION | |
13 | ----------- | |
7fc9d69f | 14 | |
850844e2 JH |
15 | This is not a command the end user would want to run. Ever. |
16 | This documentation is meant for people who are studying the | |
17 | Porcelain-ish scripts and/or are writing new ones. | |
18 | ||
19 | The `git-sh-setup` scriptlet is designed to be sourced (using | |
20 | `.`) by other shell scripts to set up some variables pointing at | |
21 | the normal git directories and a few helper shell functions. | |
22 | ||
23 | Before sourcing it, your script should set up a few variables; | |
24 | `USAGE` (and `LONG_USAGE`, if any) is used to define message | |
25 | given by `usage()` shell function. `SUBDIRECTORY_OK` can be set | |
26 | if the script can run from a subdirectory of the working tree | |
27 | (some commands do not). | |
28 | ||
29 | The scriptlet sets `GIT_DIR` and `GIT_OBJECT_DIRECTORY` shell | |
30 | variables, but does *not* export them to the environment. | |
31 | ||
32 | FUNCTIONS | |
33 | --------- | |
34 | ||
35 | die:: | |
36 | exit after emitting the supplied error message to the | |
37 | standard error stream. | |
38 | ||
39 | usage:: | |
40 | die with the usage message. | |
41 | ||
42 | set_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 | ||
47 | is_bare_repository:: | |
48 | outputs `true` or `false` to the standard output stream | |
49 | to indicate if the repository is a bare repository | |
50 | (i.e. without an associated working tree). | |
51 | ||
52 | cd_to_toplevel:: | |
53 | runs chdir to the toplevel of the working tree. | |
54 | ||
55 | require_work_tree:: | |
56 | checks if the repository is a bare repository, and dies | |
57 | if so. Used by scripts that require working tree | |
58 | (e.g. `checkout`). | |
59 | ||
7fc9d69f JH |
60 | |
61 | Author | |
62 | ------ | |
63 | Written by Linus Torvalds <torvalds@osdl.org> | |
64 | ||
65 | Documentation | |
66 | -------------- | |
67 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
68 | ||
69 | GIT | |
70 | --- | |
a7154e91 | 71 | Part of the gitlink:git[7] suite |