Merge branch 'rs/pretty-format-color-doc-fix'
[alt-git.git] / environment.c
blobcd5aa57179240d615cb0628c9e24f44ac4b8c2d3
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.
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"
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_precious_objects;
29 const char *git_commit_encoding;
30 const char *git_log_output_encoding;
31 const char *apply_default_whitespace;
32 const char *apply_default_ignorewhitespace;
33 const char *git_attributes_file;
34 const char *git_hooks_path;
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 int pager_use_color = 1;
44 const char *editor_program;
45 const char *askpass_program;
46 const char *excludes_file;
47 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
48 int check_replace_refs = 1;
49 char *git_replace_ref_base;
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 unsigned long pack_size_limit_cfg;
66 enum hide_dotfiles_type hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
68 #ifndef PROTECT_HFS_DEFAULT
69 #define PROTECT_HFS_DEFAULT 0
70 #endif
71 int protect_hfs = PROTECT_HFS_DEFAULT;
73 #ifndef PROTECT_NTFS_DEFAULT
74 #define PROTECT_NTFS_DEFAULT 0
75 #endif
76 int protect_ntfs = PROTECT_NTFS_DEFAULT;
79 * The character that begins a commented line in user-editable file
80 * that is subject to stripspace.
82 char comment_line_char = '#';
83 int auto_comment_line_char;
85 /* Parallel index stat data preload? */
86 int core_preload_index = 1;
89 * This is a hack for test programs like test-dump-untracked-cache to
90 * ensure that they do not modify the untracked cache when reading it.
91 * Do not use it otherwise!
93 int ignore_untracked_cache_config;
95 /* This is set by setup_git_dir_gently() and/or git_default_config() */
96 char *git_work_tree_cfg;
97 static char *work_tree;
99 static const char *namespace;
100 static size_t namespace_len;
102 static const char *git_dir, *git_common_dir;
103 static char *git_object_dir, *git_index_file, *git_graft_file;
104 int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
107 * Repository-local GIT_* environment variables; see cache.h for details.
109 const char * const local_repo_env[] = {
110 ALTERNATE_DB_ENVIRONMENT,
111 CONFIG_ENVIRONMENT,
112 CONFIG_DATA_ENVIRONMENT,
113 DB_ENVIRONMENT,
114 GIT_DIR_ENVIRONMENT,
115 GIT_WORK_TREE_ENVIRONMENT,
116 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
117 GRAFT_ENVIRONMENT,
118 INDEX_ENVIRONMENT,
119 NO_REPLACE_OBJECTS_ENVIRONMENT,
120 GIT_REPLACE_REF_BASE_ENVIRONMENT,
121 GIT_PREFIX_ENVIRONMENT,
122 GIT_SHALLOW_FILE_ENVIRONMENT,
123 GIT_COMMON_DIR_ENVIRONMENT,
124 NULL
127 static char *expand_namespace(const char *raw_namespace)
129 struct strbuf buf = STRBUF_INIT;
130 struct strbuf **components, **c;
132 if (!raw_namespace || !*raw_namespace)
133 return xstrdup("");
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);
142 if (check_refname_format(buf.buf, 0))
143 die("bad git namespace path \"%s\"", raw_namespace);
144 strbuf_addch(&buf, '/');
145 return strbuf_detach(&buf, NULL);
148 static char *git_path_from_env(const char *envvar, const char *git_dir,
149 const char *path, int *fromenv)
151 const char *value = getenv(envvar);
152 if (!value)
153 return xstrfmt("%s/%s", git_dir, path);
154 if (fromenv)
155 *fromenv = 1;
156 return xstrdup(value);
159 static void setup_git_env(void)
161 struct strbuf sb = STRBUF_INIT;
162 const char *gitfile;
163 const char *shallow_file;
164 const char *replace_ref_base;
166 git_dir = getenv(GIT_DIR_ENVIRONMENT);
167 if (!git_dir)
168 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
169 gitfile = read_gitfile(git_dir);
170 git_dir = xstrdup(gitfile ? gitfile : git_dir);
171 if (get_common_dir(&sb, git_dir))
172 git_common_dir_env = 1;
173 git_common_dir = strbuf_detach(&sb, NULL);
174 git_object_dir = git_path_from_env(DB_ENVIRONMENT, git_common_dir,
175 "objects", &git_db_env);
176 git_index_file = git_path_from_env(INDEX_ENVIRONMENT, git_dir,
177 "index", &git_index_env);
178 git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, git_common_dir,
179 "info/grafts", &git_graft_env);
180 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
181 check_replace_refs = 0;
182 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
183 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
184 : "refs/replace/");
185 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
186 namespace_len = strlen(namespace);
187 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
188 if (shallow_file)
189 set_alternate_shallow_file(shallow_file, 0);
192 int is_bare_repository(void)
194 /* if core.bare is not 'false', let's see if there is a work tree */
195 return is_bare_repository_cfg && !get_git_work_tree();
198 int have_git_dir(void)
200 return startup_info->have_repository
201 || git_dir
202 || getenv(GIT_DIR_ENVIRONMENT);
205 const char *get_git_dir(void)
207 if (!git_dir)
208 setup_git_env();
209 return git_dir;
212 const char *get_git_common_dir(void)
214 return git_common_dir;
217 const char *get_git_namespace(void)
219 if (!namespace)
220 setup_git_env();
221 return namespace;
224 const char *strip_namespace(const char *namespaced_ref)
226 if (!starts_with(namespaced_ref, get_git_namespace()))
227 return NULL;
228 return namespaced_ref + namespace_len;
231 static int git_work_tree_initialized;
234 * Note. This works only before you used a work tree. This was added
235 * primarily to support git-clone to work in a new repository it just
236 * created, and is not meant to flip between different work trees.
238 void set_git_work_tree(const char *new_work_tree)
240 if (git_work_tree_initialized) {
241 new_work_tree = real_path(new_work_tree);
242 if (strcmp(new_work_tree, work_tree))
243 die("internal error: work tree has already been set\n"
244 "Current worktree: %s\nNew worktree: %s",
245 work_tree, new_work_tree);
246 return;
248 git_work_tree_initialized = 1;
249 work_tree = xstrdup(real_path(new_work_tree));
252 const char *get_git_work_tree(void)
254 return work_tree;
257 char *get_object_directory(void)
259 if (!git_object_dir)
260 setup_git_env();
261 return git_object_dir;
264 int odb_mkstemp(char *template, size_t limit, const char *pattern)
266 int fd;
268 * we let the umask do its job, don't try to be more
269 * restrictive except to remove write permission.
271 int mode = 0444;
272 snprintf(template, limit, "%s/%s",
273 get_object_directory(), pattern);
274 fd = git_mkstemp_mode(template, mode);
275 if (0 <= fd)
276 return fd;
278 /* slow path */
279 /* some mkstemp implementations erase template on failure */
280 snprintf(template, limit, "%s/%s",
281 get_object_directory(), pattern);
282 safe_create_leading_directories(template);
283 return xmkstemp_mode(template, mode);
286 int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
288 int fd;
290 snprintf(name, namesz, "%s/pack/pack-%s.keep",
291 get_object_directory(), sha1_to_hex(sha1));
292 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
293 if (0 <= fd)
294 return fd;
296 /* slow path */
297 safe_create_leading_directories(name);
298 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
301 char *get_index_file(void)
303 if (!git_index_file)
304 setup_git_env();
305 return git_index_file;
308 char *get_graft_file(void)
310 if (!git_graft_file)
311 setup_git_env();
312 return git_graft_file;
315 int set_git_dir(const char *path)
317 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
318 return error("Could not set GIT_DIR to '%s'", path);
319 setup_git_env();
320 return 0;
323 const char *get_log_output_encoding(void)
325 return git_log_output_encoding ? git_log_output_encoding
326 : get_commit_output_encoding();
329 const char *get_commit_output_encoding(void)
331 return git_commit_encoding ? git_commit_encoding : "UTF-8";
334 static int the_shared_repository = PERM_UMASK;
335 static int need_shared_repository_from_config = 1;
337 void set_shared_repository(int value)
339 the_shared_repository = value;
340 need_shared_repository_from_config = 0;
343 int get_shared_repository(void)
345 if (need_shared_repository_from_config) {
346 const char *var = "core.sharedrepository";
347 const char *value;
348 if (!git_config_get_value(var, &value))
349 the_shared_repository = git_config_perm(var, value);
350 need_shared_repository_from_config = 0;
352 return the_shared_repository;
355 void reset_shared_repository(void)
357 need_shared_repository_from_config = 1;