Documentation/git-bisect.txt: git bisect term → git bisect terms
[git] / environment.c
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"
11 #include "refs.h"
12 #include "fmt-merge-msg.h"
13 #include "commit.h"
14
15 int trust_executable_bit = 1;
16 int trust_ctime = 1;
17 int check_stat = 1;
18 int has_symlinks = 1;
19 int minimum_abbrev = 4, default_abbrev = 7;
20 int ignore_case;
21 int assume_unchanged;
22 int prefer_symlink_refs;
23 int is_bare_repository_cfg = -1; /* unspecified */
24 int log_all_ref_updates = -1; /* unspecified */
25 int warn_ambiguous_refs = 1;
26 int warn_on_object_refname_ambiguity = 1;
27 int ref_paranoia = -1;
28 int repository_format_version;
29 const char *git_commit_encoding;
30 const char *git_log_output_encoding;
31 int shared_repository = PERM_UMASK;
32 const char *apply_default_whitespace;
33 const char *apply_default_ignorewhitespace;
34 const char *git_attributes_file;
35 int zlib_compression_level = Z_BEST_SPEED;
36 int core_compression_level;
37 int core_compression_seen;
38 int fsync_object_files;
39 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
40 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
41 size_t delta_base_cache_limit = 96 * 1024 * 1024;
42 unsigned long big_file_threshold = 512 * 1024 * 1024;
43 const char *pager_program;
44 int pager_use_color = 1;
45 const char *editor_program;
46 const char *askpass_program;
47 const char *excludes_file;
48 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
49 int check_replace_refs = 1;
50 enum eol core_eol = EOL_UNSET;
51 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
52 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
53 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
54 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
55 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
56 #ifndef OBJECT_CREATION_MODE
57 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
58 #endif
59 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
60 char *notes_ref_name;
61 int grafts_replace_parents = 1;
62 int core_apply_sparse_checkout;
63 int merge_log_config = -1;
64 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
65 struct startup_info *startup_info;
66 unsigned long pack_size_limit_cfg;
67
68 #ifndef PROTECT_HFS_DEFAULT
69 #define PROTECT_HFS_DEFAULT 0
70 #endif
71 int protect_hfs = PROTECT_HFS_DEFAULT;
72
73 #ifndef PROTECT_NTFS_DEFAULT
74 #define PROTECT_NTFS_DEFAULT 0
75 #endif
76 int protect_ntfs = PROTECT_NTFS_DEFAULT;
77
78 /*
79  * The character that begins a commented line in user-editable file
80  * that is subject to stripspace.
81  */
82 char comment_line_char = '#';
83 int auto_comment_line_char;
84
85 /* Parallel index stat data preload? */
86 int core_preload_index = 1;
87
88 /* This is set by setup_git_dir_gently() and/or git_default_config() */
89 char *git_work_tree_cfg;
90 static char *work_tree;
91
92 static const char *namespace;
93 static size_t namespace_len;
94
95 static const char *git_dir, *git_common_dir;
96 static char *git_object_dir, *git_index_file, *git_graft_file;
97 int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
98
99 /*
100  * Repository-local GIT_* environment variables; see cache.h for details.
101  */
102 const char * const local_repo_env[] = {
103         ALTERNATE_DB_ENVIRONMENT,
104         CONFIG_ENVIRONMENT,
105         CONFIG_DATA_ENVIRONMENT,
106         DB_ENVIRONMENT,
107         GIT_DIR_ENVIRONMENT,
108         GIT_WORK_TREE_ENVIRONMENT,
109         GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
110         GRAFT_ENVIRONMENT,
111         INDEX_ENVIRONMENT,
112         NO_REPLACE_OBJECTS_ENVIRONMENT,
113         GIT_PREFIX_ENVIRONMENT,
114         GIT_SHALLOW_FILE_ENVIRONMENT,
115         GIT_COMMON_DIR_ENVIRONMENT,
116         NULL
117 };
118
119 static char *expand_namespace(const char *raw_namespace)
120 {
121         struct strbuf buf = STRBUF_INIT;
122         struct strbuf **components, **c;
123
124         if (!raw_namespace || !*raw_namespace)
125                 return xstrdup("");
126
127         strbuf_addstr(&buf, raw_namespace);
128         components = strbuf_split(&buf, '/');
129         strbuf_reset(&buf);
130         for (c = components; *c; c++)
131                 if (strcmp((*c)->buf, "/") != 0)
132                         strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
133         strbuf_list_free(components);
134         if (check_refname_format(buf.buf, 0))
135                 die("bad git namespace path \"%s\"", raw_namespace);
136         strbuf_addch(&buf, '/');
137         return strbuf_detach(&buf, NULL);
138 }
139
140 static char *git_path_from_env(const char *envvar, const char *git_dir,
141                                const char *path, int *fromenv)
142 {
143         const char *value = getenv(envvar);
144         if (!value) {
145                 char *buf = xmalloc(strlen(git_dir) + strlen(path) + 2);
146                 sprintf(buf, "%s/%s", git_dir, path);
147                 return buf;
148         }
149         if (fromenv)
150                 *fromenv = 1;
151         return xstrdup(value);
152 }
153
154 static void setup_git_env(void)
155 {
156         struct strbuf sb = STRBUF_INIT;
157         const char *gitfile;
158         const char *shallow_file;
159
160         git_dir = getenv(GIT_DIR_ENVIRONMENT);
161         if (!git_dir)
162                 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
163         gitfile = read_gitfile(git_dir);
164         git_dir = xstrdup(gitfile ? gitfile : git_dir);
165         if (get_common_dir(&sb, git_dir))
166                 git_common_dir_env = 1;
167         git_common_dir = strbuf_detach(&sb, NULL);
168         git_object_dir = git_path_from_env(DB_ENVIRONMENT, git_common_dir,
169                                            "objects", &git_db_env);
170         git_index_file = git_path_from_env(INDEX_ENVIRONMENT, git_dir,
171                                            "index", &git_index_env);
172         git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, git_common_dir,
173                                            "info/grafts", &git_graft_env);
174         if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
175                 check_replace_refs = 0;
176         namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
177         namespace_len = strlen(namespace);
178         shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
179         if (shallow_file)
180                 set_alternate_shallow_file(shallow_file, 0);
181 }
182
183 int is_bare_repository(void)
184 {
185         /* if core.bare is not 'false', let's see if there is a work tree */
186         return is_bare_repository_cfg && !get_git_work_tree();
187 }
188
189 const char *get_git_dir(void)
190 {
191         if (!git_dir)
192                 setup_git_env();
193         return git_dir;
194 }
195
196 const char *get_git_common_dir(void)
197 {
198         return git_common_dir;
199 }
200
201 const char *get_git_namespace(void)
202 {
203         if (!namespace)
204                 setup_git_env();
205         return namespace;
206 }
207
208 const char *strip_namespace(const char *namespaced_ref)
209 {
210         if (!starts_with(namespaced_ref, get_git_namespace()))
211                 return NULL;
212         return namespaced_ref + namespace_len;
213 }
214
215 static int git_work_tree_initialized;
216
217 /*
218  * Note.  This works only before you used a work tree.  This was added
219  * primarily to support git-clone to work in a new repository it just
220  * created, and is not meant to flip between different work trees.
221  */
222 void set_git_work_tree(const char *new_work_tree)
223 {
224         if (git_work_tree_initialized) {
225                 new_work_tree = real_path(new_work_tree);
226                 if (strcmp(new_work_tree, work_tree))
227                         die("internal error: work tree has already been set\n"
228                             "Current worktree: %s\nNew worktree: %s",
229                             work_tree, new_work_tree);
230                 return;
231         }
232         git_work_tree_initialized = 1;
233         work_tree = xstrdup(real_path(new_work_tree));
234 }
235
236 const char *get_git_work_tree(void)
237 {
238         return work_tree;
239 }
240
241 char *get_object_directory(void)
242 {
243         if (!git_object_dir)
244                 setup_git_env();
245         return git_object_dir;
246 }
247
248 int odb_mkstemp(char *template, size_t limit, const char *pattern)
249 {
250         int fd;
251         /*
252          * we let the umask do its job, don't try to be more
253          * restrictive except to remove write permission.
254          */
255         int mode = 0444;
256         snprintf(template, limit, "%s/%s",
257                  get_object_directory(), pattern);
258         fd = git_mkstemp_mode(template, mode);
259         if (0 <= fd)
260                 return fd;
261
262         /* slow path */
263         /* some mkstemp implementations erase template on failure */
264         snprintf(template, limit, "%s/%s",
265                  get_object_directory(), pattern);
266         safe_create_leading_directories(template);
267         return xmkstemp_mode(template, mode);
268 }
269
270 int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
271 {
272         int fd;
273
274         snprintf(name, namesz, "%s/pack/pack-%s.keep",
275                  get_object_directory(), sha1_to_hex(sha1));
276         fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
277         if (0 <= fd)
278                 return fd;
279
280         /* slow path */
281         safe_create_leading_directories(name);
282         return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
283 }
284
285 char *get_index_file(void)
286 {
287         if (!git_index_file)
288                 setup_git_env();
289         return git_index_file;
290 }
291
292 char *get_graft_file(void)
293 {
294         if (!git_graft_file)
295                 setup_git_env();
296         return git_graft_file;
297 }
298
299 int set_git_dir(const char *path)
300 {
301         if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
302                 return error("Could not set GIT_DIR to '%s'", path);
303         setup_git_env();
304         return 0;
305 }
306
307 const char *get_log_output_encoding(void)
308 {
309         return git_log_output_encoding ? git_log_output_encoding
310                 : get_commit_output_encoding();
311 }
312
313 const char *get_commit_output_encoding(void)
314 {
315         return git_commit_encoding ? git_commit_encoding : "UTF-8";
316 }