Merge branch 'jk/remote-helpers-doc'
[git/debian.git] / environment.c
blob89d6c70c15a95aff82f0063e3c0dd6bdab026213
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"
14 int trust_executable_bit = 1;
15 int trust_ctime = 1;
16 int check_stat = 1;
17 int has_symlinks = 1;
18 int minimum_abbrev = 4, default_abbrev = 7;
19 int ignore_case;
20 int assume_unchanged;
21 int prefer_symlink_refs;
22 int is_bare_repository_cfg = -1; /* unspecified */
23 int log_all_ref_updates = -1; /* unspecified */
24 int warn_ambiguous_refs = 1;
25 int repository_format_version;
26 const char *git_commit_encoding;
27 const char *git_log_output_encoding;
28 int shared_repository = PERM_UMASK;
29 const char *apply_default_whitespace;
30 const char *apply_default_ignorewhitespace;
31 const char *git_attributes_file;
32 int zlib_compression_level = Z_BEST_SPEED;
33 int core_compression_level;
34 int core_compression_seen;
35 int fsync_object_files;
36 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
37 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
38 size_t delta_base_cache_limit = 16 * 1024 * 1024;
39 unsigned long big_file_threshold = 512 * 1024 * 1024;
40 const char *log_pack_access;
41 const char *pager_program;
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 read_replace_refs = 1; /* NEEDSWORK: rename to use_replace_refs */
48 enum eol core_eol = EOL_UNSET;
49 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
50 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
51 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
52 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
53 enum push_default_type push_default = PUSH_DEFAULT_UNSPECIFIED;
54 #ifndef OBJECT_CREATION_MODE
55 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
56 #endif
57 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
58 char *notes_ref_name;
59 int grafts_replace_parents = 1;
60 int core_apply_sparse_checkout;
61 int merge_log_config = -1;
62 int precomposed_unicode = -1; /* see probe_utf8_pathname_composition() */
63 struct startup_info *startup_info;
64 unsigned long pack_size_limit_cfg;
67 * The character that begins a commented line in user-editable file
68 * that is subject to stripspace.
70 char comment_line_char = '#';
72 /* Parallel index stat data preload? */
73 int core_preload_index = 0;
75 /* This is set by setup_git_dir_gently() and/or git_default_config() */
76 char *git_work_tree_cfg;
77 static char *work_tree;
79 static const char *namespace;
80 static size_t namespace_len;
82 static const char *git_dir;
83 static char *git_object_dir, *git_index_file, *git_graft_file;
86 * Repository-local GIT_* environment variables
87 * Remember to update local_repo_env_size in cache.h when
88 * the size of the list changes
90 const char * const local_repo_env[LOCAL_REPO_ENV_SIZE + 1] = {
91 ALTERNATE_DB_ENVIRONMENT,
92 CONFIG_ENVIRONMENT,
93 CONFIG_DATA_ENVIRONMENT,
94 DB_ENVIRONMENT,
95 GIT_DIR_ENVIRONMENT,
96 GIT_WORK_TREE_ENVIRONMENT,
97 GRAFT_ENVIRONMENT,
98 INDEX_ENVIRONMENT,
99 NO_REPLACE_OBJECTS_ENVIRONMENT,
100 NULL
103 static char *expand_namespace(const char *raw_namespace)
105 struct strbuf buf = STRBUF_INIT;
106 struct strbuf **components, **c;
108 if (!raw_namespace || !*raw_namespace)
109 return xstrdup("");
111 strbuf_addstr(&buf, raw_namespace);
112 components = strbuf_split(&buf, '/');
113 strbuf_reset(&buf);
114 for (c = components; *c; c++)
115 if (strcmp((*c)->buf, "/") != 0)
116 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
117 strbuf_list_free(components);
118 if (check_refname_format(buf.buf, 0))
119 die("bad git namespace path \"%s\"", raw_namespace);
120 strbuf_addch(&buf, '/');
121 return strbuf_detach(&buf, NULL);
124 static void setup_git_env(void)
126 git_dir = getenv(GIT_DIR_ENVIRONMENT);
127 git_dir = git_dir ? xstrdup(git_dir) : NULL;
128 if (!git_dir) {
129 git_dir = read_gitfile(DEFAULT_GIT_DIR_ENVIRONMENT);
130 git_dir = git_dir ? xstrdup(git_dir) : NULL;
132 if (!git_dir)
133 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
134 git_object_dir = getenv(DB_ENVIRONMENT);
135 if (!git_object_dir) {
136 git_object_dir = xmalloc(strlen(git_dir) + 9);
137 sprintf(git_object_dir, "%s/objects", git_dir);
139 git_index_file = getenv(INDEX_ENVIRONMENT);
140 if (!git_index_file) {
141 git_index_file = xmalloc(strlen(git_dir) + 7);
142 sprintf(git_index_file, "%s/index", git_dir);
144 git_graft_file = getenv(GRAFT_ENVIRONMENT);
145 if (!git_graft_file)
146 git_graft_file = git_pathdup("info/grafts");
147 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
148 read_replace_refs = 0;
149 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
150 namespace_len = strlen(namespace);
153 int is_bare_repository(void)
155 /* if core.bare is not 'false', let's see if there is a work tree */
156 return is_bare_repository_cfg && !get_git_work_tree();
159 int have_git_dir(void)
161 return !!git_dir;
164 const char *get_git_dir(void)
166 if (!git_dir)
167 setup_git_env();
168 return git_dir;
171 const char *get_git_namespace(void)
173 if (!namespace)
174 setup_git_env();
175 return namespace;
178 const char *strip_namespace(const char *namespaced_ref)
180 if (prefixcmp(namespaced_ref, get_git_namespace()) != 0)
181 return NULL;
182 return namespaced_ref + namespace_len;
185 static int git_work_tree_initialized;
188 * Note. This works only before you used a work tree. This was added
189 * primarily to support git-clone to work in a new repository it just
190 * created, and is not meant to flip between different work trees.
192 void set_git_work_tree(const char *new_work_tree)
194 if (git_work_tree_initialized) {
195 new_work_tree = real_path(new_work_tree);
196 if (strcmp(new_work_tree, work_tree))
197 die("internal error: work tree has already been set\n"
198 "Current worktree: %s\nNew worktree: %s",
199 work_tree, new_work_tree);
200 return;
202 git_work_tree_initialized = 1;
203 work_tree = xstrdup(real_path(new_work_tree));
206 const char *get_git_work_tree(void)
208 return work_tree;
211 char *get_object_directory(void)
213 if (!git_object_dir)
214 setup_git_env();
215 return git_object_dir;
218 int odb_mkstemp(char *template, size_t limit, const char *pattern)
220 int fd;
222 * we let the umask do its job, don't try to be more
223 * restrictive except to remove write permission.
225 int mode = 0444;
226 snprintf(template, limit, "%s/%s",
227 get_object_directory(), pattern);
228 fd = git_mkstemp_mode(template, mode);
229 if (0 <= fd)
230 return fd;
232 /* slow path */
233 /* some mkstemp implementations erase template on failure */
234 snprintf(template, limit, "%s/%s",
235 get_object_directory(), pattern);
236 safe_create_leading_directories(template);
237 return xmkstemp_mode(template, mode);
240 int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1)
242 int fd;
244 snprintf(name, namesz, "%s/pack/pack-%s.keep",
245 get_object_directory(), sha1_to_hex(sha1));
246 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
247 if (0 <= fd)
248 return fd;
250 /* slow path */
251 safe_create_leading_directories(name);
252 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
255 char *get_index_file(void)
257 if (!git_index_file)
258 setup_git_env();
259 return git_index_file;
262 char *get_graft_file(void)
264 if (!git_graft_file)
265 setup_git_env();
266 return git_graft_file;
269 int set_git_dir(const char *path)
271 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
272 return error("Could not set GIT_DIR to '%s'", path);
273 setup_git_env();
274 return 0;
277 const char *get_log_output_encoding(void)
279 return git_log_output_encoding ? git_log_output_encoding
280 : get_commit_output_encoding();
283 const char *get_commit_output_encoding(void)
285 return git_commit_encoding ? git_commit_encoding : "UTF-8";