2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
13 struct config_source {
14 struct config_source *prev;
30 int (*do_fgetc)(struct config_source *c);
31 int (*do_ungetc)(int c, struct config_source *conf);
32 long (*do_ftell)(struct config_source *c);
35 static struct config_source *cf;
37 static int zlib_compression_seen;
39 static int config_file_fgetc(struct config_source *conf)
41 return fgetc(conf->u.file);
44 static int config_file_ungetc(int c, struct config_source *conf)
46 return ungetc(c, conf->u.file);
49 static long config_file_ftell(struct config_source *conf)
51 return ftell(conf->u.file);
55 static int config_buf_fgetc(struct config_source *conf)
57 if (conf->u.buf.pos < conf->u.buf.len)
58 return conf->u.buf.buf[conf->u.buf.pos++];
63 static int config_buf_ungetc(int c, struct config_source *conf)
65 if (conf->u.buf.pos > 0)
66 return conf->u.buf.buf[--conf->u.buf.pos];
71 static long config_buf_ftell(struct config_source *conf)
73 return conf->u.buf.pos;
76 #define MAX_INCLUDE_DEPTH 10
77 static const char include_depth_advice[] =
78 "exceeded maximum include depth (%d) while including\n"
82 "Do you have circular includes?";
83 static int handle_path_include(const char *path, struct config_include_data *inc)
86 struct strbuf buf = STRBUF_INIT;
90 return config_error_nonbool("include.path");
92 expanded = expand_user_path(path);
94 return error("Could not expand include path '%s'", path);
98 * Use an absolute path as-is, but interpret relative paths
99 * based on the including config file.
101 if (!is_absolute_path(path)) {
104 if (!cf || !cf->name)
105 return error("relative config includes must come from files");
107 slash = find_last_dir_sep(cf->name);
109 strbuf_add(&buf, cf->name, slash - cf->name + 1);
110 strbuf_addstr(&buf, path);
114 if (!access_or_die(path, R_OK, 0)) {
115 if (++inc->depth > MAX_INCLUDE_DEPTH)
116 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
117 cf && cf->name ? cf->name : "the command line");
118 ret = git_config_from_file(git_config_include, path, inc);
121 strbuf_release(&buf);
126 static int callback(config_fn_t fn, const char *var, const char *value, void *data)
130 if (!strcmp(var, "core.mode")) {
131 if (!strcmp(value, "progress")) {
132 ret |= fn("merge.defaulttoupstream", "true", data);
133 ret |= fn("mergetool.prompt", "false", data);
137 ret |= fn(var, value, data);
141 int git_config_include(const char *var, const char *value, void *data)
143 struct config_include_data *inc = data;
148 * Pass along all values, including "include" directives; this makes it
149 * possible to query information on the includes themselves.
151 ret = callback(inc->fn, var, value, inc->data);
155 type = skip_prefix(var, "include.");
159 if (!strcmp(type, "path"))
160 ret = handle_path_include(value, inc);
164 static void lowercase(char *p)
170 void git_config_push_parameter(const char *text)
172 struct strbuf env = STRBUF_INIT;
173 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
175 strbuf_addstr(&env, old);
176 strbuf_addch(&env, ' ');
178 sq_quote_buf(&env, text);
179 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
180 strbuf_release(&env);
183 int git_config_parse_parameter(const char *text,
184 config_fn_t fn, void *data)
186 struct strbuf **pair;
187 pair = strbuf_split_str(text, '=', 2);
189 return error("bogus config parameter: %s", text);
190 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=')
191 strbuf_setlen(pair[0], pair[0]->len - 1);
192 strbuf_trim(pair[0]);
194 strbuf_list_free(pair);
195 return error("bogus config parameter: %s", text);
197 lowercase(pair[0]->buf);
198 if (callback(fn, pair[0]->buf, pair[1] ? pair[1]->buf : NULL, data) < 0) {
199 strbuf_list_free(pair);
202 strbuf_list_free(pair);
206 int git_config_from_parameters(config_fn_t fn, void *data)
208 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
210 const char **argv = NULL;
211 int nr = 0, alloc = 0;
216 /* sq_dequote will write over it */
219 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
221 return error("bogus format in " CONFIG_DATA_ENVIRONMENT);
224 for (i = 0; i < nr; i++) {
225 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
237 static int get_next_char(void)
239 int c = cf->do_fgetc(cf);
242 /* DOS like systems */
243 c = cf->do_fgetc(cf);
245 cf->do_ungetc(c, cf);
258 static char *parse_value(void)
260 int quote = 0, comment = 0, space = 0;
262 strbuf_reset(&cf->value);
264 int c = get_next_char();
270 return cf->value.buf;
274 if (isspace(c) && !quote) {
280 if (c == ';' || c == '#') {
285 for (; space; space--)
286 strbuf_addch(&cf->value, ' ');
301 /* Some characters escape as themselves */
304 /* Reject unknown escape sequences */
308 strbuf_addch(&cf->value, c);
315 strbuf_addch(&cf->value, c);
319 static inline int iskeychar(int c)
321 return isalnum(c) || c == '-';
324 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
329 /* Get the full name */
336 strbuf_addch(name, tolower(c));
339 while (c == ' ' || c == '\t')
346 value = parse_value();
350 return callback(fn, name->buf, value, data);
353 static int get_extended_base_var(struct strbuf *name, int c)
357 goto error_incomplete_line;
359 } while (isspace(c));
361 /* We require the format to be '[base "extension"]' */
364 strbuf_addch(name, '.');
367 int c = get_next_char();
369 goto error_incomplete_line;
375 goto error_incomplete_line;
377 strbuf_addch(name, c);
381 if (get_next_char() != ']')
384 error_incomplete_line:
389 static int get_base_var(struct strbuf *name)
392 int c = get_next_char();
398 return get_extended_base_var(name, c);
399 if (!iskeychar(c) && c != '.')
401 strbuf_addch(name, tolower(c));
405 static int git_parse_source(config_fn_t fn, void *data)
409 struct strbuf *var = &cf->var;
411 /* U+FEFF Byte Order Mark in UTF8 */
412 static const unsigned char *utf8_bom = (unsigned char *) "\xef\xbb\xbf";
413 const unsigned char *bomptr = utf8_bom;
416 int c = get_next_char();
417 if (bomptr && *bomptr) {
418 /* We are at the file beginning; skip UTF8-encoded BOM
419 * if present. Sane editors won't put this in on their
420 * own, but e.g. Windows Notepad will do it happily. */
421 if ((unsigned char) c == *bomptr) {
425 /* Do not tolerate partial BOM. */
426 if (bomptr != utf8_bom)
428 /* No BOM at file beginning. Cool. */
438 if (comment || isspace(c))
440 if (c == '#' || c == ';') {
445 /* Reset prior to determining a new stem */
447 if (get_base_var(var) < 0 || var->len < 1)
449 strbuf_addch(var, '.');
456 * Truncate the var name back to the section header
457 * stem prior to grabbing the suffix part of the name
460 strbuf_setlen(var, baselen);
461 strbuf_addch(var, tolower(c));
462 if (get_value(fn, data, var) < 0)
465 if (cf->die_on_error)
466 die("bad config file line %d in %s", cf->linenr, cf->name);
468 return error("bad config file line %d in %s", cf->linenr, cf->name);
471 static int parse_unit_factor(const char *end, uintmax_t *val)
475 else if (!strcasecmp(end, "k")) {
479 else if (!strcasecmp(end, "m")) {
483 else if (!strcasecmp(end, "g")) {
484 *val *= 1024 * 1024 * 1024;
490 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
492 if (value && *value) {
496 uintmax_t factor = 1;
499 val = strtoimax(value, &end, 0);
502 if (!parse_unit_factor(end, &factor)) {
508 if (uval > max || abs(val) > uval) {
520 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
522 if (value && *value) {
528 val = strtoumax(value, &end, 0);
532 if (!parse_unit_factor(end, &val)) {
536 if (val > max || oldval > val) {
547 static int git_parse_int(const char *value, int *ret)
550 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
556 static int git_parse_int64(const char *value, int64_t *ret)
559 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
565 int git_parse_ulong(const char *value, unsigned long *ret)
568 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
574 static void die_bad_number(const char *name, const char *value)
576 const char *reason = errno == ERANGE ?
583 die("bad numeric config value '%s' for '%s' in %s: %s",
584 value, name, cf->name, reason);
585 die("bad numeric config value '%s' for '%s': %s", value, name, reason);
588 int git_config_int(const char *name, const char *value)
591 if (!git_parse_int(value, &ret))
592 die_bad_number(name, value);
596 int64_t git_config_int64(const char *name, const char *value)
599 if (!git_parse_int64(value, &ret))
600 die_bad_number(name, value);
604 unsigned long git_config_ulong(const char *name, const char *value)
607 if (!git_parse_ulong(value, &ret))
608 die_bad_number(name, value);
612 static int git_config_maybe_bool_text(const char *name, const char *value)
618 if (!strcasecmp(value, "true")
619 || !strcasecmp(value, "yes")
620 || !strcasecmp(value, "on"))
622 if (!strcasecmp(value, "false")
623 || !strcasecmp(value, "no")
624 || !strcasecmp(value, "off"))
629 int git_config_maybe_bool(const char *name, const char *value)
631 int v = git_config_maybe_bool_text(name, value);
634 if (git_parse_int(value, &v))
639 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
641 int v = git_config_maybe_bool_text(name, value);
647 return git_config_int(name, value);
650 int git_config_bool(const char *name, const char *value)
653 return !!git_config_bool_or_int(name, value, &discard);
656 int git_config_string(const char **dest, const char *var, const char *value)
659 return config_error_nonbool(var);
660 *dest = xstrdup(value);
664 int git_config_pathname(const char **dest, const char *var, const char *value)
667 return config_error_nonbool(var);
668 *dest = expand_user_path(value);
670 die("Failed to expand user dir in: '%s'", value);
674 static int git_default_core_config(const char *var, const char *value)
676 /* This needs a better name */
677 if (!strcmp(var, "core.filemode")) {
678 trust_executable_bit = git_config_bool(var, value);
681 if (!strcmp(var, "core.trustctime")) {
682 trust_ctime = git_config_bool(var, value);
685 if (!strcmp(var, "core.statinfo") ||
686 !strcmp(var, "core.checkstat")) {
688 * NEEDSWORK: statinfo was a typo in v1.8.2 that has
689 * never been advertised. we will remove it at Git
692 if (!strcmp(var, "core.statinfo")) {
695 warning("'core.statinfo' will be removed in Git 2.0; "
696 "use 'core.checkstat' instead.");
699 if (!strcasecmp(value, "default"))
701 else if (!strcasecmp(value, "minimal"))
705 if (!strcmp(var, "core.quotepath")) {
706 quote_path_fully = git_config_bool(var, value);
710 if (!strcmp(var, "core.symlinks")) {
711 has_symlinks = git_config_bool(var, value);
715 if (!strcmp(var, "core.ignorecase")) {
716 ignore_case = git_config_bool(var, value);
720 if (!strcmp(var, "core.attributesfile"))
721 return git_config_pathname(&git_attributes_file, var, value);
723 if (!strcmp(var, "core.bare")) {
724 is_bare_repository_cfg = git_config_bool(var, value);
728 if (!strcmp(var, "core.ignorestat")) {
729 assume_unchanged = git_config_bool(var, value);
733 if (!strcmp(var, "core.prefersymlinkrefs")) {
734 prefer_symlink_refs = git_config_bool(var, value);
738 if (!strcmp(var, "core.logallrefupdates")) {
739 log_all_ref_updates = git_config_bool(var, value);
743 if (!strcmp(var, "core.warnambiguousrefs")) {
744 warn_ambiguous_refs = git_config_bool(var, value);
748 if (!strcmp(var, "core.abbrev")) {
749 int abbrev = git_config_int(var, value);
750 if (abbrev < minimum_abbrev || abbrev > 40)
752 default_abbrev = abbrev;
756 if (!strcmp(var, "core.loosecompression")) {
757 int level = git_config_int(var, value);
759 level = Z_DEFAULT_COMPRESSION;
760 else if (level < 0 || level > Z_BEST_COMPRESSION)
761 die("bad zlib compression level %d", level);
762 zlib_compression_level = level;
763 zlib_compression_seen = 1;
767 if (!strcmp(var, "core.compression")) {
768 int level = git_config_int(var, value);
770 level = Z_DEFAULT_COMPRESSION;
771 else if (level < 0 || level > Z_BEST_COMPRESSION)
772 die("bad zlib compression level %d", level);
773 core_compression_level = level;
774 core_compression_seen = 1;
775 if (!zlib_compression_seen)
776 zlib_compression_level = level;
780 if (!strcmp(var, "core.packedgitwindowsize")) {
781 int pgsz_x2 = getpagesize() * 2;
782 packed_git_window_size = git_config_ulong(var, value);
784 /* This value must be multiple of (pagesize * 2) */
785 packed_git_window_size /= pgsz_x2;
786 if (packed_git_window_size < 1)
787 packed_git_window_size = 1;
788 packed_git_window_size *= pgsz_x2;
792 if (!strcmp(var, "core.bigfilethreshold")) {
793 big_file_threshold = git_config_ulong(var, value);
797 if (!strcmp(var, "core.packedgitlimit")) {
798 packed_git_limit = git_config_ulong(var, value);
802 if (!strcmp(var, "core.deltabasecachelimit")) {
803 delta_base_cache_limit = git_config_ulong(var, value);
807 if (!strcmp(var, "core.autocrlf")) {
808 if (value && !strcasecmp(value, "input")) {
809 if (core_eol == EOL_CRLF)
810 return error("core.autocrlf=input conflicts with core.eol=crlf");
811 auto_crlf = AUTO_CRLF_INPUT;
814 auto_crlf = git_config_bool(var, value);
818 if (!strcmp(var, "core.safecrlf")) {
819 if (value && !strcasecmp(value, "warn")) {
820 safe_crlf = SAFE_CRLF_WARN;
823 safe_crlf = git_config_bool(var, value);
827 if (!strcmp(var, "core.eol")) {
828 if (value && !strcasecmp(value, "lf"))
830 else if (value && !strcasecmp(value, "crlf"))
832 else if (value && !strcasecmp(value, "native"))
833 core_eol = EOL_NATIVE;
835 core_eol = EOL_UNSET;
836 if (core_eol == EOL_CRLF && auto_crlf == AUTO_CRLF_INPUT)
837 return error("core.autocrlf=input conflicts with core.eol=crlf");
841 if (!strcmp(var, "core.notesref")) {
842 notes_ref_name = xstrdup(value);
846 if (!strcmp(var, "core.pager"))
847 return git_config_string(&pager_program, var, value);
849 if (!strcmp(var, "core.editor"))
850 return git_config_string(&editor_program, var, value);
852 if (!strcmp(var, "core.commentchar")) {
854 int ret = git_config_string(&comment, var, value);
856 comment_line_char = comment[0];
860 if (!strcmp(var, "core.askpass"))
861 return git_config_string(&askpass_program, var, value);
863 if (!strcmp(var, "core.excludesfile"))
864 return git_config_pathname(&excludes_file, var, value);
866 if (!strcmp(var, "core.whitespace")) {
868 return config_error_nonbool(var);
869 whitespace_rule_cfg = parse_whitespace_rule(value);
873 if (!strcmp(var, "core.fsyncobjectfiles")) {
874 fsync_object_files = git_config_bool(var, value);
878 if (!strcmp(var, "core.preloadindex")) {
879 core_preload_index = git_config_bool(var, value);
883 if (!strcmp(var, "core.createobject")) {
884 if (!strcmp(value, "rename"))
885 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
886 else if (!strcmp(value, "link"))
887 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
889 die("Invalid mode for object creation: %s", value);
893 if (!strcmp(var, "core.sparsecheckout")) {
894 core_apply_sparse_checkout = git_config_bool(var, value);
898 if (!strcmp(var, "core.precomposeunicode")) {
899 precomposed_unicode = git_config_bool(var, value);
903 if (!strcmp(var, "core.mode")) {
905 return config_error_nonbool(var);
906 else if (!strcmp(value, "current"))
907 git_mode = MODE_CURRENT;
908 else if (!strcmp(value, "next")) {
909 git_mode = MODE_NEXT;
910 push_default = PUSH_DEFAULT_SIMPLE;
911 } else if (!strcmp(value, "progress")) {
912 git_mode = MODE_PROGRESS;
913 push_default = PUSH_DEFAULT_SIMPLE;
914 git_branch_track = BRANCH_TRACK_ALWAYS;
915 fetch_default = FETCH_DEFAULT_SIMPLE;
917 die("wrong mode '%s'", value);
921 /* Add other config variables here and to Documentation/config.txt. */
925 static int git_default_i18n_config(const char *var, const char *value)
927 if (!strcmp(var, "i18n.commitencoding"))
928 return git_config_string(&git_commit_encoding, var, value);
930 if (!strcmp(var, "i18n.logoutputencoding"))
931 return git_config_string(&git_log_output_encoding, var, value);
933 /* Add other config variables here and to Documentation/config.txt. */
937 static int git_default_branch_config(const char *var, const char *value)
939 if (!strcmp(var, "branch.autosetupmerge")) {
940 if (value && !strcasecmp(value, "always")) {
941 git_branch_track = BRANCH_TRACK_ALWAYS;
944 git_branch_track = git_config_bool(var, value);
947 if (!strcmp(var, "branch.autosetuprebase")) {
949 return config_error_nonbool(var);
950 else if (!strcmp(value, "never"))
951 autorebase = AUTOREBASE_NEVER;
952 else if (!strcmp(value, "local"))
953 autorebase = AUTOREBASE_LOCAL;
954 else if (!strcmp(value, "remote"))
955 autorebase = AUTOREBASE_REMOTE;
956 else if (!strcmp(value, "always"))
957 autorebase = AUTOREBASE_ALWAYS;
959 return error("Malformed value for %s", var);
963 /* Add other config variables here and to Documentation/config.txt. */
967 static int git_default_push_config(const char *var, const char *value)
969 if (!strcmp(var, "push.default")) {
971 return config_error_nonbool(var);
972 else if (!strcmp(value, "nothing"))
973 push_default = PUSH_DEFAULT_NOTHING;
974 else if (!strcmp(value, "matching"))
975 push_default = PUSH_DEFAULT_MATCHING;
976 else if (!strcmp(value, "simple"))
977 push_default = PUSH_DEFAULT_SIMPLE;
978 else if (!strcmp(value, "upstream"))
979 push_default = PUSH_DEFAULT_UPSTREAM;
980 else if (!strcmp(value, "tracking")) /* deprecated */
981 push_default = PUSH_DEFAULT_UPSTREAM;
982 else if (!strcmp(value, "current"))
983 push_default = PUSH_DEFAULT_CURRENT;
985 error("Malformed value for %s: %s", var, value);
986 return error("Must be one of nothing, matching, simple, "
987 "upstream or current.");
992 /* Add other config variables here and to Documentation/config.txt. */
996 static int git_default_fetch_config(const char *var, const char *value)
998 if (strcmp(var, "fetch.default"))
1002 return config_error_nonbool(var);
1003 else if (!strcmp(value, "simple"))
1004 fetch_default = FETCH_DEFAULT_SIMPLE;
1005 else if (!strcmp(value, "current"))
1006 fetch_default = FETCH_DEFAULT_CURRENT;
1008 error("Malformed value for %s: %s", var, value);
1009 return error("Must be simple, or current.");
1014 static int git_default_mailmap_config(const char *var, const char *value)
1016 if (!strcmp(var, "mailmap.file"))
1017 return git_config_string(&git_mailmap_file, var, value);
1018 if (!strcmp(var, "mailmap.blob"))
1019 return git_config_string(&git_mailmap_blob, var, value);
1021 /* Add other config variables here and to Documentation/config.txt. */
1025 int git_default_config(const char *var, const char *value, void *dummy)
1027 if (starts_with(var, "core."))
1028 return git_default_core_config(var, value);
1030 if (starts_with(var, "user."))
1031 return git_ident_config(var, value, dummy);
1033 if (starts_with(var, "i18n."))
1034 return git_default_i18n_config(var, value);
1036 if (starts_with(var, "branch."))
1037 return git_default_branch_config(var, value);
1039 if (starts_with(var, "push."))
1040 return git_default_push_config(var, value);
1042 if (starts_with(var, "fetch."))
1043 return git_default_fetch_config(var, value);
1045 if (starts_with(var, "mailmap."))
1046 return git_default_mailmap_config(var, value);
1048 if (starts_with(var, "advice."))
1049 return git_default_advice_config(var, value);
1051 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1052 pager_use_color = git_config_bool(var,value);
1056 if (!strcmp(var, "pack.packsizelimit")) {
1057 pack_size_limit_cfg = git_config_ulong(var, value);
1060 /* Add other config variables here and to Documentation/config.txt. */
1065 * All source specific fields in the union, die_on_error, name and the callbacks
1066 * fgetc, ungetc, ftell of top need to be initialized before calling
1069 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1073 /* push config-file parsing state stack */
1077 strbuf_init(&top->value, 1024);
1078 strbuf_init(&top->var, 1024);
1081 ret = git_parse_source(fn, data);
1083 /* pop config-file parsing state stack */
1084 strbuf_release(&top->value);
1085 strbuf_release(&top->var);
1091 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1094 FILE *f = fopen(filename, "r");
1098 struct config_source top;
1101 top.name = filename;
1102 top.die_on_error = 1;
1103 top.do_fgetc = config_file_fgetc;
1104 top.do_ungetc = config_file_ungetc;
1105 top.do_ftell = config_file_ftell;
1107 ret = do_config_from(&top, fn, data);
1114 int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
1115 size_t len, void *data)
1117 struct config_source top;
1119 top.u.buf.buf = buf;
1120 top.u.buf.len = len;
1123 top.die_on_error = 0;
1124 top.do_fgetc = config_buf_fgetc;
1125 top.do_ungetc = config_buf_ungetc;
1126 top.do_ftell = config_buf_ftell;
1128 return do_config_from(&top, fn, data);
1131 static int git_config_from_blob_sha1(config_fn_t fn,
1133 const unsigned char *sha1,
1136 enum object_type type;
1141 buf = read_sha1_file(sha1, &type, &size);
1143 return error("unable to load config blob object '%s'", name);
1144 if (type != OBJ_BLOB) {
1146 return error("reference '%s' does not point to a blob", name);
1149 ret = git_config_from_buf(fn, name, buf, size, data);
1155 static int git_config_from_blob_ref(config_fn_t fn,
1159 unsigned char sha1[20];
1161 if (get_sha1(name, sha1) < 0)
1162 return error("unable to resolve config blob '%s'", name);
1163 return git_config_from_blob_sha1(fn, name, sha1, data);
1166 const char *git_etc_gitconfig(void)
1168 static const char *system_wide;
1170 system_wide = system_path(ETC_GITCONFIG);
1174 int git_env_bool(const char *k, int def)
1176 const char *v = getenv(k);
1177 return v ? git_config_bool(k, v) : def;
1180 int git_config_system(void)
1182 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1185 int git_config_early(config_fn_t fn, void *data, const char *repo_config)
1187 int ret = 0, found = 0;
1188 char *xdg_config = NULL;
1189 char *user_config = NULL;
1191 home_config_paths(&user_config, &xdg_config, "config");
1193 ret += fn("alias.ci", "commit", data);
1194 ret += fn("alias.co", "checkout", data);
1195 ret += fn("alias.rb", "rebase", data);
1196 ret += fn("alias.st", "status", data);
1198 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1199 ret += git_config_from_file(fn, git_etc_gitconfig(),
1204 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1205 ret += git_config_from_file(fn, xdg_config, data);
1209 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1210 ret += git_config_from_file(fn, user_config, data);
1214 if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1215 ret += git_config_from_file(fn, repo_config, data);
1219 switch (git_config_from_parameters(fn, data)) {
1220 case -1: /* error */
1221 die("unable to parse command-line config");
1223 case 0: /* found nothing */
1225 default: /* found at least one item */
1232 return ret == 0 ? found : ret;
1235 int git_config_with_options(config_fn_t fn, void *data,
1236 const char *filename,
1237 const char *blob_ref,
1238 int respect_includes)
1240 char *repo_config = NULL;
1242 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1244 if (respect_includes) {
1247 fn = git_config_include;
1252 * If we have a specific filename, use it. Otherwise, follow the
1253 * regular lookup sequence.
1256 return git_config_from_file(fn, filename, data);
1258 return git_config_from_blob_ref(fn, blob_ref, data);
1260 repo_config = git_pathdup("config");
1261 ret = git_config_early(fn, data, repo_config);
1267 int git_config(config_fn_t fn, void *data)
1269 return git_config_with_options(fn, data, NULL, NULL, 1);
1273 * Find all the stuff for git_config_set() below.
1280 regex_t *value_regex;
1283 unsigned int offset_alloc;
1284 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
1288 static int matches(const char *key, const char *value)
1290 return !strcmp(key, store.key) &&
1291 (store.value_regex == NULL ||
1292 (store.do_not_match ^
1293 !regexec(store.value_regex, value, 0, NULL, 0)));
1296 static int store_aux(const char *key, const char *value, void *cb)
1301 switch (store.state) {
1303 if (matches(key, value)) {
1304 if (store.seen == 1 && store.multi_replace == 0) {
1305 warning("%s has multiple values", key);
1308 ALLOC_GROW(store.offset, store.seen + 1,
1309 store.offset_alloc);
1311 store.offset[store.seen] = cf->do_ftell(cf);
1317 * What we are looking for is in store.key (both
1318 * section and var), and its section part is baselen
1319 * long. We found key (again, both section and var).
1320 * We would want to know if this key is in the same
1321 * section as what we are looking for. We already
1322 * know we are in the same section as what should
1325 ep = strrchr(key, '.');
1326 section_len = ep - key;
1328 if ((section_len != store.baselen) ||
1329 memcmp(key, store.key, section_len+1)) {
1330 store.state = SECTION_END_SEEN;
1335 * Do not increment matches: this is no match, but we
1336 * just made sure we are in the desired section.
1338 ALLOC_GROW(store.offset, store.seen + 1,
1339 store.offset_alloc);
1340 store.offset[store.seen] = cf->do_ftell(cf);
1342 case SECTION_END_SEEN:
1344 if (matches(key, value)) {
1345 ALLOC_GROW(store.offset, store.seen + 1,
1346 store.offset_alloc);
1347 store.offset[store.seen] = cf->do_ftell(cf);
1348 store.state = KEY_SEEN;
1351 if (strrchr(key, '.') - key == store.baselen &&
1352 !strncmp(key, store.key, store.baselen)) {
1353 store.state = SECTION_SEEN;
1354 ALLOC_GROW(store.offset,
1356 store.offset_alloc);
1357 store.offset[store.seen] = cf->do_ftell(cf);
1364 static int write_error(const char *filename)
1366 error("failed to write new configuration file %s", filename);
1368 /* Same error code as "failed to rename". */
1372 static int store_write_section(int fd, const char *key)
1376 struct strbuf sb = STRBUF_INIT;
1378 dot = memchr(key, '.', store.baselen);
1380 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
1381 for (i = dot - key + 1; i < store.baselen; i++) {
1382 if (key[i] == '"' || key[i] == '\\')
1383 strbuf_addch(&sb, '\\');
1384 strbuf_addch(&sb, key[i]);
1386 strbuf_addstr(&sb, "\"]\n");
1388 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
1391 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1392 strbuf_release(&sb);
1397 static int store_write_pair(int fd, const char *key, const char *value)
1400 int length = strlen(key + store.baselen + 1);
1401 const char *quote = "";
1402 struct strbuf sb = STRBUF_INIT;
1405 * Check to see if the value needs to be surrounded with a dq pair.
1406 * Note that problematic characters are always backslash-quoted; this
1407 * check is about not losing leading or trailing SP and strings that
1408 * follow beginning-of-comment characters (i.e. ';' and '#') by the
1409 * configuration parser.
1411 if (value[0] == ' ')
1413 for (i = 0; value[i]; i++)
1414 if (value[i] == ';' || value[i] == '#')
1416 if (i && value[i - 1] == ' ')
1419 strbuf_addf(&sb, "\t%.*s = %s",
1420 length, key + store.baselen + 1, quote);
1422 for (i = 0; value[i]; i++)
1425 strbuf_addstr(&sb, "\\n");
1428 strbuf_addstr(&sb, "\\t");
1432 strbuf_addch(&sb, '\\');
1434 strbuf_addch(&sb, value[i]);
1437 strbuf_addf(&sb, "%s\n", quote);
1439 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
1440 strbuf_release(&sb);
1445 static ssize_t find_beginning_of_line(const char *contents, size_t size,
1446 size_t offset_, int *found_bracket)
1448 size_t equal_offset = size, bracket_offset = size;
1452 for (offset = offset_-2; offset > 0
1453 && contents[offset] != '\n'; offset--)
1454 switch (contents[offset]) {
1455 case '=': equal_offset = offset; break;
1456 case ']': bracket_offset = offset; break;
1458 if (offset > 0 && contents[offset-1] == '\\') {
1462 if (bracket_offset < equal_offset) {
1464 offset = bracket_offset+1;
1471 int git_config_set_in_file(const char *config_filename,
1472 const char *key, const char *value)
1474 return git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
1477 int git_config_set(const char *key, const char *value)
1479 return git_config_set_multivar(key, value, NULL, 0);
1483 * Auxiliary function to sanity-check and split the key into the section
1484 * identifier and variable name.
1486 * Returns 0 on success, -1 when there is an invalid character in the key and
1487 * -2 if there is no section name in the key.
1489 * store_key - pointer to char* which will hold a copy of the key with
1490 * lowercase section and variable name
1491 * baselen - pointer to int which will hold the length of the
1492 * section + subsection part, can be NULL
1494 int git_config_parse_key(const char *key, char **store_key, int *baselen_)
1496 int i, dot, baselen;
1497 const char *last_dot = strrchr(key, '.');
1500 * Since "key" actually contains the section name and the real
1501 * key name separated by a dot, we have to know where the dot is.
1504 if (last_dot == NULL || last_dot == key) {
1505 error("key does not contain a section: %s", key);
1506 return -CONFIG_NO_SECTION_OR_NAME;
1510 error("key does not contain variable name: %s", key);
1511 return -CONFIG_NO_SECTION_OR_NAME;
1514 baselen = last_dot - key;
1516 *baselen_ = baselen;
1519 * Validate the key and while at it, lower case it for matching.
1521 *store_key = xmalloc(strlen(key) + 1);
1524 for (i = 0; key[i]; i++) {
1525 unsigned char c = key[i];
1528 /* Leave the extended basename untouched.. */
1529 if (!dot || i > baselen) {
1530 if (!iskeychar(c) ||
1531 (i == baselen + 1 && !isalpha(c))) {
1532 error("invalid key: %s", key);
1533 goto out_free_ret_1;
1536 } else if (c == '\n') {
1537 error("invalid key (newline): %s", key);
1538 goto out_free_ret_1;
1540 (*store_key)[i] = c;
1542 (*store_key)[i] = 0;
1549 return -CONFIG_INVALID_KEY;
1553 * If value==NULL, unset in (remove from) config,
1554 * if value_regex!=NULL, disregard key/value pairs where value does not match.
1555 * if multi_replace==0, nothing, or only one matching key/value is replaced,
1556 * else all matching key/values (regardless how many) are removed,
1557 * before the new pair is written.
1559 * Returns 0 on success.
1561 * This function does this:
1563 * - it locks the config file by creating ".git/config.lock"
1565 * - it then parses the config using store_aux() as validator to find
1566 * the position on the key/value pair to replace. If it is to be unset,
1567 * it must be found exactly once.
1569 * - the config file is mmap()ed and the part before the match (if any) is
1570 * written to the lock file, then the changed part and the rest.
1572 * - the config file is removed and the lock file rename()d to it.
1575 int git_config_set_multivar_in_file(const char *config_filename,
1576 const char *key, const char *value,
1577 const char *value_regex, int multi_replace)
1581 struct lock_file *lock = NULL;
1582 char *filename_buf = NULL;
1584 /* parse-key returns negative; flip the sign to feed exit(3) */
1585 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
1589 store.multi_replace = multi_replace;
1591 if (!config_filename)
1592 config_filename = filename_buf = git_pathdup("config");
1595 * The lock serves a purpose in addition to locking: the new
1596 * contents of .git/config will be written into it.
1598 lock = xcalloc(sizeof(struct lock_file), 1);
1599 fd = hold_lock_file_for_update(lock, config_filename, 0);
1601 error("could not lock config file %s: %s", config_filename, strerror(errno));
1603 ret = CONFIG_NO_LOCK;
1608 * If .git/config does not exist yet, write a minimal version.
1610 in_fd = open(config_filename, O_RDONLY);
1614 if ( ENOENT != errno ) {
1615 error("opening %s: %s", config_filename,
1617 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
1620 /* if nothing to unset, error out */
1621 if (value == NULL) {
1622 ret = CONFIG_NOTHING_SET;
1626 store.key = (char *)key;
1627 if (!store_write_section(fd, key) ||
1628 !store_write_pair(fd, key, value))
1633 size_t contents_sz, copy_begin, copy_end;
1634 int i, new_line = 0;
1636 if (value_regex == NULL)
1637 store.value_regex = NULL;
1639 if (value_regex[0] == '!') {
1640 store.do_not_match = 1;
1643 store.do_not_match = 0;
1645 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
1646 if (regcomp(store.value_regex, value_regex,
1648 error("invalid pattern: %s", value_regex);
1649 free(store.value_regex);
1650 ret = CONFIG_INVALID_PATTERN;
1655 ALLOC_GROW(store.offset, 1, store.offset_alloc);
1656 store.offset[0] = 0;
1657 store.state = START;
1661 * After this, store.offset will contain the *end* offset
1662 * of the last match, or remain at 0 if no match was found.
1663 * As a side effect, we make sure to transform only a valid
1664 * existing config file.
1666 if (git_config_from_file(store_aux, config_filename, NULL)) {
1667 error("invalid config file %s", config_filename);
1669 if (store.value_regex != NULL) {
1670 regfree(store.value_regex);
1671 free(store.value_regex);
1673 ret = CONFIG_INVALID_FILE;
1678 if (store.value_regex != NULL) {
1679 regfree(store.value_regex);
1680 free(store.value_regex);
1683 /* if nothing to unset, or too many matches, error out */
1684 if ((store.seen == 0 && value == NULL) ||
1685 (store.seen > 1 && multi_replace == 0)) {
1686 ret = CONFIG_NOTHING_SET;
1691 contents_sz = xsize_t(st.st_size);
1692 contents = xmmap(NULL, contents_sz, PROT_READ,
1693 MAP_PRIVATE, in_fd, 0);
1696 if (store.seen == 0)
1699 for (i = 0, copy_begin = 0; i < store.seen; i++) {
1700 if (store.offset[i] == 0) {
1701 store.offset[i] = copy_end = contents_sz;
1702 } else if (store.state != KEY_SEEN) {
1703 copy_end = store.offset[i];
1705 copy_end = find_beginning_of_line(
1706 contents, contents_sz,
1707 store.offset[i]-2, &new_line);
1709 if (copy_end > 0 && contents[copy_end-1] != '\n')
1712 /* write the first part of the config */
1713 if (copy_end > copy_begin) {
1714 if (write_in_full(fd, contents + copy_begin,
1715 copy_end - copy_begin) <
1716 copy_end - copy_begin)
1719 write_str_in_full(fd, "\n") != 1)
1722 copy_begin = store.offset[i];
1725 /* write the pair (value == NULL means unset) */
1726 if (value != NULL) {
1727 if (store.state == START) {
1728 if (!store_write_section(fd, key))
1731 if (!store_write_pair(fd, key, value))
1735 /* write the rest of the config */
1736 if (copy_begin < contents_sz)
1737 if (write_in_full(fd, contents + copy_begin,
1738 contents_sz - copy_begin) <
1739 contents_sz - copy_begin)
1742 munmap(contents, contents_sz);
1745 if (commit_lock_file(lock) < 0) {
1746 error("could not commit config file %s", config_filename);
1747 ret = CONFIG_NO_WRITE;
1752 * lock is committed, so don't try to roll it back below.
1753 * NOTE: Since lockfile.c keeps a linked list of all created
1754 * lock_file structures, it isn't safe to free(lock). It's
1755 * better to just leave it hanging around.
1762 rollback_lock_file(lock);
1767 ret = write_error(lock->filename);
1772 int git_config_set_multivar(const char *key, const char *value,
1773 const char *value_regex, int multi_replace)
1775 return git_config_set_multivar_in_file(NULL, key, value, value_regex,
1779 static int section_name_match (const char *buf, const char *name)
1781 int i = 0, j = 0, dot = 0;
1784 for (i = 1; buf[i] && buf[i] != ']'; i++) {
1785 if (!dot && isspace(buf[i])) {
1787 if (name[j++] != '.')
1789 for (i++; isspace(buf[i]); i++)
1795 if (buf[i] == '\\' && dot)
1797 else if (buf[i] == '"' && dot) {
1798 for (i++; isspace(buf[i]); i++)
1802 if (buf[i] != name[j++])
1805 if (buf[i] == ']' && name[j] == 0) {
1807 * We match, now just find the right length offset by
1808 * gobbling up any whitespace after it, as well
1811 for (; buf[i] && isspace(buf[i]); i++)
1818 static int section_name_is_ok(const char *name)
1820 /* Empty section names are bogus. */
1825 * Before a dot, we must be alphanumeric or dash. After the first dot,
1826 * anything goes, so we can stop checking.
1828 for (; *name && *name != '.'; name++)
1829 if (*name != '-' && !isalnum(*name))
1834 /* if new_name == NULL, the section is removed instead */
1835 int git_config_rename_section_in_file(const char *config_filename,
1836 const char *old_name, const char *new_name)
1838 int ret = 0, remove = 0;
1839 char *filename_buf = NULL;
1840 struct lock_file *lock;
1845 if (new_name && !section_name_is_ok(new_name)) {
1846 ret = error("invalid section name: %s", new_name);
1850 if (!config_filename)
1851 config_filename = filename_buf = git_pathdup("config");
1853 lock = xcalloc(sizeof(struct lock_file), 1);
1854 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
1856 ret = error("could not lock config file %s", config_filename);
1860 if (!(config_file = fopen(config_filename, "rb"))) {
1861 /* no config file means nothing to rename, no error */
1862 goto unlock_and_out;
1865 while (fgets(buf, sizeof(buf), config_file)) {
1869 for (i = 0; buf[i] && isspace(buf[i]); i++)
1871 if (buf[i] == '[') {
1872 /* it's a section */
1873 int offset = section_name_match(&buf[i], old_name);
1876 if (new_name == NULL) {
1880 store.baselen = strlen(new_name);
1881 if (!store_write_section(out_fd, new_name)) {
1882 ret = write_error(lock->filename);
1886 * We wrote out the new section, with
1887 * a newline, now skip the old
1890 output += offset + i;
1891 if (strlen(output) > 0) {
1893 * More content means there's
1894 * a declaration to put on the
1895 * next line; indent with a
1906 length = strlen(output);
1907 if (write_in_full(out_fd, output, length) != length) {
1908 ret = write_error(lock->filename);
1912 fclose(config_file);
1914 if (commit_lock_file(lock) < 0)
1915 ret = error("could not commit config file %s", config_filename);
1921 int git_config_rename_section(const char *old_name, const char *new_name)
1923 return git_config_rename_section_in_file(NULL, old_name, new_name);
1927 * Call this to report error for your variable that should not
1928 * get a boolean value (i.e. "[my] var" means "true").
1930 #undef config_error_nonbool
1931 int config_error_nonbool(const char *var)
1933 return error("Missing value for '%s'", var);
1936 int parse_config_key(const char *var,
1937 const char *section,
1938 const char **subsection, int *subsection_len,
1941 int section_len = strlen(section);
1944 /* Does it start with "section." ? */
1945 if (!starts_with(var, section) || var[section_len] != '.')
1949 * Find the key; we don't know yet if we have a subsection, but we must
1950 * parse backwards from the end, since the subsection may have dots in
1953 dot = strrchr(var, '.');
1956 /* Did we have a subsection at all? */
1957 if (dot == var + section_len) {
1959 *subsection_len = 0;
1962 *subsection = var + section_len + 1;
1963 *subsection_len = dot - *subsection;