Allow custom "comment char"
[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"
e1b10391 13
e1b10391 14int trust_executable_bit = 1;
1ce4790b 15int trust_ctime = 1;
78a8d641 16int has_symlinks = 1;
dce96489 17int minimum_abbrev = 4, default_abbrev = 7;
0a9b88b7 18int ignore_case;
96f1e58f
DR
19int assume_unchanged;
20int prefer_symlink_refs;
7d1864ce 21int is_bare_repository_cfg = -1; /* unspecified */
510c5a8e 22int log_all_ref_updates = -1; /* unspecified */
1b371f56 23int warn_ambiguous_refs = 1;
96f1e58f 24int repository_format_version;
1a8f2741 25const char *git_commit_encoding;
3a55602e 26const char *git_log_output_encoding;
94df2506 27int shared_repository = PERM_UMASK;
96f1e58f 28const char *apply_default_whitespace;
86c91f91 29const char *apply_default_ignorewhitespace;
64589a03 30const char *git_attributes_file;
960ccca6
DH
31int zlib_compression_level = Z_BEST_SPEED;
32int core_compression_level;
33int core_compression_seen;
aafe9fba 34int fsync_object_files;
8c82534d
SP
35size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
36size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
18bdec11 37size_t delta_base_cache_limit = 16 * 1024 * 1024;
15366280 38unsigned long big_file_threshold = 512 * 1024 * 1024;
5f44324d 39const char *log_pack_access;
872da32d 40const char *pager_program;
aa086eb8 41int pager_use_color = 1;
ee9601e6 42const char *editor_program;
d3e7da89 43const char *askpass_program;
dfb068be 44const char *excludes_file;
fd6cce9e 45enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
e1111cef 46int read_replace_refs = 1; /* NEEDSWORK: rename to use_replace_refs */
ec70f52f 47enum eol core_eol = EOL_UNSET;
21e5ad50 48enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
cf1b7869 49unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
9ed36cfa 50enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
c998ae9b 51enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
f25950f3 52enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
348df166
JS
53#ifndef OBJECT_CREATION_MODE
54#define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
be66a6c4 55#endif
348df166 56enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
a97a7468 57char *notes_ref_name;
7f3140cd 58int grafts_replace_parents = 1;
08aefc9e 59int core_apply_sparse_checkout;
898eacd8 60int merge_log_config = -1;
76759c7d 61int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
e37c1329 62struct startup_info *startup_info;
568508e7 63unsigned long pack_size_limit_cfg;
e1b10391 64
eff80a9f
JH
65/*
66 * The character that begins a commented line in user-editable file
67 * that is subject to stripspace.
68 */
69char comment_line_char = '#';
70
671c9b7e
LT
71/* Parallel index stat data preload? */
72int core_preload_index = 0;
73
e90fdc39
JS
74/* This is set by setup_git_dir_gently() and/or git_default_config() */
75char *git_work_tree_cfg;
19757d80 76static char *work_tree;
e90fdc39 77
a1bea2c1
JT
78static const char *namespace;
79static size_t namespace_len;
80
c5fba16c 81static const char *git_dir;
7f7868ea 82static char *git_object_dir, *git_index_file, *git_graft_file;
c5fba16c 83
48a7c1c4
GB
84/*
85 * Repository-local GIT_* environment variables
86 * Remember to update local_repo_env_size in cache.h when
87 * the size of the list changes
88 */
89const char * const local_repo_env[LOCAL_REPO_ENV_SIZE + 1] = {
90 ALTERNATE_DB_ENVIRONMENT,
91 CONFIG_ENVIRONMENT,
655e8d9c 92 CONFIG_DATA_ENVIRONMENT,
48a7c1c4
GB
93 DB_ENVIRONMENT,
94 GIT_DIR_ENVIRONMENT,
95 GIT_WORK_TREE_ENVIRONMENT,
96 GRAFT_ENVIRONMENT,
97 INDEX_ENVIRONMENT,
98 NO_REPLACE_OBJECTS_ENVIRONMENT,
99 NULL
100};
101
a1bea2c1
JT
102static char *expand_namespace(const char *raw_namespace)
103{
104 struct strbuf buf = STRBUF_INIT;
105 struct strbuf **components, **c;
106
107 if (!raw_namespace || !*raw_namespace)
108 return xstrdup("");
109
110 strbuf_addstr(&buf, raw_namespace);
111 components = strbuf_split(&buf, '/');
112 strbuf_reset(&buf);
113 for (c = components; *c; c++)
114 if (strcmp((*c)->buf, "/") != 0)
115 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
116 strbuf_list_free(components);
8d9c5010 117 if (check_refname_format(buf.buf, 0))
a1bea2c1
JT
118 die("bad git namespace path \"%s\"", raw_namespace);
119 strbuf_addch(&buf, '/');
120 return strbuf_detach(&buf, NULL);
121}
122
e1b10391
LT
123static void setup_git_env(void)
124{
125 git_dir = getenv(GIT_DIR_ENVIRONMENT);
15431ca6 126 git_dir = git_dir ? xstrdup(git_dir) : NULL;
06f3549d 127 if (!git_dir) {
13d6ec91 128 git_dir = read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT);
06f3549d
JN
129 git_dir = git_dir ? xstrdup(git_dir) : NULL;
130 }
e1b10391
LT
131 if (!git_dir)
132 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
133 git_object_dir = getenv(DB_ENVIRONMENT);
134 if (!git_object_dir) {
135 git_object_dir = xmalloc(strlen(git_dir) + 9);
136 sprintf(git_object_dir, "%s/objects", git_dir);
137 }
e1b10391
LT
138 git_index_file = getenv(INDEX_ENVIRONMENT);
139 if (!git_index_file) {
140 git_index_file = xmalloc(strlen(git_dir) + 7);
141 sprintf(git_index_file, "%s/index", git_dir);
142 }
143 git_graft_file = getenv(GRAFT_ENVIRONMENT);
144 if (!git_graft_file)
a4f34cbb 145 git_graft_file = git_pathdup("info/grafts");
6476b38b
CC
146 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
147 read_replace_refs = 0;
a1bea2c1
JT
148 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
149 namespace_len = strlen(namespace);
0bee5918
SP
150}
151
7d1864ce 152int is_bare_repository(void)
0bee5918 153{
e90fdc39
JS
154 /* if core.bare is not 'false', let's see if there is a work tree */
155 return is_bare_repository_cfg && !get_git_work_tree();
e1b10391
LT
156}
157
d2b0708e
DP
158int have_git_dir(void)
159{
160 return !!git_dir;
161}
162
c5fba16c 163const char *get_git_dir(void)
e1b10391
LT
164{
165 if (!git_dir)
166 setup_git_env();
167 return git_dir;
168}
169
a1bea2c1
JT
170const char *get_git_namespace(void)
171{
172 if (!namespace)
173 setup_git_env();
174 return namespace;
175}
176
177const char *strip_namespace(const char *namespaced_ref)
178{
179 if (prefixcmp(namespaced_ref, get_git_namespace()) != 0)
180 return NULL;
181 return namespaced_ref + namespace_len;
182}
183
19757d80
DB
184static int git_work_tree_initialized;
185
186/*
187 * Note. This works only before you used a work tree. This was added
188 * primarily to support git-clone to work in a new repository it just
189 * created, and is not meant to flip between different work trees.
190 */
191void set_git_work_tree(const char *new_work_tree)
192{
83518360 193 if (git_work_tree_initialized) {
e2a57aac 194 new_work_tree = real_path(new_work_tree);
83518360
NTND
195 if (strcmp(new_work_tree, work_tree))
196 die("internal error: work tree has already been set\n"
197 "Current worktree: %s\nNew worktree: %s",
198 work_tree, new_work_tree);
199 return;
200 }
19757d80 201 git_work_tree_initialized = 1;
e2a57aac 202 work_tree = xstrdup(real_path(new_work_tree));
19757d80
DB
203}
204
e90fdc39
JS
205const char *get_git_work_tree(void)
206{
e90fdc39
JS
207 return work_tree;
208}
209
e1b10391
LT
210char *get_object_directory(void)
211{
212 if (!git_object_dir)
213 setup_git_env();
214 return git_object_dir;
215}
216
463db9b1
JN
217int odb_mkstemp(char *template, size_t limit, const char *pattern)
218{
219 int fd;
220 /*
221 * we let the umask do its job, don't try to be more
222 * restrictive except to remove write permission.
223 */
224 int mode = 0444;
225 snprintf(template, limit, "%s/%s",
226 get_object_directory(), pattern);
227 fd = git_mkstemp_mode(template, mode);
228 if (0 <= fd)
229 return fd;
230
231 /* slow path */
232 /* some mkstemp implementations erase template on failure */
233 snprintf(template, limit, "%s/%s",
234 get_object_directory(), pattern);
235 safe_create_leading_directories(template);
236 return xmkstemp_mode(template, mode);
237}
238
239int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1)
240{
241 int fd;
242
243 snprintf(name, namesz, "%s/pack/pack-%s.keep",
244 get_object_directory(), sha1_to_hex(sha1));
245 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
246 if (0 <= fd)
247 return fd;
248
249 /* slow path */
250 safe_create_leading_directories(name);
251 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
252}
253
e1b10391
LT
254char *get_index_file(void)
255{
256 if (!git_index_file)
257 setup_git_env();
258 return git_index_file;
259}
260
261char *get_graft_file(void)
262{
263 if (!git_graft_file)
264 setup_git_env();
265 return git_graft_file;
266}
d7ac12b2
JS
267
268int set_git_dir(const char *path)
269{
270 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
271 return error("Could not set GIT_DIR to '%s'", path);
272 setup_git_env();
273 return 0;
274}
a6fa5992
PN
275
276const char *get_log_output_encoding(void)
277{
278 return git_log_output_encoding ? git_log_output_encoding
279 : get_commit_output_encoding();
280}
281
282const char *get_commit_output_encoding(void)
283{
284 return git_commit_encoding ? git_commit_encoding : "UTF-8";
285}