Documentation: flesh out “git pull” description
[git/mingw.git] / environment.c
blob83d38d3c2354e8582d5af91c6d529a2f2836dc2c
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 repository_format_version;
25 const char *git_commit_encoding;
26 const char *git_log_output_encoding;
27 int shared_repository = PERM_UMASK;
28 const char *apply_default_whitespace;
29 const char *apply_default_ignorewhitespace;
30 int zlib_compression_level = Z_BEST_SPEED;
31 int core_compression_level;
32 int core_compression_seen;
33 int fsync_object_files;
34 size_t packed_git_window_size = DEFAULT_PACKED_GIT_WINDOW_SIZE;
35 size_t packed_git_limit = DEFAULT_PACKED_GIT_LIMIT;
36 size_t delta_base_cache_limit = 16 * 1024 * 1024;
37 const char *pager_program;
38 int pager_use_color = 1;
39 const char *editor_program;
40 const char *excludes_file;
41 enum auto_crlf auto_crlf = AUTO_CRLF_FALSE;
42 int read_replace_refs = 1;
43 enum eol eol = EOL_UNSET;
44 enum safe_crlf safe_crlf = SAFE_CRLF_WARN;
45 unsigned whitespace_rule_cfg = WS_DEFAULT_RULE;
46 enum branch_track git_branch_track = BRANCH_TRACK_REMOTE;
47 enum rebase_setup_type autorebase = AUTOREBASE_NEVER;
48 enum push_default_type push_default = PUSH_DEFAULT_MATCHING;
49 #ifndef OBJECT_CREATION_MODE
50 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
51 #endif
52 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
53 char *notes_ref_name;
54 int grafts_replace_parents = 1;
55 int core_apply_sparse_checkout;
57 /* Parallel index stat data preload? */
58 int core_preload_index = 0;
60 /* This is set by setup_git_dir_gently() and/or git_default_config() */
61 char *git_work_tree_cfg;
62 static char *work_tree;
64 static const char *git_dir;
65 static char *git_object_dir, *git_index_file, *git_refs_dir, *git_graft_file;
68 * Repository-local GIT_* environment variables
69 * Remember to update local_repo_env_size in cache.h when
70 * the size of the list changes
72 const char * const local_repo_env[LOCAL_REPO_ENV_SIZE + 1] = {
73 ALTERNATE_DB_ENVIRONMENT,
74 CONFIG_ENVIRONMENT,
75 DB_ENVIRONMENT,
76 GIT_DIR_ENVIRONMENT,
77 GIT_WORK_TREE_ENVIRONMENT,
78 GRAFT_ENVIRONMENT,
79 INDEX_ENVIRONMENT,
80 NO_REPLACE_OBJECTS_ENVIRONMENT,
81 NULL
84 static void setup_git_env(void)
86 git_dir = getenv(GIT_DIR_ENVIRONMENT);
87 if (!git_dir)
88 git_dir = read_gitfile_gently(DEFAULT_GIT_DIR_ENVIRONMENT);
89 if (!git_dir)
90 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
91 git_object_dir = getenv(DB_ENVIRONMENT);
92 if (!git_object_dir) {
93 git_object_dir = xmalloc(strlen(git_dir) + 9);
94 sprintf(git_object_dir, "%s/objects", git_dir);
96 git_refs_dir = xmalloc(strlen(git_dir) + 6);
97 sprintf(git_refs_dir, "%s/refs", git_dir);
98 git_index_file = getenv(INDEX_ENVIRONMENT);
99 if (!git_index_file) {
100 git_index_file = xmalloc(strlen(git_dir) + 7);
101 sprintf(git_index_file, "%s/index", git_dir);
103 git_graft_file = getenv(GRAFT_ENVIRONMENT);
104 if (!git_graft_file)
105 git_graft_file = git_pathdup("info/grafts");
106 if (getenv(NO_REPLACE_OBJECTS_ENVIRONMENT))
107 read_replace_refs = 0;
110 int is_bare_repository(void)
112 /* if core.bare is not 'false', let's see if there is a work tree */
113 return is_bare_repository_cfg && !get_git_work_tree();
116 int have_git_dir(void)
118 return !!git_dir;
121 const char *get_git_dir(void)
123 if (!git_dir)
124 setup_git_env();
125 return git_dir;
128 static int git_work_tree_initialized;
131 * Note. This works only before you used a work tree. This was added
132 * primarily to support git-clone to work in a new repository it just
133 * created, and is not meant to flip between different work trees.
135 void set_git_work_tree(const char *new_work_tree)
137 if (is_bare_repository_cfg >= 0)
138 die("cannot set work tree after initialization");
139 git_work_tree_initialized = 1;
140 free(work_tree);
141 work_tree = xstrdup(make_absolute_path(new_work_tree));
142 is_bare_repository_cfg = 0;
145 const char *get_git_work_tree(void)
147 if (!git_work_tree_initialized) {
148 work_tree = getenv(GIT_WORK_TREE_ENVIRONMENT);
149 /* core.bare = true overrides implicit and config work tree */
150 if (!work_tree && is_bare_repository_cfg < 1) {
151 work_tree = git_work_tree_cfg;
152 /* make_absolute_path also normalizes the path */
153 if (work_tree && !is_absolute_path(work_tree))
154 work_tree = xstrdup(make_absolute_path(git_path("%s", work_tree)));
155 } else if (work_tree)
156 work_tree = xstrdup(make_absolute_path(work_tree));
157 git_work_tree_initialized = 1;
158 if (work_tree)
159 is_bare_repository_cfg = 0;
161 return work_tree;
164 char *get_object_directory(void)
166 if (!git_object_dir)
167 setup_git_env();
168 return git_object_dir;
171 char *get_index_file(void)
173 if (!git_index_file)
174 setup_git_env();
175 return git_index_file;
178 char *get_graft_file(void)
180 if (!git_graft_file)
181 setup_git_env();
182 return git_graft_file;
185 int set_git_dir(const char *path)
187 if (setenv(GIT_DIR_ENVIRONMENT, path, 1))
188 return error("Could not set GIT_DIR to '%s'", path);
189 setup_git_env();
190 return 0;