githooks.txt: minor improvements to the grammar & phrasing
[git/git.git] / environment.c
CommitLineData
e1b10391
LT
1/*
2 * We put all the git config variables in this same object
3 * file, so that programs can link against the config parser
4 * without having to link against all the rest of git.
5 *
6 * In particular, no need to bring in libz etc unless needed,
7 * even if you might want to know where the git directory etc
8 * are.
9 */
10#include "cache.h"
a1bea2c1 11#include "refs.h"
273c7032 12#include "fmt-merge-msg.h"
069c0532 13#include "commit.h"
e1b10391 14
e1b10391 15int trust_executable_bit = 1;
1ce4790b 16int trust_ctime = 1;
c08e4d5b 17int check_stat = 1;
78a8d641 18int has_symlinks = 1;
dce96489 19int minimum_abbrev = 4, default_abbrev = 7;
0a9b88b7 20int ignore_case;
96f1e58f
DR
21int assume_unchanged;
22int prefer_symlink_refs;
7d1864ce 23int is_bare_repository_cfg = -1; /* unspecified */
510c5a8e 24int log_all_ref_updates = -1; /* unspecified */
1b371f56 25int warn_ambiguous_refs = 1;
25fba78d 26int warn_on_object_refname_ambiguity = 1;
49672f26 27int ref_paranoia = -1;
96f1e58f 28int repository_format_version;
067fbd41 29int repository_format_precious_objects;
1a8f2741 30const char *git_commit_encoding;
3a55602e 31const char *git_log_output_encoding;
94df2506 32int shared_repository = PERM_UMASK;
96f1e58f 33const char *apply_default_whitespace;
86c91f91 34const char *apply_default_ignorewhitespace;
64589a03 35const char *git_attributes_file;
960ccca6
DH
36int zlib_compression_level = Z_BEST_SPEED;
37int core_compression_level;
38int core_compression_seen;
aafe9fba 39int fsync_object_files;
8c82534d
SP
40size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
41size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
4874f544 42size_t delta_base_cache_limit = 96 * 1024 * 1024;
15366280 43unsigned long big_file_threshold = 512 * 1024 * 1024;
872da32d 44const char *pager_program;
aa086eb8 45int pager_use_color = 1;
ee9601e6 46const char *editor_program;
d3e7da89 47const char *askpass_program;
dfb068be 48const char *excludes_file;
fd6cce9e 49enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
afc711b8 50int check_replace_refs = 1;
58d121b2 51char *git_replace_ref_base;
ec70f52f 52enum eol core_eol = EOL_UNSET;
21e5ad50 53enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
cf1b7869 54unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
9ed36cfa 55enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
c998ae9b 56enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
f25950f3 57enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
348df166
JS
58#ifndef OBJECT_CREATION_MODE
59#define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
be66a6c4 60#endif
348df166 61enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
a97a7468 62char *notes_ref_name;
7f3140cd 63int grafts_replace_parents = 1;
08aefc9e 64int core_apply_sparse_checkout;
898eacd8 65int merge_log_config = -1;
76759c7d 66int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
e37c1329 67struct startup_info *startup_info;
568508e7 68unsigned long pack_size_limit_cfg;
e1b10391 69
a42643aa
JK
70#ifndef PROTECT_HFS_DEFAULT
71#define PROTECT_HFS_DEFAULT 0
72#endif
73int protect_hfs = PROTECT_HFS_DEFAULT;
74
2b4c6efc
JS
75#ifndef PROTECT_NTFS_DEFAULT
76#define PROTECT_NTFS_DEFAULT 0
77#endif
78int protect_ntfs = PROTECT_NTFS_DEFAULT;
79
eff80a9f
JH
80/*
81 * The character that begins a commented line in user-editable file
82 * that is subject to stripspace.
83 */
84char comment_line_char = '#';
84c9dc2c 85int auto_comment_line_char;
eff80a9f 86
671c9b7e 87/* Parallel index stat data preload? */
299e2987 88int core_preload_index = 1;
671c9b7e 89
dae6c322
CC
90/*
91 * This is a hack for test programs like test-dump-untracked-cache to
92 * ensure that they do not modify the untracked cache when reading it.
93 * Do not use it otherwise!
94 */
95int ignore_untracked_cache_config;
96
e90fdc39
JS
97/* This is set by setup_git_dir_gently() and/or git_default_config() */
98char *git_work_tree_cfg;
19757d80 99static char *work_tree;
e90fdc39 100
a1bea2c1
JT
101static const char *namespace;
102static size_t namespace_len;
103
c7b3a3d2 104static const char *git_dir, *git_common_dir;
7f7868ea 105static char *git_object_dir, *git_index_file, *git_graft_file;
c7b3a3d2 106int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
c5fba16c 107
48a7c1c4 108/*
2163e5db 109 * Repository-local GIT_* environment variables; see cache.h for details.
48a7c1c4 110 */
2163e5db 111const char * const local_repo_env[] = {
48a7c1c4
GB
112 ALTERNATE_DB_ENVIRONMENT,
113 CONFIG_ENVIRONMENT,
655e8d9c 114 CONFIG_DATA_ENVIRONMENT,
48a7c1c4
GB
115 DB_ENVIRONMENT,
116 GIT_DIR_ENVIRONMENT,
117 GIT_WORK_TREE_ENVIRONMENT,
2cd83d10 118 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
48a7c1c4
GB
119 GRAFT_ENVIRONMENT,
120 INDEX_ENVIRONMENT,
121 NO_REPLACE_OBJECTS_ENVIRONMENT,
58d121b2 122 GIT_REPLACE_REF_BASE_ENVIRONMENT,
a6f7f9a3 123 GIT_PREFIX_ENVIRONMENT,
069c0532 124 GIT_SHALLOW_FILE_ENVIRONMENT,
c7b3a3d2 125 GIT_COMMON_DIR_ENVIRONMENT,
48a7c1c4
GB
126 NULL
127};
128
a1bea2c1
JT
129static char *expand_namespace(const char *raw_namespace)
130{
131 struct strbuf buf = STRBUF_INIT;
132 struct strbuf **components, **c;
133
134 if (!raw_namespace || !*raw_namespace)
135 return xstrdup("");
136
137 strbuf_addstr(&buf, raw_namespace);
138 components = strbuf_split(&buf, '/');
139 strbuf_reset(&buf);
140 for (c = components; *c; c++)
141 if (strcmp((*c)->buf, "/") != 0)
142 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
143 strbuf_list_free(components);
8d9c5010 144 if (check_refname_format(buf.buf, 0))
a1bea2c1
JT
145 die("bad git namespace path \"%s\"", raw_namespace);
146 strbuf_addch(&buf, '/');
147 return strbuf_detach(&buf, NULL);
148}
149
c7b3a3d2
NTND
150static char *git_path_from_env(const char *envvar, const char *git_dir,
151 const char *path, int *fromenv)
cb6c38d5
JK
152{
153 const char *value = getenv(envvar);
75faa45a
JK
154 if (!value)
155 return xstrfmt("%s/%s", git_dir, path);
557bd833
NTND
156 if (fromenv)
157 *fromenv = 1;
158 return xstrdup(value);
cb6c38d5
JK
159}
160
e1b10391
LT
161static void setup_git_env(void)
162{
31e26ebc 163 struct strbuf sb = STRBUF_INIT;
487a2b73 164 const char *gitfile;
069c0532 165 const char *shallow_file;
58d121b2 166 const char *replace_ref_base;
487a2b73 167
e1b10391
LT
168 git_dir = getenv(GIT_DIR_ENVIRONMENT);
169 if (!git_dir)
170 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
487a2b73
NTND
171 gitfile = read_gitfile(git_dir);
172 git_dir = xstrdup(gitfile ? gitfile : git_dir);
31e26ebc 173 if (get_common_dir(&sb, git_dir))
c7b3a3d2 174 git_common_dir_env = 1;
31e26ebc 175 git_common_dir = strbuf_detach(&sb, NULL);
c7b3a3d2
NTND
176 git_object_dir = git_path_from_env(DB_ENVIRONMENT, git_common_dir,
177 "objects", &git_db_env);
178 git_index_file = git_path_from_env(INDEX_ENVIRONMENT, git_dir,
179 "index", &git_index_env);
180 git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, git_common_dir,
181 "info/grafts", &git_graft_env);
6476b38b 182 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
afc711b8 183 check_replace_refs = 0;
58d121b2
MH
184 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
185 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
186 : "refs/replace/");
a1bea2c1
JT
187 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
188 namespace_len = strlen(namespace);
069c0532
NTND
189 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
190 if (shallow_file)
191 set_alternate_shallow_file(shallow_file, 0);
0bee5918
SP
192}
193
7d1864ce 194int is_bare_repository(void)
0bee5918 195{
e90fdc39
JS
196 /* if core.bare is not 'false', let's see if there is a work tree */
197 return is_bare_repository_cfg && !get_git_work_tree();
e1b10391
LT
198}
199
c5fba16c 200const char *get_git_dir(void)
e1b10391
LT
201{
202 if (!git_dir)
203 setup_git_env();
204 return git_dir;
205}
206
c7b3a3d2
NTND
207const char *get_git_common_dir(void)
208{
209 return git_common_dir;
210}
211
a1bea2c1
JT
212const char *get_git_namespace(void)
213{
214 if (!namespace)
215 setup_git_env();
216 return namespace;
217}
218
219const char *strip_namespace(const char *namespaced_ref)
220{
59556548 221 if (!starts_with(namespaced_ref, get_git_namespace()))
a1bea2c1
JT
222 return NULL;
223 return namespaced_ref + namespace_len;
224}
225
19757d80
DB
226static int git_work_tree_initialized;
227
228/*
229 * Note. This works only before you used a work tree. This was added
230 * primarily to support git-clone to work in a new repository it just
231 * created, and is not meant to flip between different work trees.
232 */
233void set_git_work_tree(const char *new_work_tree)
234{
83518360 235 if (git_work_tree_initialized) {
e2a57aac 236 new_work_tree = real_path(new_work_tree);
83518360
NTND
237 if (strcmp(new_work_tree, work_tree))
238 die("internal error: work tree has already been set\n"
239 "Current worktree: %s\nNew worktree: %s",
240 work_tree, new_work_tree);
241 return;
242 }
19757d80 243 git_work_tree_initialized = 1;
e2a57aac 244 work_tree = xstrdup(real_path(new_work_tree));
19757d80
DB
245}
246
e90fdc39
JS
247const char *get_git_work_tree(void)
248{
e90fdc39
JS
249 return work_tree;
250}
251
e1b10391
LT
252char *get_object_directory(void)
253{
254 if (!git_object_dir)
255 setup_git_env();
256 return git_object_dir;
257}
258
463db9b1
JN
259int odb_mkstemp(char *template, size_t limit, const char *pattern)
260{
261 int fd;
262 /*
263 * we let the umask do its job, don't try to be more
264 * restrictive except to remove write permission.
265 */
266 int mode = 0444;
267 snprintf(template, limit, "%s/%s",
268 get_object_directory(), pattern);
269 fd = git_mkstemp_mode(template, mode);
270 if (0 <= fd)
271 return fd;
272
273 /* slow path */
274 /* some mkstemp implementations erase template on failure */
275 snprintf(template, limit, "%s/%s",
276 get_object_directory(), pattern);
277 safe_create_leading_directories(template);
278 return xmkstemp_mode(template, mode);
279}
280
8640d496 281int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
463db9b1
JN
282{
283 int fd;
284
285 snprintf(name, namesz, "%s/pack/pack-%s.keep",
286 get_object_directory(), sha1_to_hex(sha1));
287 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
288 if (0 <= fd)
289 return fd;
290
291 /* slow path */
292 safe_create_leading_directories(name);
293 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
294}
295
e1b10391
LT
296char *get_index_file(void)
297{
298 if (!git_index_file)
299 setup_git_env();
300 return git_index_file;
301}
302
303char *get_graft_file(void)
304{
305 if (!git_graft_file)
306 setup_git_env();
307 return git_graft_file;
308}
d7ac12b2
JS
309
310int set_git_dir(const char *path)
311{
312 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
313 return error("Could not set GIT_DIR to '%s'", path);
314 setup_git_env();
315 return 0;
316}
a6fa5992
PN
317
318const char *get_log_output_encoding(void)
319{
320 return git_log_output_encoding ? git_log_output_encoding
321 : get_commit_output_encoding();
322}
323
324const char *get_commit_output_encoding(void)
325{
326 return git_commit_encoding ? git_commit_encoding : "UTF-8";
327}