Documentation/describe: improve one-line summary
[git.git] / environment.c
blob1ade5c9684a9f901db7d0b3fff04d0cad443caf7
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 repository_format_version;
28 const char *git_commit_encoding;
29 const char *git_log_output_encoding;
30 int shared_repository = PERM_UMASK;
31 const char *apply_default_whitespace;
32 const char *apply_default_ignorewhitespace;
33 const char *git_attributes_file;
34 int zlib_compression_level = Z_BEST_SPEED;
35 int core_compression_level;
36 int core_compression_seen;
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 const char *pager_program;
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 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 struct startup_info *startup_info;
65 unsigned long pack_size_limit_cfg;
67 #ifndef PROTECT_HFS_DEFAULT
68 #define PROTECT_HFS_DEFAULT 0
69 #endif
70 int protect_hfs = PROTECT_HFS_DEFAULT;
72 #ifndef PROTECT_NTFS_DEFAULT
73 #define PROTECT_NTFS_DEFAULT 0
74 #endif
75 int protect_ntfs = PROTECT_NTFS_DEFAULT;
78 * The character that begins a commented line in user-editable file
79 * that is subject to stripspace.
81 char comment_line_char = '#';
82 int auto_comment_line_char;
84 /* Parallel index stat data preload? */
85 int core_preload_index = 1;
87 /* This is set by setup_git_dir_gently() and/or git_default_config() */
88 char *git_work_tree_cfg;
89 static char *work_tree;
91 static const char *namespace;
92 static size_t namespace_len;
94 static const char *git_dir;
95 static char *git_object_dir, *git_index_file, *git_graft_file;
98 * Repository-local GIT_* environment variables; see cache.h for details.
100 const char * const local_repo_env[] = {
101 ALTERNATE_DB_ENVIRONMENT,
102 CONFIG_ENVIRONMENT,
103 CONFIG_DATA_ENVIRONMENT,
104 DB_ENVIRONMENT,
105 GIT_DIR_ENVIRONMENT,
106 GIT_WORK_TREE_ENVIRONMENT,
107 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
108 GRAFT_ENVIRONMENT,
109 INDEX_ENVIRONMENT,
110 NO_REPLACE_OBJECTS_ENVIRONMENT,
111 GIT_PREFIX_ENVIRONMENT,
112 GIT_SHALLOW_FILE_ENVIRONMENT,
113 NULL
116 static char *expand_namespace(const char *raw_namespace)
118 struct strbuf buf = STRBUF_INIT;
119 struct strbuf **components, **c;
121 if (!raw_namespace || !*raw_namespace)
122 return xstrdup("");
124 strbuf_addstr(&buf, raw_namespace);
125 components = strbuf_split(&buf, '/');
126 strbuf_reset(&buf);
127 for (c = components; *c; c++)
128 if (strcmp((*c)->buf, "/") != 0)
129 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
130 strbuf_list_free(components);
131 if (check_refname_format(buf.buf, 0))
132 die("bad git namespace path \"%s\"", raw_namespace);
133 strbuf_addch(&buf, '/');
134 return strbuf_detach(&buf, NULL);
137 static char *git_path_from_env(const char *envvar, const char *path)
139 const char *value = getenv(envvar);
140 return value ? xstrdup(value) : git_pathdup("%s", path);
143 static void setup_git_env(void)
145 const char *gitfile;
146 const char *shallow_file;
148 git_dir = getenv(GIT_DIR_ENVIRONMENT);
149 if (!git_dir)
150 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
151 gitfile = read_gitfile(git_dir);
152 git_dir = xstrdup(gitfile ? gitfile : git_dir);
153 git_object_dir = git_path_from_env(DB_ENVIRONMENT, "objects");
154 git_index_file = git_path_from_env(INDEX_ENVIRONMENT, "index");
155 git_graft_file = git_path_from_env(GRAFT_ENVIRONMENT, "info/grafts");
156 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
157 check_replace_refs = 0;
158 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
159 namespace_len = strlen(namespace);
160 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
161 if (shallow_file)
162 set_alternate_shallow_file(shallow_file, 0);
165 int is_bare_repository(void)
167 /* if core.bare is not 'false', let's see if there is a work tree */
168 return is_bare_repository_cfg && !get_git_work_tree();
171 const char *get_git_dir(void)
173 if (!git_dir)
174 setup_git_env();
175 return git_dir;
178 const char *get_git_namespace(void)
180 if (!namespace)
181 setup_git_env();
182 return namespace;
185 const char *strip_namespace(const char *namespaced_ref)
187 if (!starts_with(namespaced_ref, get_git_namespace()))
188 return NULL;
189 return namespaced_ref + namespace_len;
192 static int git_work_tree_initialized;
195 * Note. This works only before you used a work tree. This was added
196 * primarily to support git-clone to work in a new repository it just
197 * created, and is not meant to flip between different work trees.
199 void set_git_work_tree(const char *new_work_tree)
201 if (git_work_tree_initialized) {
202 new_work_tree = real_path(new_work_tree);
203 if (strcmp(new_work_tree, work_tree))
204 die("internal error: work tree has already been set\n"
205 "Current worktree: %s\nNew worktree: %s",
206 work_tree, new_work_tree);
207 return;
209 git_work_tree_initialized = 1;
210 work_tree = xstrdup(real_path(new_work_tree));
213 const char *get_git_work_tree(void)
215 return work_tree;
218 char *get_object_directory(void)
220 if (!git_object_dir)
221 setup_git_env();
222 return git_object_dir;
225 int odb_mkstemp(char *template, size_t limit, const char *pattern)
227 int fd;
229 * we let the umask do its job, don't try to be more
230 * restrictive except to remove write permission.
232 int mode = 0444;
233 snprintf(template, limit, "%s/%s",
234 get_object_directory(), pattern);
235 fd = git_mkstemp_mode(template, mode);
236 if (0 <= fd)
237 return fd;
239 /* slow path */
240 /* some mkstemp implementations erase template on failure */
241 snprintf(template, limit, "%s/%s",
242 get_object_directory(), pattern);
243 safe_create_leading_directories(template);
244 return xmkstemp_mode(template, mode);
247 int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
249 int fd;
251 snprintf(name, namesz, "%s/pack/pack-%s.keep",
252 get_object_directory(), sha1_to_hex(sha1));
253 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
254 if (0 <= fd)
255 return fd;
257 /* slow path */
258 safe_create_leading_directories(name);
259 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
262 char *get_index_file(void)
264 if (!git_index_file)
265 setup_git_env();
266 return git_index_file;
269 char *get_graft_file(void)
271 if (!git_graft_file)
272 setup_git_env();
273 return git_graft_file;
276 int set_git_dir(const char *path)
278 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
279 return error("Could not set GIT_DIR to '%s'", path);
280 setup_git_env();
281 return 0;
284 const char *get_log_output_encoding(void)
286 return git_log_output_encoding ? git_log_output_encoding
287 : get_commit_output_encoding();
290 const char *get_commit_output_encoding(void)
292 return git_commit_encoding ? git_commit_encoding : "UTF-8";