Merge branch 'rt/help-strings-fix'
[alt-git.git] / environment.c
bloba533aed630c20a5e0718bcea4375875a44896416
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_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 char *git_replace_ref_base;
51 enum eol core_eol = EOL_UNSET;
52 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
53 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
54 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
55 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
56 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
57 #ifndef OBJECT_CREATION_MODE
58 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
59 #endif
60 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
61 char *notes_ref_name;
62 int grafts_replace_parents = 1;
63 int core_apply_sparse_checkout;
64 int merge_log_config = -1;
65 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
66 struct startup_info *startup_info;
67 unsigned long pack_size_limit_cfg;
69 #ifndef PROTECT_HFS_DEFAULT
70 #define PROTECT_HFS_DEFAULT 0
71 #endif
72 int protect_hfs = PROTECT_HFS_DEFAULT;
74 #ifndef PROTECT_NTFS_DEFAULT
75 #define PROTECT_NTFS_DEFAULT 0
76 #endif
77 int protect_ntfs = PROTECT_NTFS_DEFAULT;
80 * The character that begins a commented line in user-editable file
81 * that is subject to stripspace.
83 char comment_line_char = '#';
84 int auto_comment_line_char;
86 /* Parallel index stat data preload? */
87 int core_preload_index = 1;
89 /* This is set by setup_git_dir_gently() and/or git_default_config() */
90 char *git_work_tree_cfg;
91 static char *work_tree;
93 static const char *namespace;
94 static size_t namespace_len;
96 static const char *git_dir, *git_common_dir;
97 static char *git_object_dir, *git_index_file, *git_graft_file;
98 int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
101 * Repository-local GIT_* environment variables; see cache.h for details.
103 const char * const local_repo_env[] = {
104 ALTERNATE_DB_ENVIRONMENT,
105 CONFIG_ENVIRONMENT,
106 CONFIG_DATA_ENVIRONMENT,
107 DB_ENVIRONMENT,
108 GIT_DIR_ENVIRONMENT,
109 GIT_WORK_TREE_ENVIRONMENT,
110 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
111 GRAFT_ENVIRONMENT,
112 INDEX_ENVIRONMENT,
113 NO_REPLACE_OBJECTS_ENVIRONMENT,
114 GIT_REPLACE_REF_BASE_ENVIRONMENT,
115 GIT_PREFIX_ENVIRONMENT,
116 GIT_SHALLOW_FILE_ENVIRONMENT,
117 GIT_COMMON_DIR_ENVIRONMENT,
118 NULL
121 static char *expand_namespace(const char *raw_namespace)
123 struct strbuf buf = STRBUF_INIT;
124 struct strbuf **components, **c;
126 if (!raw_namespace || !*raw_namespace)
127 return xstrdup("");
129 strbuf_addstr(&buf, raw_namespace);
130 components = strbuf_split(&buf, '/');
131 strbuf_reset(&buf);
132 for (c = components; *c; c++)
133 if (strcmp((*c)->buf, "/") != 0)
134 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
135 strbuf_list_free(components);
136 if (check_refname_format(buf.buf, 0))
137 die("bad git namespace path \"%s\"", raw_namespace);
138 strbuf_addch(&buf, '/');
139 return strbuf_detach(&buf, NULL);
142 static char *git_path_from_env(const char *envvar, const char *git_dir,
143 const char *path, int *fromenv)
145 const char *value = getenv(envvar);
146 if (!value) {
147 char *buf = xmalloc(strlen(git_dir) + strlen(path) + 2);
148 sprintf(buf, "%s/%s", git_dir, path);
149 return buf;
151 if (fromenv)
152 *fromenv = 1;
153 return xstrdup(value);
156 static void setup_git_env(void)
158 struct strbuf sb = STRBUF_INIT;
159 const char *gitfile;
160 const char *shallow_file;
161 const char *replace_ref_base;
163 git_dir = getenv(GIT_DIR_ENVIRONMENT);
164 if (!git_dir)
165 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
166 gitfile = read_gitfile(git_dir);
167 git_dir = xstrdup(gitfile ? gitfile : git_dir);
168 if (get_common_dir(&sb, git_dir))
169 git_common_dir_env = 1;
170 git_common_dir = strbuf_detach(&sb, NULL);
171 git_object_dir = git_path_from_env(DB_ENVIRONMENT, git_common_dir,
172 "objects", &git_db_env);
173 git_index_file = git_path_from_env(INDEX_ENVIRONMENT, git_dir,
174 "index", &git_index_env);
175 git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, git_common_dir,
176 "info/grafts", &git_graft_env);
177 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
178 check_replace_refs = 0;
179 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
180 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
181 : "refs/replace/");
182 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
183 namespace_len = strlen(namespace);
184 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
185 if (shallow_file)
186 set_alternate_shallow_file(shallow_file, 0);
189 int is_bare_repository(void)
191 /* if core.bare is not 'false', let's see if there is a work tree */
192 return is_bare_repository_cfg && !get_git_work_tree();
195 const char *get_git_dir(void)
197 if (!git_dir)
198 setup_git_env();
199 return git_dir;
202 const char *get_git_common_dir(void)
204 return git_common_dir;
207 const char *get_git_namespace(void)
209 if (!namespace)
210 setup_git_env();
211 return namespace;
214 const char *strip_namespace(const char *namespaced_ref)
216 if (!starts_with(namespaced_ref, get_git_namespace()))
217 return NULL;
218 return namespaced_ref + namespace_len;
221 static int git_work_tree_initialized;
224 * Note. This works only before you used a work tree. This was added
225 * primarily to support git-clone to work in a new repository it just
226 * created, and is not meant to flip between different work trees.
228 void set_git_work_tree(const char *new_work_tree)
230 if (git_work_tree_initialized) {
231 new_work_tree = real_path(new_work_tree);
232 if (strcmp(new_work_tree, work_tree))
233 die("internal error: work tree has already been set\n"
234 "Current worktree: %s\nNew worktree: %s",
235 work_tree, new_work_tree);
236 return;
238 git_work_tree_initialized = 1;
239 work_tree = xstrdup(real_path(new_work_tree));
240 if (setenv(GIT_WORK_TREE_ENVIRONMENT, work_tree, 1))
241 die("could not set GIT_WORK_TREE to '%s'", work_tree);
244 const char *get_git_work_tree(void)
246 return work_tree;
249 char *get_object_directory(void)
251 if (!git_object_dir)
252 setup_git_env();
253 return git_object_dir;
256 int odb_mkstemp(char *template, size_t limit, const char *pattern)
258 int fd;
260 * we let the umask do its job, don't try to be more
261 * restrictive except to remove write permission.
263 int mode = 0444;
264 snprintf(template, limit, "%s/%s",
265 get_object_directory(), pattern);
266 fd = git_mkstemp_mode(template, mode);
267 if (0 <= fd)
268 return fd;
270 /* slow path */
271 /* some mkstemp implementations erase template on failure */
272 snprintf(template, limit, "%s/%s",
273 get_object_directory(), pattern);
274 safe_create_leading_directories(template);
275 return xmkstemp_mode(template, mode);
278 int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
280 int fd;
282 snprintf(name, namesz, "%s/pack/pack-%s.keep",
283 get_object_directory(), sha1_to_hex(sha1));
284 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
285 if (0 <= fd)
286 return fd;
288 /* slow path */
289 safe_create_leading_directories(name);
290 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
293 char *get_index_file(void)
295 if (!git_index_file)
296 setup_git_env();
297 return git_index_file;
300 char *get_graft_file(void)
302 if (!git_graft_file)
303 setup_git_env();
304 return git_graft_file;
307 int set_git_dir(const char *path)
309 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
310 return error("Could not set GIT_DIR to '%s'", path);
311 setup_git_env();
312 return 0;
315 const char *get_log_output_encoding(void)
317 return git_log_output_encoding ? git_log_output_encoding
318 : get_commit_output_encoding();
321 const char *get_commit_output_encoding(void)
323 return git_commit_encoding ? git_commit_encoding : "UTF-8";