Documentation updates for 'GIT_WORK_TREE without GIT_DIR' historical usecase
[git/jnareb-git/bp-gitweb.git] / environment.c
blob9564475f429312a467a020106f7443112367d5da
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"
12 char git_default_email[MAX_GITNAME];
13 char git_default_name[MAX_GITNAME];
14 int user_ident_explicitly_given;
15 int trust_executable_bit = 1;
16 int trust_ctime = 1;
17 int has_symlinks = 1;
18 int ignore_case;
19 int assume_unchanged;
20 int prefer_symlink_refs;
21 int is_bare_repository_cfg = -1; /* unspecified */
22 int log_all_ref_updates = -1; /* unspecified */
23 int warn_ambiguous_refs = 1;
24 int unique_abbrev_extra_length;
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 int zlib_compression_level = Z_BEST_SPEED;
32 int core_compression_level;
33 int core_compression_seen;
34 int fsync_object_files;
35 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
36 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
37 size_t delta_base_cache_limit = 16 * 1024 * 1024;
38 const char *pager_program;
39 int pager_use_color = 1;
40 const char *editor_program;
41 const char *askpass_program;
42 const char *excludes_file;
43 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
44 int read_replace_refs = 1;
45 enum eol eol = EOL_UNSET;
46 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
47 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
48 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
49 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
50 enum push_default_type push_default = PUSH_DEFAULT_MATCHING;
51 #ifndef OBJECT_CREATION_MODE
52 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
53 #endif
54 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
55 char *notes_ref_name;
56 int grafts_replace_parents = 1;
57 int core_apply_sparse_checkout;
58 struct startup_info *startup_info;
60 /* Parallel index stat data preload? */
61 int core_preload_index = 0;
63 /* This is set by setup_git_dir_gently() and/or git_default_config() */
64 char *git_work_tree_cfg;
65 static char *work_tree;
67 static const char *git_dir;
68 static char *git_object_dir, *git_index_file, *git_graft_file;
71 * Repository-local GIT_* environment variables
72 * Remember to update local_repo_env_size in cache.h when
73 * the size of the list changes
75 const char * const local_repo_env[LOCAL_REPO_ENV_SIZE + 1] = {
76 ALTERNATE_DB_ENVIRONMENT,
77 CONFIG_ENVIRONMENT,
78 CONFIG_DATA_ENVIRONMENT,
79 DB_ENVIRONMENT,
80 GIT_DIR_ENVIRONMENT,
81 GIT_WORK_TREE_ENVIRONMENT,
82 GRAFT_ENVIRONMENT,
83 INDEX_ENVIRONMENT,
84 NO_REPLACE_OBJECTS_ENVIRONMENT,
85 NULL
88 static void setup_git_env(void)
90 git_dir = getenv(GIT_DIR_ENVIRONMENT);
91 git_dir = git_dir ? xstrdup(git_dir) : NULL;
92 if (!git_dir) {
93 git_dir = read_gitfile_gently(DEFAULT_GIT_DIR_ENVIRONMENT);
94 git_dir = git_dir ? xstrdup(git_dir) : NULL;
96 if (!git_dir)
97 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
98 git_object_dir = getenv(DB_ENVIRONMENT);
99 if (!git_object_dir) {
100 git_object_dir = xmalloc(strlen(git_dir) + 9);
101 sprintf(git_object_dir, "%s/objects", git_dir);
103 git_index_file = getenv(INDEX_ENVIRONMENT);
104 if (!git_index_file) {
105 git_index_file = xmalloc(strlen(git_dir) + 7);
106 sprintf(git_index_file, "%s/index", git_dir);
108 git_graft_file = getenv(GRAFT_ENVIRONMENT);
109 if (!git_graft_file)
110 git_graft_file = git_pathdup("info/grafts");
111 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
112 read_replace_refs = 0;
115 int is_bare_repository(void)
117 /* if core.bare is not 'false', let's see if there is a work tree */
118 return is_bare_repository_cfg && !get_git_work_tree();
121 int have_git_dir(void)
123 return !!git_dir;
126 const char *get_git_dir(void)
128 if (!git_dir)
129 setup_git_env();
130 return git_dir;
133 static int git_work_tree_initialized;
136 * Note. This works only before you used a work tree. This was added
137 * primarily to support git-clone to work in a new repository it just
138 * created, and is not meant to flip between different work trees.
140 void set_git_work_tree(const char *new_work_tree)
142 if (git_work_tree_initialized) {
143 new_work_tree = make_absolute_path(new_work_tree);
144 if (strcmp(new_work_tree, work_tree))
145 die("internal error: work tree has already been set\n"
146 "Current worktree: %s\nNew worktree: %s",
147 work_tree, new_work_tree);
148 return;
150 git_work_tree_initialized = 1;
151 work_tree = xstrdup(make_absolute_path(new_work_tree));
154 const char *get_git_work_tree(void)
156 return work_tree;
159 char *get_object_directory(void)
161 if (!git_object_dir)
162 setup_git_env();
163 return git_object_dir;
166 int odb_mkstemp(char *template, size_t limit, const char *pattern)
168 int fd;
170 * we let the umask do its job, don't try to be more
171 * restrictive except to remove write permission.
173 int mode = 0444;
174 snprintf(template, limit, "%s/%s",
175 get_object_directory(), pattern);
176 fd = git_mkstemp_mode(template, mode);
177 if (0 <= fd)
178 return fd;
180 /* slow path */
181 /* some mkstemp implementations erase template on failure */
182 snprintf(template, limit, "%s/%s",
183 get_object_directory(), pattern);
184 safe_create_leading_directories(template);
185 return xmkstemp_mode(template, mode);
188 int odb_pack_keep(char *name, size_t namesz, unsigned char *sha1)
190 int fd;
192 snprintf(name, namesz, "%s/pack/pack-%s.keep",
193 get_object_directory(), sha1_to_hex(sha1));
194 fd = open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
195 if (0 <= fd)
196 return fd;
198 /* slow path */
199 safe_create_leading_directories(name);
200 return open(name, O_RDWR|O_CREAT|O_EXCL, 0600);
203 char *get_index_file(void)
205 if (!git_index_file)
206 setup_git_env();
207 return git_index_file;
210 char *get_graft_file(void)
212 if (!git_graft_file)
213 setup_git_env();
214 return git_graft_file;
217 int set_git_dir(const char *path)
219 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
220 return error("Could not set GIT_DIR to '%s'", path);
221 setup_git_env();
222 return 0;
225 const char *get_log_output_encoding(void)
227 return git_log_output_encoding ? git_log_output_encoding
228 : get_commit_output_encoding();
231 const char *get_commit_output_encoding(void)
233 return git_commit_encoding ? git_commit_encoding : "UTF-8";