Documentation: fix section header mark-up
[git/raj.git] / environment.c
blob9daa0ba4a36ced9f63541203e7bcc2ab9e1eae56
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 = 16 * 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 = '#';
83 /* Parallel index stat data preload? */
84 int core_preload_index = 0;
86 /* This is set by setup_git_dir_gently() and/or git_default_config() */
87 char *git_work_tree_cfg;
88 static char *work_tree;
90 static const char *namespace;
91 static size_t namespace_len;
93 static const char *git_dir;
94 static char *git_object_dir, *git_index_file, *git_graft_file;
97 * Repository-local GIT_* environment variables; see cache.h for details.
99 const char * const local_repo_env[] = {
100 ALTERNATE_DB_ENVIRONMENT,
101 CONFIG_ENVIRONMENT,
102 CONFIG_DATA_ENVIRONMENT,
103 DB_ENVIRONMENT,
104 GIT_DIR_ENVIRONMENT,
105 GIT_WORK_TREE_ENVIRONMENT,
106 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
107 GRAFT_ENVIRONMENT,
108 INDEX_ENVIRONMENT,
109 NO_REPLACE_OBJECTS_ENVIRONMENT,
110 GIT_PREFIX_ENVIRONMENT,
111 GIT_SHALLOW_FILE_ENVIRONMENT,
112 NULL
115 static char *expand_namespace(const char *raw_namespace)
117 struct strbuf buf = STRBUF_INIT;
118 struct strbuf **components, **c;
120 if (!raw_namespace || !*raw_namespace)
121 return xstrdup("");
123 strbuf_addstr(&buf, raw_namespace);
124 components = strbuf_split(&buf, '/');
125 strbuf_reset(&buf);
126 for (c = components; *c; c++)
127 if (strcmp((*c)->buf, "/") != 0)
128 strbuf_addf(&buf, "refs/namespaces/%s", (*c)->buf);
129 strbuf_list_free(components);
130 if (check_refname_format(buf.buf, 0))
131 die("bad git namespace path \"%s\"", raw_namespace);
132 strbuf_addch(&buf, '/');
133 return strbuf_detach(&buf, NULL);
136 static void setup_git_env(void)
138 const char *gitfile;
139 const char *shallow_file;
141 git_dir = getenv(GIT_DIR_ENVIRONMENT);
142 if (!git_dir)
143 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
144 gitfile = read_gitfile(git_dir);
145 git_dir = xstrdup(gitfile ? gitfile : git_dir);
146 git_object_dir = getenv(DB_ENVIRONMENT);
147 if (!git_object_dir) {
148 git_object_dir = xmalloc(strlen(git_dir) + 9);
149 sprintf(git_object_dir, "%s/objects", git_dir);
151 git_index_file = getenv(INDEX_ENVIRONMENT);
152 if (!git_index_file) {
153 git_index_file = xmalloc(strlen(git_dir) + 7);
154 sprintf(git_index_file, "%s/index", git_dir);
156 git_graft_file = getenv(GRAFT_ENVIRONMENT);
157 if (!git_graft_file)
158 git_graft_file = git_pathdup("info/grafts");
159 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
160 check_replace_refs = 0;
161 namespace = expand_namespace(getenv(GIT_NAMESPACE_ENVIRONMENT));
162 namespace_len = strlen(namespace);
163 shallow_file = getenv(GIT_SHALLOW_FILE_ENVIRONMENT);
164 if (shallow_file)
165 set_alternate_shallow_file(shallow_file, 0);
168 int is_bare_repository(void)
170 /* if core.bare is not 'false', let's see if there is a work tree */
171 return is_bare_repository_cfg && !get_git_work_tree();
174 const char *get_git_dir(void)
176 if (!git_dir)
177 setup_git_env();
178 return git_dir;
181 const char *get_git_namespace(void)
183 if (!namespace)
184 setup_git_env();
185 return namespace;
188 const char *strip_namespace(const char *namespaced_ref)
190 if (!starts_with(namespaced_ref, get_git_namespace()))
191 return NULL;
192 return namespaced_ref + namespace_len;
195 static int git_work_tree_initialized;
198 * Note. This works only before you used a work tree. This was added
199 * primarily to support git-clone to work in a new repository it just
200 * created, and is not meant to flip between different work trees.
202 void set_git_work_tree(const char *new_work_tree)
204 if (git_work_tree_initialized) {
205 new_work_tree = real_path(new_work_tree);
206 if (strcmp(new_work_tree, work_tree))
207 die("internal error: work tree has already been set\n"
208 "Current worktree: %s\nNew worktree: %s",
209 work_tree, new_work_tree);
210 return;
212 git_work_tree_initialized = 1;
213 work_tree = xstrdup(real_path(new_work_tree));
216 const char *get_git_work_tree(void)
218 return work_tree;
221 char *get_object_directory(void)
223 if (!git_object_dir)
224 setup_git_env();
225 return git_object_dir;
228 int odb_mkstemp(char *template, size_t limit, const char *pattern)
230 int fd;
232 * we let the umask do its job, don't try to be more
233 * restrictive except to remove write permission.
235 int mode = 0444;
236 snprintf(template, limit, "%s/%s",
237 get_object_directory(), pattern);
238 fd = git_mkstemp_mode(template, mode);
239 if (0 <= fd)
240 return fd;
242 /* slow path */
243 /* some mkstemp implementations erase template on failure */
244 snprintf(template, limit, "%s/%s",
245 get_object_directory(), pattern);
246 safe_create_leading_directories(template);
247 return xmkstemp_mode(template, mode);
250 int odb_pack_keep(char *name, size_t namesz, const unsigned char *sha1)
252 int fd;
254 snprintf(name, namesz, "%s/pack/pack-%s.keep",
255 get_object_directory(), sha1_to_hex(sha1));
256 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
257 if (0 <= fd)
258 return fd;
260 /* slow path */
261 safe_create_leading_directories(name);
262 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
265 char *get_index_file(void)
267 if (!git_index_file)
268 setup_git_env();
269 return git_index_file;
272 char *get_graft_file(void)
274 if (!git_graft_file)
275 setup_git_env();
276 return git_graft_file;
279 int set_git_dir(const char *path)
281 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
282 return error("Could not set GIT_DIR to '%s'", path);
283 setup_git_env();
284 return 0;
287 const char *get_log_output_encoding(void)
289 return git_log_output_encoding ? git_log_output_encoding
290 : get_commit_output_encoding();
293 const char *get_commit_output_encoding(void)
295 return git_commit_encoding ? git_commit_encoding : "UTF-8";