Merge branch 'jh/trace2-pretty-output'
[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"
e730b81d 11#include "branch.h"
c14c234f 12#include "repository.h"
b2141fc1 13#include "config.h"
a1bea2c1 14#include "refs.h"
273c7032 15#include "fmt-merge-msg.h"
069c0532 16#include "commit.h"
357a03eb 17#include "argv-array.h"
90c62155 18#include "object-store.h"
8500e0de 19#include "chdir-notify.h"
e1b10391 20
e1b10391 21int trust_executable_bit = 1;
1ce4790b 22int trust_ctime = 1;
c08e4d5b 23int check_stat = 1;
78a8d641 24int has_symlinks = 1;
e6c587c7 25int minimum_abbrev = 4, default_abbrev = -1;
0a9b88b7 26int ignore_case;
96f1e58f
DR
27int assume_unchanged;
28int prefer_symlink_refs;
7d1864ce 29int is_bare_repository_cfg = -1; /* unspecified */
1b371f56 30int warn_ambiguous_refs = 1;
25fba78d 31int warn_on_object_refname_ambiguity = 1;
49672f26 32int ref_paranoia = -1;
067fbd41 33int repository_format_precious_objects;
58b284a2 34int repository_format_worktree_config;
1a8f2741 35const char *git_commit_encoding;
3a55602e 36const char *git_log_output_encoding;
96f1e58f 37const char *apply_default_whitespace;
86c91f91 38const char *apply_default_ignorewhitespace;
64589a03 39const char *git_attributes_file;
867ad08a 40const char *git_hooks_path;
960ccca6
DH
41int zlib_compression_level = Z_BEST_SPEED;
42int core_compression_level;
8de7eeb5 43int pack_compression_level = Z_DEFAULT_COMPRESSION;
aafe9fba 44int fsync_object_files;
8c82534d
SP
45size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
46size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
4874f544 47size_t delta_base_cache_limit = 96 * 1024 * 1024;
15366280 48unsigned long big_file_threshold = 512 * 1024 * 1024;
aa086eb8 49int pager_use_color = 1;
ee9601e6 50const char *editor_program;
d3e7da89 51const char *askpass_program;
dfb068be 52const char *excludes_file;
fd6cce9e 53enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
6ebd1caf 54int read_replace_refs = 1;
58d121b2 55char *git_replace_ref_base;
ec70f52f 56enum eol core_eol = EOL_UNSET;
8462ff43 57int global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
e92d6225 58char *check_roundtrip_encoding = "SHIFT-JIS";
cf1b7869 59unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
9ed36cfa 60enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
c998ae9b 61enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
f25950f3 62enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
348df166
JS
63#ifndef OBJECT_CREATION_MODE
64#define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
be66a6c4 65#endif
348df166 66enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
a97a7468 67char *notes_ref_name;
7f3140cd 68int grafts_replace_parents = 1;
08aefc9e 69int core_apply_sparse_checkout;
898eacd8 70int merge_log_config = -1;
76759c7d 71int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
568508e7 72unsigned long pack_size_limit_cfg;
341fb286 73enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
e1b10391 74
a42643aa
JK
75#ifndef PROTECT_HFS_DEFAULT
76#define PROTECT_HFS_DEFAULT 0
77#endif
78int protect_hfs = PROTECT_HFS_DEFAULT;
79
2b4c6efc
JS
80#ifndef PROTECT_NTFS_DEFAULT
81#define PROTECT_NTFS_DEFAULT 0
82#endif
83int protect_ntfs = PROTECT_NTFS_DEFAULT;
883e248b 84const char *core_fsmonitor;
2b4c6efc 85
eff80a9f
JH
86/*
87 * The character that begins a commented line in user-editable file
88 * that is subject to stripspace.
89 */
90char comment_line_char = '#';
84c9dc2c 91int auto_comment_line_char;
eff80a9f 92
671c9b7e 93/* Parallel index stat data preload? */
299e2987 94int core_preload_index = 1;
671c9b7e 95
dae6c322
CC
96/*
97 * This is a hack for test programs like test-dump-untracked-cache to
98 * ensure that they do not modify the untracked cache when reading it.
99 * Do not use it otherwise!
100 */
101int ignore_untracked_cache_config;
102
e90fdc39
JS
103/* This is set by setup_git_dir_gently() and/or git_default_config() */
104char *git_work_tree_cfg;
e90fdc39 105
38f3f094 106static char *git_namespace;
a1bea2c1 107
8aac6903 108static char *super_prefix;
74866d75 109
48a7c1c4 110/*
2163e5db 111 * Repository-local GIT_* environment variables; see cache.h for details.
48a7c1c4 112 */
2163e5db 113const char * const local_repo_env[] = {
48a7c1c4
GB
114 ALTERNATE_DB_ENVIRONMENT,
115 CONFIG_ENVIRONMENT,
655e8d9c 116 CONFIG_DATA_ENVIRONMENT,
48a7c1c4
GB
117 DB_ENVIRONMENT,
118 GIT_DIR_ENVIRONMENT,
119 GIT_WORK_TREE_ENVIRONMENT,
2cd83d10 120 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
48a7c1c4
GB
121 GRAFT_ENVIRONMENT,
122 INDEX_ENVIRONMENT,
123 NO_REPLACE_OBJECTS_ENVIRONMENT,
58d121b2 124 GIT_REPLACE_REF_BASE_ENVIRONMENT,
a6f7f9a3 125 GIT_PREFIX_ENVIRONMENT,
74866d75 126 GIT_SUPER_PREFIX_ENVIRONMENT,
069c0532 127 GIT_SHALLOW_FILE_ENVIRONMENT,
c7b3a3d2 128 GIT_COMMON_DIR_ENVIRONMENT,
48a7c1c4
GB
129 NULL
130};
131
a1bea2c1
JT
132static char *expand_namespace(const char *raw_namespace)
133{
134 struct strbuf buf = STRBUF_INIT;
135 struct strbuf **components, **c;
136
137 if (!raw_namespace || !*raw_namespace)
138 return xstrdup("");
139
140 strbuf_addstr(&buf, raw_namespace);
141 components = strbuf_split(&buf, '/');
142 strbuf_reset(&buf);
143 for (c = components; *c; c++)
144 if (strcmp((*c)->buf, "/") != 0)
145 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
146 strbuf_list_free(components);
8d9c5010 147 if (check_refname_format(buf.buf, 0))
cbb46ca7 148 die(_("bad git namespace path \"%s\""), raw_namespace);
a1bea2c1
JT
149 strbuf_addch(&buf, '/');
150 return strbuf_detach(&buf, NULL);
151}
152
357a03eb
NTND
153/*
154 * Wrapper of getenv() that returns a strdup value. This value is kept
155 * in argv to be freed later.
156 */
157static const char *getenv_safe(struct argv_array *argv, const char *name)
158{
159 const char *value = getenv(name);
160
161 if (!value)
162 return NULL;
163
164 argv_array_push(argv, value);
165 return argv->argv[argv->argc - 1];
166}
167
168void setup_git_env(const char *git_dir)
e1b10391 169{
069c0532 170 const char *shallow_file;
58d121b2 171 const char *replace_ref_base;
357a03eb
NTND
172 struct set_gitdir_args args = { NULL };
173 struct argv_array to_free = ARGV_ARRAY_INIT;
174
175 args.commondir = getenv_safe(&to_free, GIT_COMMON_DIR_ENVIRONMENT);
176 args.object_dir = getenv_safe(&to_free, DB_ENVIRONMENT);
177 args.graft_file = getenv_safe(&to_free, GRAFT_ENVIRONMENT);
178 args.index_file = getenv_safe(&to_free, INDEX_ENVIRONMENT);
7bc0dcaa 179 args.alternate_db = getenv_safe(&to_free, ALTERNATE_DB_ENVIRONMENT);
357a03eb
NTND
180 repo_set_gitdir(the_repository, git_dir, &args);
181 argv_array_clear(&to_free);
487a2b73 182
6476b38b 183 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
6ebd1caf 184 read_replace_refs = 0;
58d121b2 185 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
f9b7573f 186 free(git_replace_ref_base);
58d121b2
MH
187 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
188 : "refs/replace/");
38f3f094
BW
189 free(git_namespace);
190 git_namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
069c0532
NTND
191 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
192 if (shallow_file)
6a2df51c 193 set_alternate_shallow_file(the_repository, shallow_file, 0);
0bee5918
SP
194}
195
7d1864ce 196int is_bare_repository(void)
0bee5918 197{
e90fdc39
JS
198 /* if core.bare is not 'false', let's see if there is a work tree */
199 return is_bare_repository_cfg && !get_git_work_tree();
e1b10391
LT
200}
201
b9605bc4
JK
202int have_git_dir(void)
203{
204 return startup_info->have_repository
c14c234f 205 || the_repository->gitdir;
b9605bc4
JK
206}
207
c5fba16c 208const char *get_git_dir(void)
e1b10391 209{
c14c234f 210 if (!the_repository->gitdir)
73f192c9 211 BUG("git environment hasn't been setup");
c14c234f 212 return the_repository->gitdir;
e1b10391
LT
213}
214
c7b3a3d2
NTND
215const char *get_git_common_dir(void)
216{
c14c234f 217 if (!the_repository->commondir)
73f192c9 218 BUG("git environment hasn't been setup");
c14c234f 219 return the_repository->commondir;
c7b3a3d2
NTND
220}
221
a1bea2c1
JT
222const char *get_git_namespace(void)
223{
38f3f094 224 if (!git_namespace)
73f192c9 225 BUG("git environment hasn't been setup");
38f3f094 226 return git_namespace;
a1bea2c1
JT
227}
228
229const char *strip_namespace(const char *namespaced_ref)
230{
bf08c8cf
BW
231 const char *out;
232 if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
233 return out;
234 return NULL;
a1bea2c1
JT
235}
236
74866d75
BW
237const char *get_super_prefix(void)
238{
239 static int initialized;
240 if (!initialized) {
8aac6903 241 super_prefix = xstrdup_or_null(getenv(GIT_SUPER_PREFIX_ENVIRONMENT));
74866d75
BW
242 initialized = 1;
243 }
244 return super_prefix;
245}
246
19757d80
DB
247static int git_work_tree_initialized;
248
249/*
250 * Note. This works only before you used a work tree. This was added
251 * primarily to support git-clone to work in a new repository it just
252 * created, and is not meant to flip between different work trees.
253 */
254void set_git_work_tree(const char *new_work_tree)
255{
83518360 256 if (git_work_tree_initialized) {
e2a57aac 257 new_work_tree = real_path(new_work_tree);
b4158732 258 if (strcmp(new_work_tree, the_repository->worktree))
83518360
NTND
259 die("internal error: work tree has already been set\n"
260 "Current worktree: %s\nNew worktree: %s",
b4158732 261 the_repository->worktree, new_work_tree);
83518360
NTND
262 return;
263 }
19757d80 264 git_work_tree_initialized = 1;
b4158732 265 repo_set_worktree(the_repository, new_work_tree);
19757d80
DB
266}
267
e90fdc39
JS
268const char *get_git_work_tree(void)
269{
b4158732 270 return the_repository->worktree;
e90fdc39
JS
271}
272
e1b10391
LT
273char *get_object_directory(void)
274{
f0eaf638 275 if (!the_repository->objects->odb)
73f192c9 276 BUG("git environment hasn't been setup");
f0eaf638 277 return the_repository->objects->odb->path;
e1b10391
LT
278}
279
a63b5fca 280int odb_mkstemp(struct strbuf *temp_filename, const char *pattern)
463db9b1
JN
281{
282 int fd;
283 /*
284 * we let the umask do its job, don't try to be more
285 * restrictive except to remove write permission.
286 */
287 int mode = 0444;
a63b5fca
BW
288 git_path_buf(temp_filename, "objects/%s", pattern);
289 fd = git_mkstemp_mode(temp_filename->buf, mode);
463db9b1
JN
290 if (0 <= fd)
291 return fd;
292
293 /* slow path */
a63b5fca
BW
294 /* some mkstemp implementations erase temp_filename on failure */
295 git_path_buf(temp_filename, "objects/%s", pattern);
296 safe_create_leading_directories(temp_filename->buf);
297 return xmkstemp_mode(temp_filename->buf, mode);
463db9b1
JN
298}
299
eaeefc32 300int odb_pack_keep(const char *name)
463db9b1
JN
301{
302 int fd;
303
463db9b1
JN
304 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
305 if (0 <= fd)
306 return fd;
307
308 /* slow path */
eaeefc32 309 safe_create_leading_directories_const(name);
463db9b1
JN
310 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
311}
312
e1b10391
LT
313char *get_index_file(void)
314{
c14c234f 315 if (!the_repository->index_file)
73f192c9 316 BUG("git environment hasn't been setup");
c14c234f 317 return the_repository->index_file;
e1b10391
LT
318}
319
0437a2e3 320char *get_graft_file(struct repository *r)
e1b10391 321{
0437a2e3 322 if (!r->graft_file)
73f192c9 323 BUG("git environment hasn't been setup");
0437a2e3 324 return r->graft_file;
e1b10391 325}
d7ac12b2 326
8500e0de 327static void set_git_dir_1(const char *path)
d7ac12b2
JS
328{
329 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
cbb46ca7 330 die(_("could not set GIT_DIR to '%s'"), path);
357a03eb 331 setup_git_env(path);
d7ac12b2 332}
a6fa5992 333
8500e0de
JK
334static void update_relative_gitdir(const char *name,
335 const char *old_cwd,
336 const char *new_cwd,
337 void *data)
338{
339 char *path = reparent_relative_path(old_cwd, new_cwd, get_git_dir());
340 trace_printf_key(&trace_setup_key,
341 "setup: move $GIT_DIR to '%s'",
342 path);
343 set_git_dir_1(path);
344 free(path);
345}
346
347void set_git_dir(const char *path)
348{
349 set_git_dir_1(path);
350 if (!is_absolute_path(path))
351 chdir_notify_register(NULL, update_relative_gitdir, NULL);
d7ac12b2 352}
a6fa5992
PN
353
354const char *get_log_output_encoding(void)
355{
356 return git_log_output_encoding ? git_log_output_encoding
357 : get_commit_output_encoding();
358}
359
360const char *get_commit_output_encoding(void)
361{
362 return git_commit_encoding ? git_commit_encoding : "UTF-8";
363}
7875acb6
JK
364
365static int the_shared_repository = PERM_UMASK;
ae5f6776 366static int need_shared_repository_from_config = 1;
7875acb6
JK
367
368void set_shared_repository(int value)
369{
370 the_shared_repository = value;
ae5f6776 371 need_shared_repository_from_config = 0;
7875acb6
JK
372}
373
374int get_shared_repository(void)
375{
ae5f6776
JK
376 if (need_shared_repository_from_config) {
377 const char *var = "core.sharedrepository";
378 const char *value;
379 if (!git_config_get_value(var, &value))
380 the_shared_repository = git_config_perm(var, value);
381 need_shared_repository_from_config = 0;
382 }
7875acb6
JK
383 return the_shared_repository;
384}
4543926b
JK
385
386void reset_shared_repository(void)
387{
388 need_shared_repository_from_config = 1;
389}
27344d6a
JK
390
391int use_optional_locks(void)
392{
393 return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
394}
a2cd709d
AR
395
396int print_sha1_ellipsis(void)
397{
398 /*
399 * Determine if the calling environment contains the variable
400 * GIT_PRINT_SHA1_ELLIPSIS set to "yes".
401 */
402 static int cached_result = -1; /* unknown */
403
404 if (cached_result < 0) {
405 const char *v = getenv("GIT_PRINT_SHA1_ELLIPSIS");
406 cached_result = (v && !strcasecmp(v, "yes"));
407 }
408 return cached_result;
409}