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