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