Documentation: user-manual: limit usage of ellipsis
[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;
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;
e90fdc39 99
f9b7573f 100static char *namespace;
a1bea2c1 101
74866d75
BW
102static const char *super_prefix;
103
48a7c1c4 104/*
2163e5db 105 * Repository-local GIT_* environment variables; see cache.h for details.
48a7c1c4 106 */
2163e5db 107const char * const local_repo_env[] = {
48a7c1c4
GB
108 ALTERNATE_DB_ENVIRONMENT,
109 CONFIG_ENVIRONMENT,
655e8d9c 110 CONFIG_DATA_ENVIRONMENT,
48a7c1c4
GB
111 DB_ENVIRONMENT,
112 GIT_DIR_ENVIRONMENT,
113 GIT_WORK_TREE_ENVIRONMENT,
2cd83d10 114 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
48a7c1c4
GB
115 GRAFT_ENVIRONMENT,
116 INDEX_ENVIRONMENT,
117 NO_REPLACE_OBJECTS_ENVIRONMENT,
58d121b2 118 GIT_REPLACE_REF_BASE_ENVIRONMENT,
a6f7f9a3 119 GIT_PREFIX_ENVIRONMENT,
74866d75 120 GIT_SUPER_PREFIX_ENVIRONMENT,
069c0532 121 GIT_SHALLOW_FILE_ENVIRONMENT,
c7b3a3d2 122 GIT_COMMON_DIR_ENVIRONMENT,
48a7c1c4
GB
123 NULL
124};
125
a1bea2c1
JT
126static char *expand_namespace(const char *raw_namespace)
127{
128 struct strbuf buf = STRBUF_INIT;
129 struct strbuf **components, **c;
130
131 if (!raw_namespace || !*raw_namespace)
132 return xstrdup("");
133
134 strbuf_addstr(&buf, raw_namespace);
135 components = strbuf_split(&buf, '/');
136 strbuf_reset(&buf);
137 for (c = components; *c; c++)
138 if (strcmp((*c)->buf, "/") != 0)
139 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
140 strbuf_list_free(components);
8d9c5010 141 if (check_refname_format(buf.buf, 0))
a1bea2c1
JT
142 die("bad git namespace path \"%s\"", raw_namespace);
143 strbuf_addch(&buf, '/');
144 return strbuf_detach(&buf, NULL);
145}
146
73f192c9 147void setup_git_env(void)
e1b10391 148{
069c0532 149 const char *shallow_file;
58d121b2 150 const char *replace_ref_base;
487a2b73 151
6476b38b 152 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
afc711b8 153 check_replace_refs = 0;
58d121b2 154 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
f9b7573f 155 free(git_replace_ref_base);
58d121b2
MH
156 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
157 : "refs/replace/");
f9b7573f 158 free(namespace);
a1bea2c1 159 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
069c0532
NTND
160 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
161 if (shallow_file)
162 set_alternate_shallow_file(shallow_file, 0);
0bee5918
SP
163}
164
7d1864ce 165int is_bare_repository(void)
0bee5918 166{
e90fdc39
JS
167 /* if core.bare is not 'false', let's see if there is a work tree */
168 return is_bare_repository_cfg && !get_git_work_tree();
e1b10391
LT
169}
170
b9605bc4
JK
171int have_git_dir(void)
172{
173 return startup_info->have_repository
c14c234f 174 || the_repository->gitdir;
b9605bc4
JK
175}
176
c5fba16c 177const char *get_git_dir(void)
e1b10391 178{
c14c234f 179 if (!the_repository->gitdir)
73f192c9 180 BUG("git environment hasn't been setup");
c14c234f 181 return the_repository->gitdir;
e1b10391
LT
182}
183
c7b3a3d2
NTND
184const char *get_git_common_dir(void)
185{
c14c234f 186 if (!the_repository->commondir)
73f192c9 187 BUG("git environment hasn't been setup");
c14c234f 188 return the_repository->commondir;
c7b3a3d2
NTND
189}
190
a1bea2c1
JT
191const char *get_git_namespace(void)
192{
193 if (!namespace)
73f192c9 194 BUG("git environment hasn't been setup");
a1bea2c1
JT
195 return namespace;
196}
197
198const char *strip_namespace(const char *namespaced_ref)
199{
bf08c8cf
BW
200 const char *out;
201 if (skip_prefix(namespaced_ref, get_git_namespace(), &out))
202 return out;
203 return NULL;
a1bea2c1
JT
204}
205
74866d75
BW
206const char *get_super_prefix(void)
207{
208 static int initialized;
209 if (!initialized) {
210 super_prefix = getenv(GIT_SUPER_PREFIX_ENVIRONMENT);
211 initialized = 1;
212 }
213 return super_prefix;
214}
215
19757d80
DB
216static int git_work_tree_initialized;
217
218/*
219 * Note. This works only before you used a work tree. This was added
220 * primarily to support git-clone to work in a new repository it just
221 * created, and is not meant to flip between different work trees.
222 */
223void set_git_work_tree(const char *new_work_tree)
224{
83518360 225 if (git_work_tree_initialized) {
e2a57aac 226 new_work_tree = real_path(new_work_tree);
b4158732 227 if (strcmp(new_work_tree, the_repository->worktree))
83518360
NTND
228 die("internal error: work tree has already been set\n"
229 "Current worktree: %s\nNew worktree: %s",
b4158732 230 the_repository->worktree, new_work_tree);
83518360
NTND
231 return;
232 }
19757d80 233 git_work_tree_initialized = 1;
b4158732 234 repo_set_worktree(the_repository, new_work_tree);
19757d80
DB
235}
236
e90fdc39
JS
237const char *get_git_work_tree(void)
238{
b4158732 239 return the_repository->worktree;
e90fdc39
JS
240}
241
e1b10391
LT
242char *get_object_directory(void)
243{
c14c234f 244 if (!the_repository->objectdir)
73f192c9 245 BUG("git environment hasn't been setup");
c14c234f 246 return the_repository->objectdir;
e1b10391
LT
247}
248
594fa999 249int odb_mkstemp(struct strbuf *template, const char *pattern)
463db9b1
JN
250{
251 int fd;
252 /*
253 * we let the umask do its job, don't try to be more
254 * restrictive except to remove write permission.
255 */
256 int mode = 0444;
4aa7d75e 257 git_path_buf(template, "objects/%s", pattern);
594fa999 258 fd = git_mkstemp_mode(template->buf, mode);
463db9b1
JN
259 if (0 <= fd)
260 return fd;
261
262 /* slow path */
263 /* some mkstemp implementations erase template on failure */
4aa7d75e 264 git_path_buf(template, "objects/%s", pattern);
594fa999
JK
265 safe_create_leading_directories(template->buf);
266 return xmkstemp_mode(template->buf, mode);
463db9b1
JN
267}
268
eaeefc32 269int odb_pack_keep(const char *name)
463db9b1
JN
270{
271 int fd;
272
463db9b1
JN
273 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
274 if (0 <= fd)
275 return fd;
276
277 /* slow path */
eaeefc32 278 safe_create_leading_directories_const(name);
463db9b1
JN
279 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
280}
281
e1b10391
LT
282char *get_index_file(void)
283{
c14c234f 284 if (!the_repository->index_file)
73f192c9 285 BUG("git environment hasn't been setup");
c14c234f 286 return the_repository->index_file;
e1b10391
LT
287}
288
289char *get_graft_file(void)
290{
c14c234f 291 if (!the_repository->graft_file)
73f192c9 292 BUG("git environment hasn't been setup");
c14c234f 293 return the_repository->graft_file;
e1b10391 294}
d7ac12b2
JS
295
296int set_git_dir(const char *path)
297{
298 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
299 return error("Could not set GIT_DIR to '%s'", path);
c14c234f 300 repo_set_gitdir(the_repository, path);
d7ac12b2
JS
301 setup_git_env();
302 return 0;
303}
a6fa5992
PN
304
305const char *get_log_output_encoding(void)
306{
307 return git_log_output_encoding ? git_log_output_encoding
308 : get_commit_output_encoding();
309}
310
311const char *get_commit_output_encoding(void)
312{
313 return git_commit_encoding ? git_commit_encoding : "UTF-8";
314}
7875acb6
JK
315
316static int the_shared_repository = PERM_UMASK;
ae5f6776 317static int need_shared_repository_from_config = 1;
7875acb6
JK
318
319void set_shared_repository(int value)
320{
321 the_shared_repository = value;
ae5f6776 322 need_shared_repository_from_config = 0;
7875acb6
JK
323}
324
325int get_shared_repository(void)
326{
ae5f6776
JK
327 if (need_shared_repository_from_config) {
328 const char *var = "core.sharedrepository";
329 const char *value;
330 if (!git_config_get_value(var, &value))
331 the_shared_repository = git_config_perm(var, value);
332 need_shared_repository_from_config = 0;
333 }
7875acb6
JK
334 return the_shared_repository;
335}
4543926b
JK
336
337void reset_shared_repository(void)
338{
339 need_shared_repository_from_config = 1;
340}
27344d6a
JK
341
342int use_optional_locks(void)
343{
344 return git_env_bool(GIT_OPTIONAL_LOCKS_ENVIRONMENT, 1);
345}