doc: describe git svn init --ignore-refs
[git/git-svn.git] / environment.c
blobaa478e71de9d9c233593de050d6823e96be77b88
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 = -1;
20 int ignore_case;
21 int assume_unchanged;
22 int prefer_symlink_refs;
23 int is_bare_repository_cfg = -1; /* unspecified */
24 int warn_ambiguous_refs = 1;
25 int warn_on_object_refname_ambiguity = 1;
26 int ref_paranoia = -1;
27 int repository_format_precious_objects;
28 const char *git_commit_encoding;
29 const char *git_log_output_encoding;
30 const char *apply_default_whitespace;
31 const char *apply_default_ignorewhitespace;
32 const char *git_attributes_file;
33 const char *git_hooks_path;
34 int zlib_compression_level = Z_BEST_SPEED;
35 int core_compression_level;
36 int pack_compression_level = Z_DEFAULT_COMPRESSION;
37 int fsync_object_files;
38 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
39 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
40 size_t delta_base_cache_limit = 96 * 1024 * 1024;
41 unsigned long big_file_threshold = 512 * 1024 * 1024;
42 int pager_use_color = 1;
43 const char *editor_program;
44 const char *askpass_program;
45 const char *excludes_file;
46 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
47 int check_replace_refs = 1;
48 char *git_replace_ref_base;
49 enum eol core_eol = EOL_UNSET;
50 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
51 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
52 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
53 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
54 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
55 #ifndef OBJECT_CREATION_MODE
56 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
57 #endif
58 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
59 char *notes_ref_name;
60 int grafts_replace_parents = 1;
61 int core_apply_sparse_checkout;
62 int merge_log_config = -1;
63 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
64 unsigned long pack_size_limit_cfg;
65 enum hide_dotfiles_type hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
66 enum log_refs_config log_all_ref_updates = LOG_REFS_UNSET;
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 *super_prefix;
104 static const char *git_dir, *git_common_dir;
105 static char *git_object_dir, *git_index_file, *git_graft_file;
106 int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
109 * Repository-local GIT_* environment variables; see cache.h for details.
111 const char * const local_repo_env[] = {
112 ALTERNATE_DB_ENVIRONMENT,
113 CONFIG_ENVIRONMENT,
114 CONFIG_DATA_ENVIRONMENT,
115 DB_ENVIRONMENT,
116 GIT_DIR_ENVIRONMENT,
117 GIT_WORK_TREE_ENVIRONMENT,
118 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
119 GRAFT_ENVIRONMENT,
120 INDEX_ENVIRONMENT,
121 NO_REPLACE_OBJECTS_ENVIRONMENT,
122 GIT_REPLACE_REF_BASE_ENVIRONMENT,
123 GIT_PREFIX_ENVIRONMENT,
124 GIT_SUPER_PREFIX_ENVIRONMENT,
125 GIT_SHALLOW_FILE_ENVIRONMENT,
126 GIT_COMMON_DIR_ENVIRONMENT,
127 NULL
130 static char *expand_namespace(const char *raw_namespace)
132 struct strbuf buf = STRBUF_INIT;
133 struct strbuf **components, **c;
135 if (!raw_namespace || !*raw_namespace)
136 return xstrdup("");
138 strbuf_addstr(&buf, raw_namespace);
139 components = strbuf_split(&buf, '/');
140 strbuf_reset(&buf);
141 for (c = components; *c; c++)
142 if (strcmp((*c)->buf, "/") != 0)
143 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
144 strbuf_list_free(components);
145 if (check_refname_format(buf.buf, 0))
146 die("bad git namespace path \"%s\"", raw_namespace);
147 strbuf_addch(&buf, '/');
148 return strbuf_detach(&buf, NULL);
151 static char *git_path_from_env(const char *envvar, const char *git_dir,
152 const char *path, int *fromenv)
154 const char *value = getenv(envvar);
155 if (!value)
156 return xstrfmt("%s/%s", git_dir, path);
157 if (fromenv)
158 *fromenv = 1;
159 return xstrdup(value);
162 static void setup_git_env(void)
164 struct strbuf sb = STRBUF_INIT;
165 const char *gitfile;
166 const char *shallow_file;
167 const char *replace_ref_base;
169 git_dir = getenv(GIT_DIR_ENVIRONMENT);
170 if (!git_dir) {
171 if (!startup_info->have_repository)
172 BUG("setup_git_env called without repository");
173 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
175 gitfile = read_gitfile(git_dir);
176 git_dir = xstrdup(gitfile ? gitfile : git_dir);
177 if (get_common_dir(&sb, git_dir))
178 git_common_dir_env = 1;
179 git_common_dir = strbuf_detach(&sb, NULL);
180 git_object_dir = git_path_from_env(DB_ENVIRONMENT, git_common_dir,
181 "objects", &git_db_env);
182 git_index_file = git_path_from_env(INDEX_ENVIRONMENT, git_dir,
183 "index", &git_index_env);
184 git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, git_common_dir,
185 "info/grafts", &git_graft_env);
186 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
187 check_replace_refs = 0;
188 replace_ref_base = getenv(GIT_REPLACE_REF_BASE_ENVIRONMENT);
189 git_replace_ref_base = xstrdup(replace_ref_base ? replace_ref_base
190 : "refs/replace/");
191 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
192 namespace_len = strlen(namespace);
193 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
194 if (shallow_file)
195 set_alternate_shallow_file(shallow_file, 0);
198 int is_bare_repository(void)
200 /* if core.bare is not 'false', let's see if there is a work tree */
201 return is_bare_repository_cfg && !get_git_work_tree();
204 int have_git_dir(void)
206 return startup_info->have_repository
207 || git_dir
208 || getenv(GIT_DIR_ENVIRONMENT);
211 const char *get_git_dir(void)
213 if (!git_dir)
214 setup_git_env();
215 return git_dir;
218 const char *get_git_common_dir(void)
220 if (!git_dir)
221 setup_git_env();
222 return git_common_dir;
225 const char *get_git_namespace(void)
227 if (!namespace)
228 setup_git_env();
229 return namespace;
232 const char *strip_namespace(const char *namespaced_ref)
234 if (!starts_with(namespaced_ref, get_git_namespace()))
235 return NULL;
236 return namespaced_ref + namespace_len;
239 const char *get_super_prefix(void)
241 static int initialized;
242 if (!initialized) {
243 super_prefix = getenv(GIT_SUPER_PREFIX_ENVIRONMENT);
244 initialized = 1;
246 return super_prefix;
249 static int git_work_tree_initialized;
252 * Note. This works only before you used a work tree. This was added
253 * primarily to support git-clone to work in a new repository it just
254 * created, and is not meant to flip between different work trees.
256 void set_git_work_tree(const char *new_work_tree)
258 if (git_work_tree_initialized) {
259 new_work_tree = real_path(new_work_tree);
260 if (strcmp(new_work_tree, work_tree))
261 die("internal error: work tree has already been set\n"
262 "Current worktree: %s\nNew worktree: %s",
263 work_tree, new_work_tree);
264 return;
266 git_work_tree_initialized = 1;
267 work_tree = real_pathdup(new_work_tree, 1);
270 const char *get_git_work_tree(void)
272 return work_tree;
275 char *get_object_directory(void)
277 if (!git_object_dir)
278 setup_git_env();
279 return git_object_dir;
282 int odb_mkstemp(struct strbuf *template, const char *pattern)
284 int fd;
286 * we let the umask do its job, don't try to be more
287 * restrictive except to remove write permission.
289 int mode = 0444;
290 git_path_buf(template, "objects/%s", pattern);
291 fd = git_mkstemp_mode(template->buf, mode);
292 if (0 <= fd)
293 return fd;
295 /* slow path */
296 /* some mkstemp implementations erase template on failure */
297 git_path_buf(template, "objects/%s", pattern);
298 safe_create_leading_directories(template->buf);
299 return xmkstemp_mode(template->buf, mode);
302 int odb_pack_keep(const char *name)
304 int fd;
306 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
307 if (0 <= fd)
308 return fd;
310 /* slow path */
311 safe_create_leading_directories_const(name);
312 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
315 char *get_index_file(void)
317 if (!git_index_file)
318 setup_git_env();
319 return git_index_file;
322 char *get_graft_file(void)
324 if (!git_graft_file)
325 setup_git_env();
326 return git_graft_file;
329 int set_git_dir(const char *path)
331 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
332 return error("Could not set GIT_DIR to '%s'", path);
333 setup_git_env();
334 return 0;
337 const char *get_log_output_encoding(void)
339 return git_log_output_encoding ? git_log_output_encoding
340 : get_commit_output_encoding();
343 const char *get_commit_output_encoding(void)
345 return git_commit_encoding ? git_commit_encoding : "UTF-8";
348 static int the_shared_repository = PERM_UMASK;
349 static int need_shared_repository_from_config = 1;
351 void set_shared_repository(int value)
353 the_shared_repository = value;
354 need_shared_repository_from_config = 0;
357 int get_shared_repository(void)
359 if (need_shared_repository_from_config) {
360 const char *var = "core.sharedrepository";
361 const char *value;
362 if (!git_config_get_value(var, &value))
363 the_shared_repository = git_config_perm(var, value);
364 need_shared_repository_from_config = 0;
366 return the_shared_repository;
369 void reset_shared_repository(void)
371 need_shared_repository_from_config = 1;