2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
11 #include "environment.h"
12 #include "repository.h"
18 #include "string-list.h"
19 #include "object-store.h"
25 struct config_source
{
26 struct config_source
*prev
;
35 enum config_origin_type origin_type
;
38 enum config_error_action default_error_action
;
44 unsigned subsection_case_sensitive
: 1;
46 int (*do_fgetc
)(struct config_source
*c
);
47 int (*do_ungetc
)(int c
, struct config_source
*conf
);
48 long (*do_ftell
)(struct config_source
*c
);
52 * These variables record the "current" config source, which
53 * can be accessed by parsing callbacks.
55 * The "cf" variable will be non-NULL only when we are actually parsing a real
56 * config source (file, blob, cmdline, etc).
58 * The "current_config_kvi" variable will be non-NULL only when we are feeding
59 * cached config from a configset into a callback.
61 * They should generally never be non-NULL at the same time. If they are both
62 * NULL, then we aren't parsing anything (and depending on the function looking
63 * at the variables, it's either a bug for it to be called in the first place,
64 * or it's a function which can be reused for non-config purposes, and should
65 * fall back to some sane behavior).
67 static struct config_source
*cf
;
68 static struct key_value_info
*current_config_kvi
;
71 * Similar to the variables above, this gives access to the "scope" of the
72 * current value (repo, global, etc). For cached values, it can be found via
73 * the current_config_kvi as above. During parsing, the current value can be
74 * found in this variable. It's not part of "cf" because it transcends a single
75 * file (i.e., a file included from .git/config is still in "repo" scope).
77 static enum config_scope current_parsing_scope
;
79 static int pack_compression_seen
;
80 static int zlib_compression_seen
;
82 static int config_file_fgetc(struct config_source
*conf
)
84 return getc_unlocked(conf
->u
.file
);
87 static int config_file_ungetc(int c
, struct config_source
*conf
)
89 return ungetc(c
, conf
->u
.file
);
92 static long config_file_ftell(struct config_source
*conf
)
94 return ftell(conf
->u
.file
);
98 static int config_buf_fgetc(struct config_source
*conf
)
100 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
101 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
106 static int config_buf_ungetc(int c
, struct config_source
*conf
)
108 if (conf
->u
.buf
.pos
> 0) {
110 if (conf
->u
.buf
.buf
[conf
->u
.buf
.pos
] != c
)
111 BUG("config_buf can only ungetc the same character");
118 static long config_buf_ftell(struct config_source
*conf
)
120 return conf
->u
.buf
.pos
;
123 #define MAX_INCLUDE_DEPTH 10
124 static const char include_depth_advice
[] = N_(
125 "exceeded maximum include depth (%d) while including\n"
129 "This might be due to circular includes.");
130 static int handle_path_include(const char *path
, struct config_include_data
*inc
)
133 struct strbuf buf
= STRBUF_INIT
;
137 return config_error_nonbool("include.path");
139 expanded
= interpolate_path(path
, 0);
141 return error(_("could not expand include path '%s'"), path
);
145 * Use an absolute path as-is, but interpret relative paths
146 * based on the including config file.
148 if (!is_absolute_path(path
)) {
151 if (!cf
|| !cf
->path
) {
152 ret
= error(_("relative config includes must come from files"));
156 slash
= find_last_dir_sep(cf
->path
);
158 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
159 strbuf_addstr(&buf
, path
);
163 if (!access_or_die(path
, R_OK
, 0)) {
164 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
165 die(_(include_depth_advice
), MAX_INCLUDE_DEPTH
, path
,
167 cf
->name
? cf
->name
:
169 ret
= git_config_from_file(git_config_include
, path
, inc
);
173 strbuf_release(&buf
);
178 static void add_trailing_starstar_for_dir(struct strbuf
*pat
)
180 if (pat
->len
&& is_dir_sep(pat
->buf
[pat
->len
- 1]))
181 strbuf_addstr(pat
, "**");
184 static int prepare_include_condition_pattern(struct strbuf
*pat
)
186 struct strbuf path
= STRBUF_INIT
;
190 expanded
= interpolate_path(pat
->buf
, 1);
193 strbuf_addstr(pat
, expanded
);
197 if (pat
->buf
[0] == '.' && is_dir_sep(pat
->buf
[1])) {
200 if (!cf
|| !cf
->path
)
201 return error(_("relative config include "
202 "conditionals must come from files"));
204 strbuf_realpath(&path
, cf
->path
, 1);
205 slash
= find_last_dir_sep(path
.buf
);
207 BUG("how is this possible?");
208 strbuf_splice(pat
, 0, 1, path
.buf
, slash
- path
.buf
);
209 prefix
= slash
- path
.buf
+ 1 /* slash */;
210 } else if (!is_absolute_path(pat
->buf
))
211 strbuf_insertstr(pat
, 0, "**/");
213 add_trailing_starstar_for_dir(pat
);
215 strbuf_release(&path
);
219 static int include_by_gitdir(const struct config_options
*opts
,
220 const char *cond
, size_t cond_len
, int icase
)
222 struct strbuf text
= STRBUF_INIT
;
223 struct strbuf pattern
= STRBUF_INIT
;
226 int already_tried_absolute
= 0;
229 git_dir
= opts
->git_dir
;
233 strbuf_realpath(&text
, git_dir
, 1);
234 strbuf_add(&pattern
, cond
, cond_len
);
235 prefix
= prepare_include_condition_pattern(&pattern
);
243 * perform literal matching on the prefix part so that
244 * any wildcard character in it can't create side effects.
246 if (text
.len
< prefix
)
248 if (!icase
&& strncmp(pattern
.buf
, text
.buf
, prefix
))
250 if (icase
&& strncasecmp(pattern
.buf
, text
.buf
, prefix
))
254 ret
= !wildmatch(pattern
.buf
+ prefix
, text
.buf
+ prefix
,
255 WM_PATHNAME
| (icase
? WM_CASEFOLD
: 0));
257 if (!ret
&& !already_tried_absolute
) {
259 * We've tried e.g. matching gitdir:~/work, but if
260 * ~/work is a symlink to /mnt/storage/work
261 * strbuf_realpath() will expand it, so the rule won't
262 * match. Let's match against a
263 * strbuf_add_absolute_path() version of the path,
264 * which'll do the right thing
267 strbuf_add_absolute_path(&text
, git_dir
);
268 already_tried_absolute
= 1;
272 strbuf_release(&pattern
);
273 strbuf_release(&text
);
277 static int include_by_branch(const char *cond
, size_t cond_len
)
281 struct strbuf pattern
= STRBUF_INIT
;
282 const char *refname
= !the_repository
->gitdir
?
283 NULL
: resolve_ref_unsafe("HEAD", 0, NULL
, &flags
);
284 const char *shortname
;
286 if (!refname
|| !(flags
& REF_ISSYMREF
) ||
287 !skip_prefix(refname
, "refs/heads/", &shortname
))
290 strbuf_add(&pattern
, cond
, cond_len
);
291 add_trailing_starstar_for_dir(&pattern
);
292 ret
= !wildmatch(pattern
.buf
, shortname
, WM_PATHNAME
);
293 strbuf_release(&pattern
);
297 static int include_condition_is_true(const struct config_options
*opts
,
298 const char *cond
, size_t cond_len
)
301 if (skip_prefix_mem(cond
, cond_len
, "gitdir:", &cond
, &cond_len
))
302 return include_by_gitdir(opts
, cond
, cond_len
, 0);
303 else if (skip_prefix_mem(cond
, cond_len
, "gitdir/i:", &cond
, &cond_len
))
304 return include_by_gitdir(opts
, cond
, cond_len
, 1);
305 else if (skip_prefix_mem(cond
, cond_len
, "onbranch:", &cond
, &cond_len
))
306 return include_by_branch(cond
, cond_len
);
308 /* unknown conditionals are always false */
312 int git_config_include(const char *var
, const char *value
, void *data
)
314 struct config_include_data
*inc
= data
;
315 const char *cond
, *key
;
320 * Pass along all values, including "include" directives; this makes it
321 * possible to query information on the includes themselves.
323 ret
= inc
->fn(var
, value
, inc
->data
);
327 if (!strcmp(var
, "include.path"))
328 ret
= handle_path_include(value
, inc
);
330 if (!parse_config_key(var
, "includeif", &cond
, &cond_len
, &key
) &&
331 (cond
&& include_condition_is_true(inc
->opts
, cond
, cond_len
)) &&
332 !strcmp(key
, "path"))
333 ret
= handle_path_include(value
, inc
);
338 static void git_config_push_split_parameter(const char *key
, const char *value
)
340 struct strbuf env
= STRBUF_INIT
;
341 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
343 strbuf_addstr(&env
, old
);
344 strbuf_addch(&env
, ' ');
346 sq_quote_buf(&env
, key
);
347 strbuf_addch(&env
, '=');
349 sq_quote_buf(&env
, value
);
350 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
351 strbuf_release(&env
);
354 void git_config_push_parameter(const char *text
)
361 * section.subsection=with=equals.key=value
363 * we cannot tell if it means:
365 * [section "subsection=with=equals"]
371 * subsection = with=equals.key=value
373 * We parse left-to-right for the first "=", meaning we'll prefer to
374 * keep the value intact over the subsection. This is historical, but
375 * also sensible since values are more likely to contain odd or
376 * untrusted input than a section name.
378 * A missing equals is explicitly allowed (as a bool-only entry).
380 value
= strchr(text
, '=');
382 char *key
= xmemdupz(text
, value
- text
);
383 git_config_push_split_parameter(key
, value
+ 1);
386 git_config_push_split_parameter(text
, NULL
);
390 void git_config_push_env(const char *spec
)
393 const char *env_name
;
394 const char *env_value
;
396 env_name
= strrchr(spec
, '=');
398 die(_("invalid config format: %s"), spec
);
399 key
= xmemdupz(spec
, env_name
- spec
);
402 die(_("missing environment variable name for configuration '%.*s'"),
403 (int)(env_name
- spec
- 1), spec
);
405 env_value
= getenv(env_name
);
407 die(_("missing environment variable '%s' for configuration '%.*s'"),
408 env_name
, (int)(env_name
- spec
- 1), spec
);
410 git_config_push_split_parameter(key
, env_value
);
414 static inline int iskeychar(int c
)
416 return isalnum(c
) || c
== '-';
420 * Auxiliary function to sanity-check and split the key into the section
421 * identifier and variable name.
423 * Returns 0 on success, -1 when there is an invalid character in the key and
424 * -2 if there is no section name in the key.
426 * store_key - pointer to char* which will hold a copy of the key with
427 * lowercase section and variable name
428 * baselen - pointer to size_t which will hold the length of the
429 * section + subsection part, can be NULL
431 int git_config_parse_key(const char *key
, char **store_key
, size_t *baselen_
)
435 const char *last_dot
= strrchr(key
, '.');
438 * Since "key" actually contains the section name and the real
439 * key name separated by a dot, we have to know where the dot is.
442 if (last_dot
== NULL
|| last_dot
== key
) {
443 error(_("key does not contain a section: %s"), key
);
444 return -CONFIG_NO_SECTION_OR_NAME
;
448 error(_("key does not contain variable name: %s"), key
);
449 return -CONFIG_NO_SECTION_OR_NAME
;
452 baselen
= last_dot
- key
;
457 * Validate the key and while at it, lower case it for matching.
459 *store_key
= xmallocz(strlen(key
));
462 for (i
= 0; key
[i
]; i
++) {
463 unsigned char c
= key
[i
];
466 /* Leave the extended basename untouched.. */
467 if (!dot
|| i
> baselen
) {
469 (i
== baselen
+ 1 && !isalpha(c
))) {
470 error(_("invalid key: %s"), key
);
474 } else if (c
== '\n') {
475 error(_("invalid key (newline): %s"), key
);
484 FREE_AND_NULL(*store_key
);
485 return -CONFIG_INVALID_KEY
;
488 static int config_parse_pair(const char *key
, const char *value
,
489 config_fn_t fn
, void *data
)
491 char *canonical_name
;
495 return error(_("empty config key"));
496 if (git_config_parse_key(key
, &canonical_name
, NULL
))
499 ret
= (fn(canonical_name
, value
, data
) < 0) ? -1 : 0;
500 free(canonical_name
);
504 int git_config_parse_parameter(const char *text
,
505 config_fn_t fn
, void *data
)
508 struct strbuf
**pair
;
511 pair
= strbuf_split_str(text
, '=', 2);
513 return error(_("bogus config parameter: %s"), text
);
515 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
516 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
517 value
= pair
[1] ? pair
[1]->buf
: "";
522 strbuf_trim(pair
[0]);
524 strbuf_list_free(pair
);
525 return error(_("bogus config parameter: %s"), text
);
528 ret
= config_parse_pair(pair
[0]->buf
, value
, fn
, data
);
529 strbuf_list_free(pair
);
533 static int parse_config_env_list(char *env
, config_fn_t fn
, void *data
)
536 while (cur
&& *cur
) {
537 const char *key
= sq_dequote_step(cur
, &cur
);
539 return error(_("bogus format in %s"),
540 CONFIG_DATA_ENVIRONMENT
);
542 if (!cur
|| isspace(*cur
)) {
543 /* old-style 'key=value' */
544 if (git_config_parse_parameter(key
, fn
, data
) < 0)
547 else if (*cur
== '=') {
548 /* new-style 'key'='value' */
554 value
= sq_dequote_step(cur
, &cur
);
555 if (!value
|| (cur
&& !isspace(*cur
))) {
556 return error(_("bogus format in %s"),
557 CONFIG_DATA_ENVIRONMENT
);
559 } else if (!*cur
|| isspace(*cur
)) {
560 /* implicit bool: 'key'= */
563 return error(_("bogus format in %s"),
564 CONFIG_DATA_ENVIRONMENT
);
567 if (config_parse_pair(key
, value
, fn
, data
) < 0)
572 return error(_("bogus format in %s"),
573 CONFIG_DATA_ENVIRONMENT
);
577 while (isspace(*cur
))
584 int git_config_from_parameters(config_fn_t fn
, void *data
)
587 struct strbuf envvar
= STRBUF_INIT
;
588 struct strvec to_free
= STRVEC_INIT
;
591 struct config_source source
;
593 memset(&source
, 0, sizeof(source
));
595 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
598 env
= getenv(CONFIG_COUNT_ENVIRONMENT
);
604 count
= strtoul(env
, &endp
, 10);
606 ret
= error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT
);
609 if (count
> INT_MAX
) {
610 ret
= error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT
);
614 for (i
= 0; i
< count
; i
++) {
615 const char *key
, *value
;
617 strbuf_addf(&envvar
, "GIT_CONFIG_KEY_%d", i
);
618 key
= getenv_safe(&to_free
, envvar
.buf
);
620 ret
= error(_("missing config key %s"), envvar
.buf
);
623 strbuf_reset(&envvar
);
625 strbuf_addf(&envvar
, "GIT_CONFIG_VALUE_%d", i
);
626 value
= getenv_safe(&to_free
, envvar
.buf
);
628 ret
= error(_("missing config value %s"), envvar
.buf
);
631 strbuf_reset(&envvar
);
633 if (config_parse_pair(key
, value
, fn
, data
) < 0) {
640 env
= getenv(CONFIG_DATA_ENVIRONMENT
);
642 /* sq_dequote will write over it */
644 if (parse_config_env_list(envw
, fn
, data
) < 0) {
651 strbuf_release(&envvar
);
652 strvec_clear(&to_free
);
658 static int get_next_char(void)
660 int c
= cf
->do_fgetc(cf
);
663 /* DOS like systems */
664 c
= cf
->do_fgetc(cf
);
667 cf
->do_ungetc(c
, cf
);
672 if (c
!= EOF
&& ++cf
->total_len
> INT_MAX
) {
674 * This is an absurdly long config file; refuse to parse
675 * further in order to protect downstream code from integer
676 * overflows. Note that we can't return an error specifically,
677 * but we can mark EOF and put trash in the return value,
678 * which will trigger a parse error.
694 static char *parse_value(void)
696 int quote
= 0, comment
= 0, space
= 0;
698 strbuf_reset(&cf
->value
);
700 int c
= get_next_char();
706 return cf
->value
.buf
;
710 if (isspace(c
) && !quote
) {
716 if (c
== ';' || c
== '#') {
721 for (; space
; space
--)
722 strbuf_addch(&cf
->value
, ' ');
737 /* Some characters escape as themselves */
740 /* Reject unknown escape sequences */
744 strbuf_addch(&cf
->value
, c
);
751 strbuf_addch(&cf
->value
, c
);
755 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
761 /* Get the full name */
768 strbuf_addch(name
, tolower(c
));
771 while (c
== ' ' || c
== '\t')
778 value
= parse_value();
783 * We already consumed the \n, but we need linenr to point to
784 * the line we just parsed during the call to fn to get
785 * accurate line number in error messages.
788 ret
= fn(name
->buf
, value
, data
);
794 static int get_extended_base_var(struct strbuf
*name
, int c
)
796 cf
->subsection_case_sensitive
= 0;
799 goto error_incomplete_line
;
801 } while (isspace(c
));
803 /* We require the format to be '[base "extension"]' */
806 strbuf_addch(name
, '.');
809 int c
= get_next_char();
811 goto error_incomplete_line
;
817 goto error_incomplete_line
;
819 strbuf_addch(name
, c
);
823 if (get_next_char() != ']')
826 error_incomplete_line
:
831 static int get_base_var(struct strbuf
*name
)
833 cf
->subsection_case_sensitive
= 1;
835 int c
= get_next_char();
841 return get_extended_base_var(name
, c
);
842 if (!iskeychar(c
) && c
!= '.')
844 strbuf_addch(name
, tolower(c
));
848 struct parse_event_data
{
849 enum config_event_t previous_type
;
850 size_t previous_offset
;
851 const struct config_options
*opts
;
854 static int do_event(enum config_event_t type
, struct parse_event_data
*data
)
858 if (!data
->opts
|| !data
->opts
->event_fn
)
861 if (type
== CONFIG_EVENT_WHITESPACE
&&
862 data
->previous_type
== type
)
865 offset
= cf
->do_ftell(cf
);
867 * At EOF, the parser always "inserts" an extra '\n', therefore
868 * the end offset of the event is the current file position, otherwise
869 * we will already have advanced to the next event.
871 if (type
!= CONFIG_EVENT_EOF
)
874 if (data
->previous_type
!= CONFIG_EVENT_EOF
&&
875 data
->opts
->event_fn(data
->previous_type
, data
->previous_offset
,
876 offset
, data
->opts
->event_fn_data
) < 0)
879 data
->previous_type
= type
;
880 data
->previous_offset
= offset
;
885 static int git_parse_source(config_fn_t fn
, void *data
,
886 const struct config_options
*opts
)
890 struct strbuf
*var
= &cf
->var
;
891 int error_return
= 0;
892 char *error_msg
= NULL
;
894 /* U+FEFF Byte Order Mark in UTF8 */
895 const char *bomptr
= utf8_bom
;
897 /* For the parser event callback */
898 struct parse_event_data event_data
= {
899 CONFIG_EVENT_EOF
, 0, opts
906 if (bomptr
&& *bomptr
) {
907 /* We are at the file beginning; skip UTF8-encoded BOM
908 * if present. Sane editors won't put this in on their
909 * own, but e.g. Windows Notepad will do it happily. */
910 if (c
== (*bomptr
& 0377)) {
914 /* Do not tolerate partial BOM. */
915 if (bomptr
!= utf8_bom
)
917 /* No BOM at file beginning. Cool. */
923 if (do_event(CONFIG_EVENT_EOF
, &event_data
) < 0)
927 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
935 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
939 if (c
== '#' || c
== ';') {
940 if (do_event(CONFIG_EVENT_COMMENT
, &event_data
) < 0)
946 if (do_event(CONFIG_EVENT_SECTION
, &event_data
) < 0)
949 /* Reset prior to determining a new stem */
951 if (get_base_var(var
) < 0 || var
->len
< 1)
953 strbuf_addch(var
, '.');
960 if (do_event(CONFIG_EVENT_ENTRY
, &event_data
) < 0)
964 * Truncate the var name back to the section header
965 * stem prior to grabbing the suffix part of the name
968 strbuf_setlen(var
, baselen
);
969 strbuf_addch(var
, tolower(c
));
970 if (get_value(fn
, data
, var
) < 0)
974 if (do_event(CONFIG_EVENT_ERROR
, &event_data
) < 0)
977 switch (cf
->origin_type
) {
978 case CONFIG_ORIGIN_BLOB
:
979 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
980 cf
->linenr
, cf
->name
);
982 case CONFIG_ORIGIN_FILE
:
983 error_msg
= xstrfmt(_("bad config line %d in file %s"),
984 cf
->linenr
, cf
->name
);
986 case CONFIG_ORIGIN_STDIN
:
987 error_msg
= xstrfmt(_("bad config line %d in standard input"),
990 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
991 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
992 cf
->linenr
, cf
->name
);
994 case CONFIG_ORIGIN_CMDLINE
:
995 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
996 cf
->linenr
, cf
->name
);
999 error_msg
= xstrfmt(_("bad config line %d in %s"),
1000 cf
->linenr
, cf
->name
);
1003 switch (opts
&& opts
->error_action
?
1004 opts
->error_action
:
1005 cf
->default_error_action
) {
1006 case CONFIG_ERROR_DIE
:
1007 die("%s", error_msg
);
1009 case CONFIG_ERROR_ERROR
:
1010 error_return
= error("%s", error_msg
);
1012 case CONFIG_ERROR_SILENT
:
1015 case CONFIG_ERROR_UNSET
:
1016 BUG("config error action unset");
1020 return error_return
;
1023 static uintmax_t get_unit_factor(const char *end
)
1027 else if (!strcasecmp(end
, "k"))
1029 else if (!strcasecmp(end
, "m"))
1031 else if (!strcasecmp(end
, "g"))
1032 return 1024 * 1024 * 1024;
1036 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
1038 if (value
&& *value
) {
1045 val
= strtoimax(value
, &end
, 0);
1046 if (errno
== ERANGE
)
1048 factor
= get_unit_factor(end
);
1053 uval
= val
< 0 ? -val
: val
;
1054 if (unsigned_mult_overflows(factor
, uval
) ||
1055 factor
* uval
> max
) {
1067 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
1069 if (value
&& *value
) {
1075 val
= strtoumax(value
, &end
, 0);
1076 if (errno
== ERANGE
)
1078 factor
= get_unit_factor(end
);
1083 if (unsigned_mult_overflows(factor
, val
) ||
1084 factor
* val
> max
) {
1096 static int git_parse_int(const char *value
, int *ret
)
1099 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
1105 static int git_parse_int64(const char *value
, int64_t *ret
)
1108 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
1114 int git_parse_ulong(const char *value
, unsigned long *ret
)
1117 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
1123 int git_parse_ssize_t(const char *value
, ssize_t
*ret
)
1126 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(ssize_t
)))
1133 static void die_bad_number(const char *name
, const char *value
)
1135 const char *error_type
= (errno
== ERANGE
) ?
1136 N_("out of range") : N_("invalid unit");
1137 const char *bad_numeric
= N_("bad numeric config value '%s' for '%s': %s");
1142 if (!(cf
&& cf
->name
))
1143 die(_(bad_numeric
), value
, name
, _(error_type
));
1145 switch (cf
->origin_type
) {
1146 case CONFIG_ORIGIN_BLOB
:
1147 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1148 value
, name
, cf
->name
, _(error_type
));
1149 case CONFIG_ORIGIN_FILE
:
1150 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1151 value
, name
, cf
->name
, _(error_type
));
1152 case CONFIG_ORIGIN_STDIN
:
1153 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1154 value
, name
, _(error_type
));
1155 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1156 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1157 value
, name
, cf
->name
, _(error_type
));
1158 case CONFIG_ORIGIN_CMDLINE
:
1159 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1160 value
, name
, cf
->name
, _(error_type
));
1162 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1163 value
, name
, cf
->name
, _(error_type
));
1167 int git_config_int(const char *name
, const char *value
)
1170 if (!git_parse_int(value
, &ret
))
1171 die_bad_number(name
, value
);
1175 int64_t git_config_int64(const char *name
, const char *value
)
1178 if (!git_parse_int64(value
, &ret
))
1179 die_bad_number(name
, value
);
1183 unsigned long git_config_ulong(const char *name
, const char *value
)
1186 if (!git_parse_ulong(value
, &ret
))
1187 die_bad_number(name
, value
);
1191 ssize_t
git_config_ssize_t(const char *name
, const char *value
)
1194 if (!git_parse_ssize_t(value
, &ret
))
1195 die_bad_number(name
, value
);
1199 static int git_parse_maybe_bool_text(const char *value
)
1205 if (!strcasecmp(value
, "true")
1206 || !strcasecmp(value
, "yes")
1207 || !strcasecmp(value
, "on"))
1209 if (!strcasecmp(value
, "false")
1210 || !strcasecmp(value
, "no")
1211 || !strcasecmp(value
, "off"))
1216 int git_parse_maybe_bool(const char *value
)
1218 int v
= git_parse_maybe_bool_text(value
);
1221 if (git_parse_int(value
, &v
))
1226 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
1228 int v
= git_parse_maybe_bool_text(value
);
1234 return git_config_int(name
, value
);
1237 int git_config_bool(const char *name
, const char *value
)
1239 int v
= git_parse_maybe_bool(value
);
1241 die(_("bad boolean config value '%s' for '%s'"), value
, name
);
1245 int git_config_string(const char **dest
, const char *var
, const char *value
)
1248 return config_error_nonbool(var
);
1249 *dest
= xstrdup(value
);
1253 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
1256 return config_error_nonbool(var
);
1257 *dest
= interpolate_path(value
, 0);
1259 die(_("failed to expand user dir in: '%s'"), value
);
1263 int git_config_expiry_date(timestamp_t
*timestamp
, const char *var
, const char *value
)
1266 return config_error_nonbool(var
);
1267 if (parse_expiry_date(value
, timestamp
))
1268 return error(_("'%s' for '%s' is not a valid timestamp"),
1273 int git_config_color(char *dest
, const char *var
, const char *value
)
1276 return config_error_nonbool(var
);
1277 if (color_parse(value
, dest
) < 0)
1282 static int git_default_core_config(const char *var
, const char *value
, void *cb
)
1284 /* This needs a better name */
1285 if (!strcmp(var
, "core.filemode")) {
1286 trust_executable_bit
= git_config_bool(var
, value
);
1289 if (!strcmp(var
, "core.trustctime")) {
1290 trust_ctime
= git_config_bool(var
, value
);
1293 if (!strcmp(var
, "core.checkstat")) {
1294 if (!strcasecmp(value
, "default"))
1296 else if (!strcasecmp(value
, "minimal"))
1300 if (!strcmp(var
, "core.quotepath")) {
1301 quote_path_fully
= git_config_bool(var
, value
);
1305 if (!strcmp(var
, "core.symlinks")) {
1306 has_symlinks
= git_config_bool(var
, value
);
1310 if (!strcmp(var
, "core.ignorecase")) {
1311 ignore_case
= git_config_bool(var
, value
);
1315 if (!strcmp(var
, "core.attributesfile"))
1316 return git_config_pathname(&git_attributes_file
, var
, value
);
1318 if (!strcmp(var
, "core.hookspath"))
1319 return git_config_pathname(&git_hooks_path
, var
, value
);
1321 if (!strcmp(var
, "core.bare")) {
1322 is_bare_repository_cfg
= git_config_bool(var
, value
);
1326 if (!strcmp(var
, "core.ignorestat")) {
1327 assume_unchanged
= git_config_bool(var
, value
);
1331 if (!strcmp(var
, "core.prefersymlinkrefs")) {
1332 prefer_symlink_refs
= git_config_bool(var
, value
);
1336 if (!strcmp(var
, "core.logallrefupdates")) {
1337 if (value
&& !strcasecmp(value
, "always"))
1338 log_all_ref_updates
= LOG_REFS_ALWAYS
;
1339 else if (git_config_bool(var
, value
))
1340 log_all_ref_updates
= LOG_REFS_NORMAL
;
1342 log_all_ref_updates
= LOG_REFS_NONE
;
1346 if (!strcmp(var
, "core.warnambiguousrefs")) {
1347 warn_ambiguous_refs
= git_config_bool(var
, value
);
1351 if (!strcmp(var
, "core.abbrev")) {
1353 return config_error_nonbool(var
);
1354 if (!strcasecmp(value
, "auto"))
1355 default_abbrev
= -1;
1356 else if (!git_parse_maybe_bool_text(value
))
1357 default_abbrev
= the_hash_algo
->hexsz
;
1359 int abbrev
= git_config_int(var
, value
);
1360 if (abbrev
< minimum_abbrev
|| abbrev
> the_hash_algo
->hexsz
)
1361 return error(_("abbrev length out of range: %d"), abbrev
);
1362 default_abbrev
= abbrev
;
1367 if (!strcmp(var
, "core.disambiguate"))
1368 return set_disambiguate_hint_config(var
, value
);
1370 if (!strcmp(var
, "core.loosecompression")) {
1371 int level
= git_config_int(var
, value
);
1373 level
= Z_DEFAULT_COMPRESSION
;
1374 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1375 die(_("bad zlib compression level %d"), level
);
1376 zlib_compression_level
= level
;
1377 zlib_compression_seen
= 1;
1381 if (!strcmp(var
, "core.compression")) {
1382 int level
= git_config_int(var
, value
);
1384 level
= Z_DEFAULT_COMPRESSION
;
1385 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1386 die(_("bad zlib compression level %d"), level
);
1387 if (!zlib_compression_seen
)
1388 zlib_compression_level
= level
;
1389 if (!pack_compression_seen
)
1390 pack_compression_level
= level
;
1394 if (!strcmp(var
, "core.packedgitwindowsize")) {
1395 int pgsz_x2
= getpagesize() * 2;
1396 packed_git_window_size
= git_config_ulong(var
, value
);
1398 /* This value must be multiple of (pagesize * 2) */
1399 packed_git_window_size
/= pgsz_x2
;
1400 if (packed_git_window_size
< 1)
1401 packed_git_window_size
= 1;
1402 packed_git_window_size
*= pgsz_x2
;
1406 if (!strcmp(var
, "core.bigfilethreshold")) {
1407 big_file_threshold
= git_config_ulong(var
, value
);
1411 if (!strcmp(var
, "core.packedgitlimit")) {
1412 packed_git_limit
= git_config_ulong(var
, value
);
1416 if (!strcmp(var
, "core.deltabasecachelimit")) {
1417 delta_base_cache_limit
= git_config_ulong(var
, value
);
1421 if (!strcmp(var
, "core.autocrlf")) {
1422 if (value
&& !strcasecmp(value
, "input")) {
1423 auto_crlf
= AUTO_CRLF_INPUT
;
1426 auto_crlf
= git_config_bool(var
, value
);
1430 if (!strcmp(var
, "core.safecrlf")) {
1432 if (value
&& !strcasecmp(value
, "warn")) {
1433 global_conv_flags_eol
= CONV_EOL_RNDTRP_WARN
;
1436 eol_rndtrp_die
= git_config_bool(var
, value
);
1437 global_conv_flags_eol
= eol_rndtrp_die
?
1438 CONV_EOL_RNDTRP_DIE
: 0;
1442 if (!strcmp(var
, "core.eol")) {
1443 if (value
&& !strcasecmp(value
, "lf"))
1445 else if (value
&& !strcasecmp(value
, "crlf"))
1446 core_eol
= EOL_CRLF
;
1447 else if (value
&& !strcasecmp(value
, "native"))
1448 core_eol
= EOL_NATIVE
;
1450 core_eol
= EOL_UNSET
;
1454 if (!strcmp(var
, "core.checkroundtripencoding")) {
1455 check_roundtrip_encoding
= xstrdup(value
);
1459 if (!strcmp(var
, "core.notesref")) {
1460 notes_ref_name
= xstrdup(value
);
1464 if (!strcmp(var
, "core.editor"))
1465 return git_config_string(&editor_program
, var
, value
);
1467 if (!strcmp(var
, "core.commentchar")) {
1469 return config_error_nonbool(var
);
1470 else if (!strcasecmp(value
, "auto"))
1471 auto_comment_line_char
= 1;
1472 else if (value
[0] && !value
[1]) {
1473 comment_line_char
= value
[0];
1474 auto_comment_line_char
= 0;
1476 return error(_("core.commentChar should only be one character"));
1480 if (!strcmp(var
, "core.askpass"))
1481 return git_config_string(&askpass_program
, var
, value
);
1483 if (!strcmp(var
, "core.excludesfile"))
1484 return git_config_pathname(&excludes_file
, var
, value
);
1486 if (!strcmp(var
, "core.whitespace")) {
1488 return config_error_nonbool(var
);
1489 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1493 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1494 fsync_object_files
= git_config_bool(var
, value
);
1498 if (!strcmp(var
, "core.preloadindex")) {
1499 core_preload_index
= git_config_bool(var
, value
);
1503 if (!strcmp(var
, "core.createobject")) {
1504 if (!strcmp(value
, "rename"))
1505 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1506 else if (!strcmp(value
, "link"))
1507 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1509 die(_("invalid mode for object creation: %s"), value
);
1513 if (!strcmp(var
, "core.sparsecheckout")) {
1514 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1518 if (!strcmp(var
, "core.sparsecheckoutcone")) {
1519 core_sparse_checkout_cone
= git_config_bool(var
, value
);
1523 if (!strcmp(var
, "core.precomposeunicode")) {
1524 precomposed_unicode
= git_config_bool(var
, value
);
1528 if (!strcmp(var
, "core.protecthfs")) {
1529 protect_hfs
= git_config_bool(var
, value
);
1533 if (!strcmp(var
, "core.protectntfs")) {
1534 protect_ntfs
= git_config_bool(var
, value
);
1538 if (!strcmp(var
, "core.usereplacerefs")) {
1539 read_replace_refs
= git_config_bool(var
, value
);
1543 /* Add other config variables here and to Documentation/config.txt. */
1544 return platform_core_config(var
, value
, cb
);
1547 static int git_default_sparse_config(const char *var
, const char *value
)
1549 if (!strcmp(var
, "sparse.expectfilesoutsideofpatterns")) {
1550 sparse_expect_files_outside_of_patterns
= git_config_bool(var
, value
);
1554 /* Add other config variables here and to Documentation/config/sparse.txt. */
1558 static int git_default_i18n_config(const char *var
, const char *value
)
1560 if (!strcmp(var
, "i18n.commitencoding"))
1561 return git_config_string(&git_commit_encoding
, var
, value
);
1563 if (!strcmp(var
, "i18n.logoutputencoding"))
1564 return git_config_string(&git_log_output_encoding
, var
, value
);
1566 /* Add other config variables here and to Documentation/config.txt. */
1570 static int git_default_branch_config(const char *var
, const char *value
)
1572 if (!strcmp(var
, "branch.autosetupmerge")) {
1573 if (value
&& !strcmp(value
, "always")) {
1574 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1576 } else if (value
&& !strcmp(value
, "inherit")) {
1577 git_branch_track
= BRANCH_TRACK_INHERIT
;
1580 git_branch_track
= git_config_bool(var
, value
);
1583 if (!strcmp(var
, "branch.autosetuprebase")) {
1585 return config_error_nonbool(var
);
1586 else if (!strcmp(value
, "never"))
1587 autorebase
= AUTOREBASE_NEVER
;
1588 else if (!strcmp(value
, "local"))
1589 autorebase
= AUTOREBASE_LOCAL
;
1590 else if (!strcmp(value
, "remote"))
1591 autorebase
= AUTOREBASE_REMOTE
;
1592 else if (!strcmp(value
, "always"))
1593 autorebase
= AUTOREBASE_ALWAYS
;
1595 return error(_("malformed value for %s"), var
);
1599 /* Add other config variables here and to Documentation/config.txt. */
1603 static int git_default_push_config(const char *var
, const char *value
)
1605 if (!strcmp(var
, "push.default")) {
1607 return config_error_nonbool(var
);
1608 else if (!strcmp(value
, "nothing"))
1609 push_default
= PUSH_DEFAULT_NOTHING
;
1610 else if (!strcmp(value
, "matching"))
1611 push_default
= PUSH_DEFAULT_MATCHING
;
1612 else if (!strcmp(value
, "simple"))
1613 push_default
= PUSH_DEFAULT_SIMPLE
;
1614 else if (!strcmp(value
, "upstream"))
1615 push_default
= PUSH_DEFAULT_UPSTREAM
;
1616 else if (!strcmp(value
, "tracking")) /* deprecated */
1617 push_default
= PUSH_DEFAULT_UPSTREAM
;
1618 else if (!strcmp(value
, "current"))
1619 push_default
= PUSH_DEFAULT_CURRENT
;
1621 error(_("malformed value for %s: %s"), var
, value
);
1622 return error(_("must be one of nothing, matching, simple, "
1623 "upstream or current"));
1628 /* Add other config variables here and to Documentation/config.txt. */
1632 static int git_default_mailmap_config(const char *var
, const char *value
)
1634 if (!strcmp(var
, "mailmap.file"))
1635 return git_config_pathname(&git_mailmap_file
, var
, value
);
1636 if (!strcmp(var
, "mailmap.blob"))
1637 return git_config_string(&git_mailmap_blob
, var
, value
);
1639 /* Add other config variables here and to Documentation/config.txt. */
1643 int git_default_config(const char *var
, const char *value
, void *cb
)
1645 if (starts_with(var
, "core."))
1646 return git_default_core_config(var
, value
, cb
);
1648 if (starts_with(var
, "user.") ||
1649 starts_with(var
, "author.") ||
1650 starts_with(var
, "committer."))
1651 return git_ident_config(var
, value
, cb
);
1653 if (starts_with(var
, "i18n."))
1654 return git_default_i18n_config(var
, value
);
1656 if (starts_with(var
, "branch."))
1657 return git_default_branch_config(var
, value
);
1659 if (starts_with(var
, "push."))
1660 return git_default_push_config(var
, value
);
1662 if (starts_with(var
, "mailmap."))
1663 return git_default_mailmap_config(var
, value
);
1665 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1666 return git_default_advice_config(var
, value
);
1668 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1669 pager_use_color
= git_config_bool(var
,value
);
1673 if (!strcmp(var
, "pack.packsizelimit")) {
1674 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1678 if (!strcmp(var
, "pack.compression")) {
1679 int level
= git_config_int(var
, value
);
1681 level
= Z_DEFAULT_COMPRESSION
;
1682 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1683 die(_("bad pack compression level %d"), level
);
1684 pack_compression_level
= level
;
1685 pack_compression_seen
= 1;
1689 if (starts_with(var
, "sparse."))
1690 return git_default_sparse_config(var
, value
);
1692 /* Add other config variables here and to Documentation/config.txt. */
1697 * All source specific fields in the union, die_on_error, name and the callbacks
1698 * fgetc, ungetc, ftell of top need to be initialized before calling
1701 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
,
1702 const struct config_options
*opts
)
1706 /* push config-file parsing state stack */
1711 strbuf_init(&top
->value
, 1024);
1712 strbuf_init(&top
->var
, 1024);
1715 ret
= git_parse_source(fn
, data
, opts
);
1717 /* pop config-file parsing state stack */
1718 strbuf_release(&top
->value
);
1719 strbuf_release(&top
->var
);
1725 static int do_config_from_file(config_fn_t fn
,
1726 const enum config_origin_type origin_type
,
1727 const char *name
, const char *path
, FILE *f
,
1728 void *data
, const struct config_options
*opts
)
1730 struct config_source top
;
1734 top
.origin_type
= origin_type
;
1737 top
.default_error_action
= CONFIG_ERROR_DIE
;
1738 top
.do_fgetc
= config_file_fgetc
;
1739 top
.do_ungetc
= config_file_ungetc
;
1740 top
.do_ftell
= config_file_ftell
;
1743 ret
= do_config_from(&top
, fn
, data
, opts
);
1748 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1750 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
,
1754 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
1756 const struct config_options
*opts
)
1761 f
= fopen_or_warn(filename
, "r");
1763 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
,
1764 filename
, f
, data
, opts
);
1770 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1772 return git_config_from_file_with_options(fn
, filename
, data
, NULL
);
1775 int git_config_from_mem(config_fn_t fn
,
1776 const enum config_origin_type origin_type
,
1777 const char *name
, const char *buf
, size_t len
,
1778 void *data
, const struct config_options
*opts
)
1780 struct config_source top
;
1782 top
.u
.buf
.buf
= buf
;
1783 top
.u
.buf
.len
= len
;
1785 top
.origin_type
= origin_type
;
1788 top
.default_error_action
= CONFIG_ERROR_ERROR
;
1789 top
.do_fgetc
= config_buf_fgetc
;
1790 top
.do_ungetc
= config_buf_ungetc
;
1791 top
.do_ftell
= config_buf_ftell
;
1793 return do_config_from(&top
, fn
, data
, opts
);
1796 int git_config_from_blob_oid(config_fn_t fn
,
1798 struct repository
*repo
,
1799 const struct object_id
*oid
,
1802 enum object_type type
;
1807 buf
= repo_read_object_file(repo
, oid
, &type
, &size
);
1809 return error(_("unable to load config blob object '%s'"), name
);
1810 if (type
!= OBJ_BLOB
) {
1812 return error(_("reference '%s' does not point to a blob"), name
);
1815 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
1822 static int git_config_from_blob_ref(config_fn_t fn
,
1823 struct repository
*repo
,
1827 struct object_id oid
;
1829 if (repo_get_oid(repo
, name
, &oid
) < 0)
1830 return error(_("unable to resolve config blob '%s'"), name
);
1831 return git_config_from_blob_oid(fn
, name
, repo
, &oid
, data
);
1834 char *git_system_config(void)
1836 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1838 system_config
= system_path(ETC_GITCONFIG
);
1839 normalize_path_copy(system_config
, system_config
);
1840 return system_config
;
1843 void git_global_config(char **user_out
, char **xdg_out
)
1845 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1846 char *xdg_config
= NULL
;
1849 user_config
= interpolate_path("~/.gitconfig", 0);
1850 xdg_config
= xdg_config_home("config");
1853 *user_out
= user_config
;
1854 *xdg_out
= xdg_config
;
1858 * Parse environment variable 'k' as a boolean (in various
1859 * possible spellings); if missing, use the default value 'def'.
1861 int git_env_bool(const char *k
, int def
)
1863 const char *v
= getenv(k
);
1864 return v
? git_config_bool(k
, v
) : def
;
1868 * Parse environment variable 'k' as ulong with possibly a unit
1869 * suffix; if missing, use the default value 'val'.
1871 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1873 const char *v
= getenv(k
);
1874 if (v
&& !git_parse_ulong(v
, &val
))
1875 die(_("failed to parse %s"), k
);
1879 int git_config_system(void)
1881 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1884 static int do_git_config_sequence(const struct config_options
*opts
,
1885 config_fn_t fn
, void *data
)
1888 char *system_config
= git_system_config();
1889 char *xdg_config
= NULL
;
1890 char *user_config
= NULL
;
1892 enum config_scope prev_parsing_scope
= current_parsing_scope
;
1894 if (opts
->commondir
)
1895 repo_config
= mkpathdup("%s/config", opts
->commondir
);
1896 else if (opts
->git_dir
)
1897 BUG("git_dir without commondir");
1901 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1902 if (git_config_system() && system_config
&&
1903 !access_or_die(system_config
, R_OK
,
1904 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
1905 ret
+= git_config_from_file(fn
, system_config
, data
);
1907 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1908 git_global_config(&user_config
, &xdg_config
);
1910 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1911 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1913 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1914 ret
+= git_config_from_file(fn
, user_config
, data
);
1916 current_parsing_scope
= CONFIG_SCOPE_LOCAL
;
1917 if (!opts
->ignore_repo
&& repo_config
&&
1918 !access_or_die(repo_config
, R_OK
, 0))
1919 ret
+= git_config_from_file(fn
, repo_config
, data
);
1921 current_parsing_scope
= CONFIG_SCOPE_WORKTREE
;
1922 if (!opts
->ignore_worktree
&& repository_format_worktree_config
) {
1923 char *path
= git_pathdup("config.worktree");
1924 if (!access_or_die(path
, R_OK
, 0))
1925 ret
+= git_config_from_file(fn
, path
, data
);
1929 current_parsing_scope
= CONFIG_SCOPE_COMMAND
;
1930 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
1931 die(_("unable to parse command-line config"));
1933 current_parsing_scope
= prev_parsing_scope
;
1934 free(system_config
);
1941 int config_with_options(config_fn_t fn
, void *data
,
1942 struct git_config_source
*config_source
,
1943 const struct config_options
*opts
)
1945 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1947 if (opts
->respect_includes
) {
1951 fn
= git_config_include
;
1956 current_parsing_scope
= config_source
->scope
;
1959 * If we have a specific filename, use it. Otherwise, follow the
1960 * regular lookup sequence.
1962 if (config_source
&& config_source
->use_stdin
) {
1963 return git_config_from_stdin(fn
, data
);
1964 } else if (config_source
&& config_source
->file
) {
1965 return git_config_from_file(fn
, config_source
->file
, data
);
1966 } else if (config_source
&& config_source
->blob
) {
1967 struct repository
*repo
= config_source
->repo
?
1968 config_source
->repo
: the_repository
;
1969 return git_config_from_blob_ref(fn
, repo
, config_source
->blob
,
1973 return do_git_config_sequence(opts
, fn
, data
);
1976 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1979 struct string_list
*values
;
1980 struct config_set_element
*entry
;
1981 struct configset_list
*list
= &cs
->list
;
1983 for (i
= 0; i
< list
->nr
; i
++) {
1984 entry
= list
->items
[i
].e
;
1985 value_index
= list
->items
[i
].value_index
;
1986 values
= &entry
->value_list
;
1988 current_config_kvi
= values
->items
[value_index
].util
;
1990 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1991 git_die_config_linenr(entry
->key
,
1992 current_config_kvi
->filename
,
1993 current_config_kvi
->linenr
);
1995 current_config_kvi
= NULL
;
1999 void read_early_config(config_fn_t cb
, void *data
)
2001 struct config_options opts
= {0};
2002 struct strbuf commondir
= STRBUF_INIT
;
2003 struct strbuf gitdir
= STRBUF_INIT
;
2005 opts
.respect_includes
= 1;
2007 if (have_git_dir()) {
2008 opts
.commondir
= get_git_common_dir();
2009 opts
.git_dir
= get_git_dir();
2011 * When setup_git_directory() was not yet asked to discover the
2012 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2013 * is any repository config we should use (but unlike
2014 * setup_git_directory_gently(), no global state is changed, most
2015 * notably, the current working directory is still the same after the
2018 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
2019 opts
.commondir
= commondir
.buf
;
2020 opts
.git_dir
= gitdir
.buf
;
2023 config_with_options(cb
, data
, NULL
, &opts
);
2025 strbuf_release(&commondir
);
2026 strbuf_release(&gitdir
);
2030 * Read config but only enumerate system and global settings.
2031 * Omit any repo-local, worktree-local, or command-line settings.
2033 void read_very_early_config(config_fn_t cb
, void *data
)
2035 struct config_options opts
= { 0 };
2037 opts
.respect_includes
= 1;
2038 opts
.ignore_repo
= 1;
2039 opts
.ignore_worktree
= 1;
2040 opts
.ignore_cmdline
= 1;
2041 opts
.system_gently
= 1;
2043 config_with_options(cb
, data
, NULL
, &opts
);
2046 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
2048 struct config_set_element k
;
2049 struct config_set_element
*found_entry
;
2050 char *normalized_key
;
2052 * `key` may come from the user, so normalize it before using it
2053 * for querying entries from the hashmap.
2055 if (git_config_parse_key(key
, &normalized_key
, NULL
))
2058 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2059 k
.key
= normalized_key
;
2060 found_entry
= hashmap_get_entry(&cs
->config_hash
, &k
, ent
, NULL
);
2061 free(normalized_key
);
2065 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
2067 struct config_set_element
*e
;
2068 struct string_list_item
*si
;
2069 struct configset_list_item
*l_item
;
2070 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2072 e
= configset_find_element(cs
, key
);
2074 * Since the keys are being fed by git_config*() callback mechanism, they
2075 * are already normalized. So simply add them without any further munging.
2078 e
= xmalloc(sizeof(*e
));
2079 hashmap_entry_init(&e
->ent
, strhash(key
));
2080 e
->key
= xstrdup(key
);
2081 string_list_init_dup(&e
->value_list
);
2082 hashmap_add(&cs
->config_hash
, &e
->ent
);
2084 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2086 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
2087 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
2089 l_item
->value_index
= e
->value_list
.nr
- 1;
2092 BUG("configset_add_value has no source");
2094 kv_info
->filename
= strintern(cf
->name
);
2095 kv_info
->linenr
= cf
->linenr
;
2096 kv_info
->origin_type
= cf
->origin_type
;
2098 /* for values read from `git_config_from_parameters()` */
2099 kv_info
->filename
= NULL
;
2100 kv_info
->linenr
= -1;
2101 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
2103 kv_info
->scope
= current_parsing_scope
;
2109 static int config_set_element_cmp(const void *unused_cmp_data
,
2110 const struct hashmap_entry
*eptr
,
2111 const struct hashmap_entry
*entry_or_key
,
2112 const void *unused_keydata
)
2114 const struct config_set_element
*e1
, *e2
;
2116 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2117 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2119 return strcmp(e1
->key
, e2
->key
);
2122 void git_configset_init(struct config_set
*cs
)
2124 hashmap_init(&cs
->config_hash
, config_set_element_cmp
, NULL
, 0);
2125 cs
->hash_initialized
= 1;
2128 cs
->list
.items
= NULL
;
2131 void git_configset_clear(struct config_set
*cs
)
2133 struct config_set_element
*entry
;
2134 struct hashmap_iter iter
;
2135 if (!cs
->hash_initialized
)
2138 hashmap_for_each_entry(&cs
->config_hash
, &iter
, entry
,
2139 ent
/* member name */) {
2141 string_list_clear(&entry
->value_list
, 1);
2143 hashmap_clear_and_free(&cs
->config_hash
, struct config_set_element
, ent
);
2144 cs
->hash_initialized
= 0;
2145 free(cs
->list
.items
);
2148 cs
->list
.items
= NULL
;
2151 static int config_set_callback(const char *key
, const char *value
, void *cb
)
2153 struct config_set
*cs
= cb
;
2154 configset_add_value(cs
, key
, value
);
2158 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
2160 return git_config_from_file(config_set_callback
, filename
, cs
);
2163 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
2165 const struct string_list
*values
= NULL
;
2167 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2168 * queried key in the files of the configset, the value returned will be the last
2169 * value in the value list for that key.
2171 values
= git_configset_get_value_multi(cs
, key
);
2175 assert(values
->nr
> 0);
2176 *value
= values
->items
[values
->nr
- 1].string
;
2180 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
2182 struct config_set_element
*e
= configset_find_element(cs
, key
);
2183 return e
? &e
->value_list
: NULL
;
2186 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
2189 if (!git_configset_get_value(cs
, key
, &value
))
2190 return git_config_string((const char **)dest
, key
, value
);
2195 int git_configset_get_string_tmp(struct config_set
*cs
, const char *key
,
2199 if (!git_configset_get_value(cs
, key
, &value
)) {
2201 return config_error_nonbool(key
);
2209 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
2212 if (!git_configset_get_value(cs
, key
, &value
)) {
2213 *dest
= git_config_int(key
, value
);
2219 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
2222 if (!git_configset_get_value(cs
, key
, &value
)) {
2223 *dest
= git_config_ulong(key
, value
);
2229 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
2232 if (!git_configset_get_value(cs
, key
, &value
)) {
2233 *dest
= git_config_bool(key
, value
);
2239 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
2240 int *is_bool
, int *dest
)
2243 if (!git_configset_get_value(cs
, key
, &value
)) {
2244 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
2250 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
2253 if (!git_configset_get_value(cs
, key
, &value
)) {
2254 *dest
= git_parse_maybe_bool(value
);
2262 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
2265 if (!git_configset_get_value(cs
, key
, &value
))
2266 return git_config_pathname(dest
, key
, value
);
2271 /* Functions use to read configuration from a repository */
2272 static void repo_read_config(struct repository
*repo
)
2274 struct config_options opts
= { 0 };
2276 opts
.respect_includes
= 1;
2277 opts
.commondir
= repo
->commondir
;
2278 opts
.git_dir
= repo
->gitdir
;
2281 CALLOC_ARRAY(repo
->config
, 1);
2283 git_configset_clear(repo
->config
);
2285 git_configset_init(repo
->config
);
2287 if (config_with_options(config_set_callback
, repo
->config
, NULL
, &opts
) < 0)
2289 * config_with_options() normally returns only
2290 * zero, as most errors are fatal, and
2291 * non-fatal potential errors are guarded by "if"
2292 * statements that are entered only when no error is
2295 * If we ever encounter a non-fatal error, it means
2296 * something went really wrong and we should stop
2299 die(_("unknown error occurred while reading the configuration files"));
2302 static void git_config_check_init(struct repository
*repo
)
2304 if (repo
->config
&& repo
->config
->hash_initialized
)
2306 repo_read_config(repo
);
2309 static void repo_config_clear(struct repository
*repo
)
2311 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2313 git_configset_clear(repo
->config
);
2316 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2318 git_config_check_init(repo
);
2319 configset_iter(repo
->config
, fn
, data
);
2322 int repo_config_get_value(struct repository
*repo
,
2323 const char *key
, const char **value
)
2325 git_config_check_init(repo
);
2326 return git_configset_get_value(repo
->config
, key
, value
);
2329 const struct string_list
*repo_config_get_value_multi(struct repository
*repo
,
2332 git_config_check_init(repo
);
2333 return git_configset_get_value_multi(repo
->config
, key
);
2336 int repo_config_get_string(struct repository
*repo
,
2337 const char *key
, char **dest
)
2340 git_config_check_init(repo
);
2341 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2343 git_die_config(key
, NULL
);
2347 int repo_config_get_string_tmp(struct repository
*repo
,
2348 const char *key
, const char **dest
)
2351 git_config_check_init(repo
);
2352 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2354 git_die_config(key
, NULL
);
2358 int repo_config_get_int(struct repository
*repo
,
2359 const char *key
, int *dest
)
2361 git_config_check_init(repo
);
2362 return git_configset_get_int(repo
->config
, key
, dest
);
2365 int repo_config_get_ulong(struct repository
*repo
,
2366 const char *key
, unsigned long *dest
)
2368 git_config_check_init(repo
);
2369 return git_configset_get_ulong(repo
->config
, key
, dest
);
2372 int repo_config_get_bool(struct repository
*repo
,
2373 const char *key
, int *dest
)
2375 git_config_check_init(repo
);
2376 return git_configset_get_bool(repo
->config
, key
, dest
);
2379 int repo_config_get_bool_or_int(struct repository
*repo
,
2380 const char *key
, int *is_bool
, int *dest
)
2382 git_config_check_init(repo
);
2383 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2386 int repo_config_get_maybe_bool(struct repository
*repo
,
2387 const char *key
, int *dest
)
2389 git_config_check_init(repo
);
2390 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2393 int repo_config_get_pathname(struct repository
*repo
,
2394 const char *key
, const char **dest
)
2397 git_config_check_init(repo
);
2398 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2400 git_die_config(key
, NULL
);
2404 /* Functions used historically to read configuration from 'the_repository' */
2405 void git_config(config_fn_t fn
, void *data
)
2407 repo_config(the_repository
, fn
, data
);
2410 void git_config_clear(void)
2412 repo_config_clear(the_repository
);
2415 int git_config_get_value(const char *key
, const char **value
)
2417 return repo_config_get_value(the_repository
, key
, value
);
2420 const struct string_list
*git_config_get_value_multi(const char *key
)
2422 return repo_config_get_value_multi(the_repository
, key
);
2425 int git_config_get_string(const char *key
, char **dest
)
2427 return repo_config_get_string(the_repository
, key
, dest
);
2430 int git_config_get_string_tmp(const char *key
, const char **dest
)
2432 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2435 int git_config_get_int(const char *key
, int *dest
)
2437 return repo_config_get_int(the_repository
, key
, dest
);
2440 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2442 return repo_config_get_ulong(the_repository
, key
, dest
);
2445 int git_config_get_bool(const char *key
, int *dest
)
2447 return repo_config_get_bool(the_repository
, key
, dest
);
2450 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2452 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2455 int git_config_get_maybe_bool(const char *key
, int *dest
)
2457 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2460 int git_config_get_pathname(const char *key
, const char **dest
)
2462 return repo_config_get_pathname(the_repository
, key
, dest
);
2465 int git_config_get_expiry(const char *key
, const char **output
)
2467 int ret
= git_config_get_string(key
, (char **)output
);
2470 if (strcmp(*output
, "now")) {
2471 timestamp_t now
= approxidate("now");
2472 if (approxidate(*output
) >= now
)
2473 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2478 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2480 const char *expiry_string
;
2484 if (git_config_get_string_tmp(key
, &expiry_string
))
2485 return 1; /* no such thing */
2487 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2488 const int scale
= 86400;
2489 *expiry
= now
- days
* scale
;
2493 if (!parse_expiry_date(expiry_string
, &when
)) {
2497 return -1; /* thing exists but cannot be parsed */
2500 int git_config_get_split_index(void)
2504 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2507 return -1; /* default value */
2510 int git_config_get_max_percent_split_change(void)
2514 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2515 if (0 <= val
&& val
<= 100)
2518 return error(_("splitIndex.maxPercentChange value '%d' "
2519 "should be between 0 and 100"), val
);
2522 return -1; /* default value */
2525 int git_config_get_fsmonitor(void)
2527 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor
))
2528 core_fsmonitor
= getenv("GIT_TEST_FSMONITOR");
2530 if (core_fsmonitor
&& !*core_fsmonitor
)
2531 core_fsmonitor
= NULL
;
2539 int git_config_get_index_threads(int *dest
)
2543 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2549 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2551 *dest
= val
? 0 : 1;
2561 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2564 die(_("unable to parse '%s' from command-line config"), key
);
2566 die(_("bad config variable '%s' in file '%s' at line %d"),
2567 key
, filename
, linenr
);
2570 NORETURN
__attribute__((format(printf
, 2, 3)))
2571 void git_die_config(const char *key
, const char *err
, ...)
2573 const struct string_list
*values
;
2574 struct key_value_info
*kv_info
;
2575 report_fn error_fn
= get_error_routine();
2579 va_start(params
, err
);
2580 error_fn(err
, params
);
2583 values
= git_config_get_value_multi(key
);
2584 kv_info
= values
->items
[values
->nr
- 1].util
;
2585 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
2589 * Find all the stuff for git_config_set() below.
2592 struct config_store_data
{
2596 const char *fixed_value
;
2597 regex_t
*value_pattern
;
2601 enum config_event_t type
;
2602 int is_keys_section
;
2604 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
2605 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
2608 static void config_store_data_clear(struct config_store_data
*store
)
2611 if (store
->value_pattern
!= NULL
&&
2612 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
2613 regfree(store
->value_pattern
);
2614 free(store
->value_pattern
);
2616 free(store
->parsed
);
2618 memset(store
, 0, sizeof(*store
));
2621 static int matches(const char *key
, const char *value
,
2622 const struct config_store_data
*store
)
2624 if (strcmp(key
, store
->key
))
2625 return 0; /* not ours */
2626 if (store
->fixed_value
)
2627 return !strcmp(store
->fixed_value
, value
);
2628 if (!store
->value_pattern
)
2629 return 1; /* always matches */
2630 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
2631 return 0; /* never matches */
2633 return store
->do_not_match
^
2634 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
2637 static int store_aux_event(enum config_event_t type
,
2638 size_t begin
, size_t end
, void *data
)
2640 struct config_store_data
*store
= data
;
2642 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
2643 store
->parsed
[store
->parsed_nr
].begin
= begin
;
2644 store
->parsed
[store
->parsed_nr
].end
= end
;
2645 store
->parsed
[store
->parsed_nr
].type
= type
;
2647 if (type
== CONFIG_EVENT_SECTION
) {
2648 int (*cmpfn
)(const char *, const char *, size_t);
2650 if (cf
->var
.len
< 2 || cf
->var
.buf
[cf
->var
.len
- 1] != '.')
2651 return error(_("invalid section name '%s'"), cf
->var
.buf
);
2653 if (cf
->subsection_case_sensitive
)
2654 cmpfn
= strncasecmp
;
2658 /* Is this the section we were looking for? */
2659 store
->is_keys_section
=
2660 store
->parsed
[store
->parsed_nr
].is_keys_section
=
2661 cf
->var
.len
- 1 == store
->baselen
&&
2662 !cmpfn(cf
->var
.buf
, store
->key
, store
->baselen
);
2663 if (store
->is_keys_section
) {
2664 store
->section_seen
= 1;
2665 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2667 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2676 static int store_aux(const char *key
, const char *value
, void *cb
)
2678 struct config_store_data
*store
= cb
;
2680 if (store
->key_seen
) {
2681 if (matches(key
, value
, store
)) {
2682 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
2683 warning(_("%s has multiple values"), key
);
2686 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2689 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2692 } else if (store
->is_keys_section
) {
2694 * Do not increment matches yet: this may not be a match, but we
2695 * are in the desired section.
2697 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
2698 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2699 store
->section_seen
= 1;
2701 if (matches(key
, value
, store
)) {
2703 store
->key_seen
= 1;
2710 static int write_error(const char *filename
)
2712 error(_("failed to write new configuration file %s"), filename
);
2714 /* Same error code as "failed to rename". */
2718 static struct strbuf
store_create_section(const char *key
,
2719 const struct config_store_data
*store
)
2723 struct strbuf sb
= STRBUF_INIT
;
2725 dot
= memchr(key
, '.', store
->baselen
);
2727 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
2728 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
2729 if (key
[i
] == '"' || key
[i
] == '\\')
2730 strbuf_addch(&sb
, '\\');
2731 strbuf_addch(&sb
, key
[i
]);
2733 strbuf_addstr(&sb
, "\"]\n");
2735 strbuf_addch(&sb
, '[');
2736 strbuf_add(&sb
, key
, store
->baselen
);
2737 strbuf_addstr(&sb
, "]\n");
2743 static ssize_t
write_section(int fd
, const char *key
,
2744 const struct config_store_data
*store
)
2746 struct strbuf sb
= store_create_section(key
, store
);
2749 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2750 strbuf_release(&sb
);
2755 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
2756 const struct config_store_data
*store
)
2760 const char *quote
= "";
2761 struct strbuf sb
= STRBUF_INIT
;
2764 * Check to see if the value needs to be surrounded with a dq pair.
2765 * Note that problematic characters are always backslash-quoted; this
2766 * check is about not losing leading or trailing SP and strings that
2767 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2768 * configuration parser.
2770 if (value
[0] == ' ')
2772 for (i
= 0; value
[i
]; i
++)
2773 if (value
[i
] == ';' || value
[i
] == '#')
2775 if (i
&& value
[i
- 1] == ' ')
2778 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
2780 for (i
= 0; value
[i
]; i
++)
2783 strbuf_addstr(&sb
, "\\n");
2786 strbuf_addstr(&sb
, "\\t");
2790 strbuf_addch(&sb
, '\\');
2793 strbuf_addch(&sb
, value
[i
]);
2796 strbuf_addf(&sb
, "%s\n", quote
);
2798 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2799 strbuf_release(&sb
);
2805 * If we are about to unset the last key(s) in a section, and if there are
2806 * no comments surrounding (or included in) the section, we will want to
2807 * extend begin/end to remove the entire section.
2809 * Note: the parameter `seen_ptr` points to the index into the store.seen
2810 * array. * This index may be incremented if a section has more than one
2811 * entry (which all are to be removed).
2813 static void maybe_remove_section(struct config_store_data
*store
,
2814 size_t *begin_offset
, size_t *end_offset
,
2818 int i
, seen
, section_seen
= 0;
2821 * First, ensure that this is the first key, and that there are no
2822 * comments before the entry nor before the section header.
2825 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
2826 enum config_event_t type
= store
->parsed
[i
- 1].type
;
2828 if (type
== CONFIG_EVENT_COMMENT
)
2829 /* There is a comment before this entry or section */
2831 if (type
== CONFIG_EVENT_ENTRY
) {
2833 /* This is not the section's first entry. */
2835 /* We encountered no comment before the section. */
2838 if (type
== CONFIG_EVENT_SECTION
) {
2839 if (!store
->parsed
[i
- 1].is_keys_section
)
2844 begin
= store
->parsed
[i
].begin
;
2847 * Next, make sure that we are removing the last key(s) in the section,
2848 * and that there are no comments that are possibly about the current
2851 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
2852 enum config_event_t type
= store
->parsed
[i
].type
;
2854 if (type
== CONFIG_EVENT_COMMENT
)
2856 if (type
== CONFIG_EVENT_SECTION
) {
2857 if (store
->parsed
[i
].is_keys_section
)
2861 if (type
== CONFIG_EVENT_ENTRY
) {
2862 if (++seen
< store
->seen_nr
&&
2863 i
== store
->seen
[seen
])
2864 /* We want to remove this entry, too */
2866 /* There is another entry in this section. */
2872 * We are really removing the last entry/entries from this section, and
2873 * there are no enclosed or surrounding comments. Remove the entire,
2874 * now-empty section.
2877 *begin_offset
= begin
;
2878 if (i
< store
->parsed_nr
)
2879 *end_offset
= store
->parsed
[i
].begin
;
2881 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
2884 int git_config_set_in_file_gently(const char *config_filename
,
2885 const char *key
, const char *value
)
2887 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
2890 void git_config_set_in_file(const char *config_filename
,
2891 const char *key
, const char *value
)
2893 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
2896 int git_config_set_gently(const char *key
, const char *value
)
2898 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
2901 void git_config_set(const char *key
, const char *value
)
2903 git_config_set_multivar(key
, value
, NULL
, 0);
2905 trace2_cmd_set_config(key
, value
);
2909 * If value==NULL, unset in (remove from) config,
2910 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2911 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2912 * (only add a new one)
2913 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2914 * key/values are removed before a single new pair is written. If the
2915 * flag is not present, then replace only the first match.
2917 * Returns 0 on success.
2919 * This function does this:
2921 * - it locks the config file by creating ".git/config.lock"
2923 * - it then parses the config using store_aux() as validator to find
2924 * the position on the key/value pair to replace. If it is to be unset,
2925 * it must be found exactly once.
2927 * - the config file is mmap()ed and the part before the match (if any) is
2928 * written to the lock file, then the changed part and the rest.
2930 * - the config file is removed and the lock file rename()d to it.
2933 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2934 const char *key
, const char *value
,
2935 const char *value_pattern
,
2938 int fd
= -1, in_fd
= -1;
2940 struct lock_file lock
= LOCK_INIT
;
2941 char *filename_buf
= NULL
;
2942 char *contents
= NULL
;
2944 struct config_store_data store
;
2946 memset(&store
, 0, sizeof(store
));
2948 /* parse-key returns negative; flip the sign to feed exit(3) */
2949 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2953 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
2955 if (!config_filename
)
2956 config_filename
= filename_buf
= git_pathdup("config");
2959 * The lock serves a purpose in addition to locking: the new
2960 * contents of .git/config will be written into it.
2962 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
2964 error_errno(_("could not lock config file %s"), config_filename
);
2965 ret
= CONFIG_NO_LOCK
;
2970 * If .git/config does not exist yet, write a minimal version.
2972 in_fd
= open(config_filename
, O_RDONLY
);
2974 if ( ENOENT
!= errno
) {
2975 error_errno(_("opening %s"), config_filename
);
2976 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2979 /* if nothing to unset, error out */
2980 if (value
== NULL
) {
2981 ret
= CONFIG_NOTHING_SET
;
2986 store
.key
= xstrdup(key
);
2987 if (write_section(fd
, key
, &store
) < 0 ||
2988 write_pair(fd
, key
, value
, &store
) < 0)
2992 size_t copy_begin
, copy_end
;
2993 int i
, new_line
= 0;
2994 struct config_options opts
;
2996 if (value_pattern
== NULL
)
2997 store
.value_pattern
= NULL
;
2998 else if (value_pattern
== CONFIG_REGEX_NONE
)
2999 store
.value_pattern
= CONFIG_REGEX_NONE
;
3000 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
3001 store
.fixed_value
= value_pattern
;
3003 if (value_pattern
[0] == '!') {
3004 store
.do_not_match
= 1;
3007 store
.do_not_match
= 0;
3009 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
3010 if (regcomp(store
.value_pattern
, value_pattern
,
3012 error(_("invalid pattern: %s"), value_pattern
);
3013 FREE_AND_NULL(store
.value_pattern
);
3014 ret
= CONFIG_INVALID_PATTERN
;
3019 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
3020 store
.parsed
[0].end
= 0;
3022 memset(&opts
, 0, sizeof(opts
));
3023 opts
.event_fn
= store_aux_event
;
3024 opts
.event_fn_data
= &store
;
3027 * After this, store.parsed will contain offsets of all the
3028 * parsed elements, and store.seen will contain a list of
3029 * matches, as indices into store.parsed.
3031 * As a side effect, we make sure to transform only a valid
3032 * existing config file.
3034 if (git_config_from_file_with_options(store_aux
,
3037 error(_("invalid config file %s"), config_filename
);
3038 ret
= CONFIG_INVALID_FILE
;
3042 /* if nothing to unset, or too many matches, error out */
3043 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3044 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3045 ret
= CONFIG_NOTHING_SET
;
3049 if (fstat(in_fd
, &st
) == -1) {
3050 error_errno(_("fstat on %s failed"), config_filename
);
3051 ret
= CONFIG_INVALID_FILE
;
3055 contents_sz
= xsize_t(st
.st_size
);
3056 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3057 MAP_PRIVATE
, in_fd
, 0);
3058 if (contents
== MAP_FAILED
) {
3059 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3061 error_errno(_("unable to mmap '%s'%s"),
3062 config_filename
, mmap_os_err());
3063 ret
= CONFIG_INVALID_FILE
;
3070 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3071 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3072 ret
= CONFIG_NO_WRITE
;
3076 if (store
.seen_nr
== 0) {
3077 if (!store
.seen_alloc
) {
3078 /* Did not see key nor section */
3079 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3080 store
.seen
[0] = store
.parsed_nr
3081 - !!store
.parsed_nr
;
3086 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3088 int j
= store
.seen
[i
];
3091 if (!store
.key_seen
) {
3092 copy_end
= store
.parsed
[j
].end
;
3093 /* include '\n' when copying section header */
3094 if (copy_end
> 0 && copy_end
< contents_sz
&&
3095 contents
[copy_end
- 1] != '\n' &&
3096 contents
[copy_end
] == '\n')
3098 replace_end
= copy_end
;
3100 replace_end
= store
.parsed
[j
].end
;
3101 copy_end
= store
.parsed
[j
].begin
;
3103 maybe_remove_section(&store
,
3107 * Swallow preceding white-space on the same
3110 while (copy_end
> 0 ) {
3111 char c
= contents
[copy_end
- 1];
3113 if (isspace(c
) && c
!= '\n')
3120 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3123 /* write the first part of the config */
3124 if (copy_end
> copy_begin
) {
3125 if (write_in_full(fd
, contents
+ copy_begin
,
3126 copy_end
- copy_begin
) < 0)
3129 write_str_in_full(fd
, "\n") < 0)
3132 copy_begin
= replace_end
;
3135 /* write the pair (value == NULL means unset) */
3136 if (value
!= NULL
) {
3137 if (!store
.section_seen
) {
3138 if (write_section(fd
, key
, &store
) < 0)
3141 if (write_pair(fd
, key
, value
, &store
) < 0)
3145 /* write the rest of the config */
3146 if (copy_begin
< contents_sz
)
3147 if (write_in_full(fd
, contents
+ copy_begin
,
3148 contents_sz
- copy_begin
) < 0)
3151 munmap(contents
, contents_sz
);
3155 if (commit_lock_file(&lock
) < 0) {
3156 error_errno(_("could not write config file %s"), config_filename
);
3157 ret
= CONFIG_NO_WRITE
;
3163 /* Invalidate the config cache */
3167 rollback_lock_file(&lock
);
3170 munmap(contents
, contents_sz
);
3173 config_store_data_clear(&store
);
3177 ret
= write_error(get_lock_file_path(&lock
));
3182 void git_config_set_multivar_in_file(const char *config_filename
,
3183 const char *key
, const char *value
,
3184 const char *value_pattern
, unsigned flags
)
3186 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3187 value_pattern
, flags
))
3190 die(_("could not set '%s' to '%s'"), key
, value
);
3192 die(_("could not unset '%s'"), key
);
3195 int git_config_set_multivar_gently(const char *key
, const char *value
,
3196 const char *value_pattern
, unsigned flags
)
3198 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_pattern
,
3202 void git_config_set_multivar(const char *key
, const char *value
,
3203 const char *value_pattern
, unsigned flags
)
3205 git_config_set_multivar_in_file(NULL
, key
, value
, value_pattern
,
3209 static int section_name_match (const char *buf
, const char *name
)
3211 int i
= 0, j
= 0, dot
= 0;
3214 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3215 if (!dot
&& isspace(buf
[i
])) {
3217 if (name
[j
++] != '.')
3219 for (i
++; isspace(buf
[i
]); i
++)
3225 if (buf
[i
] == '\\' && dot
)
3227 else if (buf
[i
] == '"' && dot
) {
3228 for (i
++; isspace(buf
[i
]); i
++)
3232 if (buf
[i
] != name
[j
++])
3235 if (buf
[i
] == ']' && name
[j
] == 0) {
3237 * We match, now just find the right length offset by
3238 * gobbling up any whitespace after it, as well
3241 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3248 static int section_name_is_ok(const char *name
)
3250 /* Empty section names are bogus. */
3255 * Before a dot, we must be alphanumeric or dash. After the first dot,
3256 * anything goes, so we can stop checking.
3258 for (; *name
&& *name
!= '.'; name
++)
3259 if (*name
!= '-' && !isalnum(*name
))
3264 /* if new_name == NULL, the section is removed instead */
3265 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3266 const char *old_name
,
3267 const char *new_name
, int copy
)
3269 int ret
= 0, remove
= 0;
3270 char *filename_buf
= NULL
;
3271 struct lock_file lock
= LOCK_INIT
;
3274 FILE *config_file
= NULL
;
3276 struct strbuf copystr
= STRBUF_INIT
;
3277 struct config_store_data store
;
3279 memset(&store
, 0, sizeof(store
));
3281 if (new_name
&& !section_name_is_ok(new_name
)) {
3282 ret
= error(_("invalid section name: %s"), new_name
);
3283 goto out_no_rollback
;
3286 if (!config_filename
)
3287 config_filename
= filename_buf
= git_pathdup("config");
3289 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3291 ret
= error(_("could not lock config file %s"), config_filename
);
3295 if (!(config_file
= fopen(config_filename
, "rb"))) {
3296 ret
= warn_on_fopen_errors(config_filename
);
3299 /* no config file means nothing to rename, no error */
3300 goto commit_and_out
;
3303 if (fstat(fileno(config_file
), &st
) == -1) {
3304 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3308 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3309 ret
= error_errno(_("chmod on %s failed"),
3310 get_lock_file_path(&lock
));
3314 while (fgets(buf
, sizeof(buf
), config_file
)) {
3319 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
3321 if (buf
[i
] == '[') {
3322 /* it's a section */
3327 * When encountering a new section under -c we
3328 * need to flush out any section we're already
3329 * coping and begin anew. There might be
3330 * multiple [branch "$name"] sections.
3332 if (copystr
.len
> 0) {
3333 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3334 ret
= write_error(get_lock_file_path(&lock
));
3337 strbuf_reset(©str
);
3340 offset
= section_name_match(&buf
[i
], old_name
);
3343 if (new_name
== NULL
) {
3347 store
.baselen
= strlen(new_name
);
3349 if (write_section(out_fd
, new_name
, &store
) < 0) {
3350 ret
= write_error(get_lock_file_path(&lock
));
3354 * We wrote out the new section, with
3355 * a newline, now skip the old
3358 output
+= offset
+ i
;
3359 if (strlen(output
) > 0) {
3361 * More content means there's
3362 * a declaration to put on the
3363 * next line; indent with a
3370 copystr
= store_create_section(new_name
, &store
);
3377 length
= strlen(output
);
3379 if (!is_section
&& copystr
.len
> 0) {
3380 strbuf_add(©str
, output
, length
);
3383 if (write_in_full(out_fd
, output
, length
) < 0) {
3384 ret
= write_error(get_lock_file_path(&lock
));
3390 * Copy a trailing section at the end of the config, won't be
3391 * flushed by the usual "flush because we have a new section
3392 * logic in the loop above.
3394 if (copystr
.len
> 0) {
3395 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3396 ret
= write_error(get_lock_file_path(&lock
));
3399 strbuf_reset(©str
);
3402 fclose(config_file
);
3405 if (commit_lock_file(&lock
) < 0)
3406 ret
= error_errno(_("could not write config file %s"),
3410 fclose(config_file
);
3411 rollback_lock_file(&lock
);
3414 config_store_data_clear(&store
);
3418 int git_config_rename_section_in_file(const char *config_filename
,
3419 const char *old_name
, const char *new_name
)
3421 return git_config_copy_or_rename_section_in_file(config_filename
,
3422 old_name
, new_name
, 0);
3425 int git_config_rename_section(const char *old_name
, const char *new_name
)
3427 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
3430 int git_config_copy_section_in_file(const char *config_filename
,
3431 const char *old_name
, const char *new_name
)
3433 return git_config_copy_or_rename_section_in_file(config_filename
,
3434 old_name
, new_name
, 1);
3437 int git_config_copy_section(const char *old_name
, const char *new_name
)
3439 return git_config_copy_section_in_file(NULL
, old_name
, new_name
);
3443 * Call this to report error for your variable that should not
3444 * get a boolean value (i.e. "[my] var" means "true").
3446 #undef config_error_nonbool
3447 int config_error_nonbool(const char *var
)
3449 return error(_("missing value for '%s'"), var
);
3452 int parse_config_key(const char *var
,
3453 const char *section
,
3454 const char **subsection
, size_t *subsection_len
,
3459 /* Does it start with "section." ? */
3460 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
3464 * Find the key; we don't know yet if we have a subsection, but we must
3465 * parse backwards from the end, since the subsection may have dots in
3468 dot
= strrchr(var
, '.');
3471 /* Did we have a subsection at all? */
3475 *subsection_len
= 0;
3481 *subsection
= var
+ 1;
3482 *subsection_len
= dot
- *subsection
;
3488 const char *current_config_origin_type(void)
3491 if (current_config_kvi
)
3492 type
= current_config_kvi
->origin_type
;
3494 type
= cf
->origin_type
;
3496 BUG("current_config_origin_type called outside config callback");
3499 case CONFIG_ORIGIN_BLOB
:
3501 case CONFIG_ORIGIN_FILE
:
3503 case CONFIG_ORIGIN_STDIN
:
3504 return "standard input";
3505 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
3506 return "submodule-blob";
3507 case CONFIG_ORIGIN_CMDLINE
:
3508 return "command line";
3510 BUG("unknown config origin type");
3514 const char *config_scope_name(enum config_scope scope
)
3517 case CONFIG_SCOPE_SYSTEM
:
3519 case CONFIG_SCOPE_GLOBAL
:
3521 case CONFIG_SCOPE_LOCAL
:
3523 case CONFIG_SCOPE_WORKTREE
:
3525 case CONFIG_SCOPE_COMMAND
:
3527 case CONFIG_SCOPE_SUBMODULE
:
3534 const char *current_config_name(void)
3537 if (current_config_kvi
)
3538 name
= current_config_kvi
->filename
;
3542 BUG("current_config_name called outside config callback");
3543 return name
? name
: "";
3546 enum config_scope
current_config_scope(void)
3548 if (current_config_kvi
)
3549 return current_config_kvi
->scope
;
3551 return current_parsing_scope
;
3554 int current_config_line(void)
3556 if (current_config_kvi
)
3557 return current_config_kvi
->linenr
;
3562 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
)
3566 for (i
= 0; i
< nr_mapping
; i
++) {
3567 const char *name
= mapping
[i
];
3569 if (name
&& !strcasecmp(var
, name
))