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_i18n_config(const char *var
, const char *value
)
1549 if (!strcmp(var
, "i18n.commitencoding"))
1550 return git_config_string(&git_commit_encoding
, var
, value
);
1552 if (!strcmp(var
, "i18n.logoutputencoding"))
1553 return git_config_string(&git_log_output_encoding
, var
, value
);
1555 /* Add other config variables here and to Documentation/config.txt. */
1559 static int git_default_branch_config(const char *var
, const char *value
)
1561 if (!strcmp(var
, "branch.autosetupmerge")) {
1562 if (value
&& !strcmp(value
, "always")) {
1563 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1565 } else if (value
&& !strcmp(value
, "inherit")) {
1566 git_branch_track
= BRANCH_TRACK_INHERIT
;
1569 git_branch_track
= git_config_bool(var
, value
);
1572 if (!strcmp(var
, "branch.autosetuprebase")) {
1574 return config_error_nonbool(var
);
1575 else if (!strcmp(value
, "never"))
1576 autorebase
= AUTOREBASE_NEVER
;
1577 else if (!strcmp(value
, "local"))
1578 autorebase
= AUTOREBASE_LOCAL
;
1579 else if (!strcmp(value
, "remote"))
1580 autorebase
= AUTOREBASE_REMOTE
;
1581 else if (!strcmp(value
, "always"))
1582 autorebase
= AUTOREBASE_ALWAYS
;
1584 return error(_("malformed value for %s"), var
);
1588 /* Add other config variables here and to Documentation/config.txt. */
1592 static int git_default_push_config(const char *var
, const char *value
)
1594 if (!strcmp(var
, "push.default")) {
1596 return config_error_nonbool(var
);
1597 else if (!strcmp(value
, "nothing"))
1598 push_default
= PUSH_DEFAULT_NOTHING
;
1599 else if (!strcmp(value
, "matching"))
1600 push_default
= PUSH_DEFAULT_MATCHING
;
1601 else if (!strcmp(value
, "simple"))
1602 push_default
= PUSH_DEFAULT_SIMPLE
;
1603 else if (!strcmp(value
, "upstream"))
1604 push_default
= PUSH_DEFAULT_UPSTREAM
;
1605 else if (!strcmp(value
, "tracking")) /* deprecated */
1606 push_default
= PUSH_DEFAULT_UPSTREAM
;
1607 else if (!strcmp(value
, "current"))
1608 push_default
= PUSH_DEFAULT_CURRENT
;
1610 error(_("malformed value for %s: %s"), var
, value
);
1611 return error(_("must be one of nothing, matching, simple, "
1612 "upstream or current"));
1617 /* Add other config variables here and to Documentation/config.txt. */
1621 static int git_default_mailmap_config(const char *var
, const char *value
)
1623 if (!strcmp(var
, "mailmap.file"))
1624 return git_config_pathname(&git_mailmap_file
, var
, value
);
1625 if (!strcmp(var
, "mailmap.blob"))
1626 return git_config_string(&git_mailmap_blob
, var
, value
);
1628 /* Add other config variables here and to Documentation/config.txt. */
1632 int git_default_config(const char *var
, const char *value
, void *cb
)
1634 if (starts_with(var
, "core."))
1635 return git_default_core_config(var
, value
, cb
);
1637 if (starts_with(var
, "user.") ||
1638 starts_with(var
, "author.") ||
1639 starts_with(var
, "committer."))
1640 return git_ident_config(var
, value
, cb
);
1642 if (starts_with(var
, "i18n."))
1643 return git_default_i18n_config(var
, value
);
1645 if (starts_with(var
, "branch."))
1646 return git_default_branch_config(var
, value
);
1648 if (starts_with(var
, "push."))
1649 return git_default_push_config(var
, value
);
1651 if (starts_with(var
, "mailmap."))
1652 return git_default_mailmap_config(var
, value
);
1654 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1655 return git_default_advice_config(var
, value
);
1657 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1658 pager_use_color
= git_config_bool(var
,value
);
1662 if (!strcmp(var
, "pack.packsizelimit")) {
1663 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1667 if (!strcmp(var
, "pack.compression")) {
1668 int level
= git_config_int(var
, value
);
1670 level
= Z_DEFAULT_COMPRESSION
;
1671 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1672 die(_("bad pack compression level %d"), level
);
1673 pack_compression_level
= level
;
1674 pack_compression_seen
= 1;
1678 /* Add other config variables here and to Documentation/config.txt. */
1683 * All source specific fields in the union, die_on_error, name and the callbacks
1684 * fgetc, ungetc, ftell of top need to be initialized before calling
1687 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
,
1688 const struct config_options
*opts
)
1692 /* push config-file parsing state stack */
1697 strbuf_init(&top
->value
, 1024);
1698 strbuf_init(&top
->var
, 1024);
1701 ret
= git_parse_source(fn
, data
, opts
);
1703 /* pop config-file parsing state stack */
1704 strbuf_release(&top
->value
);
1705 strbuf_release(&top
->var
);
1711 static int do_config_from_file(config_fn_t fn
,
1712 const enum config_origin_type origin_type
,
1713 const char *name
, const char *path
, FILE *f
,
1714 void *data
, const struct config_options
*opts
)
1716 struct config_source top
;
1720 top
.origin_type
= origin_type
;
1723 top
.default_error_action
= CONFIG_ERROR_DIE
;
1724 top
.do_fgetc
= config_file_fgetc
;
1725 top
.do_ungetc
= config_file_ungetc
;
1726 top
.do_ftell
= config_file_ftell
;
1729 ret
= do_config_from(&top
, fn
, data
, opts
);
1734 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1736 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
,
1740 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
1742 const struct config_options
*opts
)
1747 f
= fopen_or_warn(filename
, "r");
1749 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
,
1750 filename
, f
, data
, opts
);
1756 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1758 return git_config_from_file_with_options(fn
, filename
, data
, NULL
);
1761 int git_config_from_mem(config_fn_t fn
,
1762 const enum config_origin_type origin_type
,
1763 const char *name
, const char *buf
, size_t len
,
1764 void *data
, const struct config_options
*opts
)
1766 struct config_source top
;
1768 top
.u
.buf
.buf
= buf
;
1769 top
.u
.buf
.len
= len
;
1771 top
.origin_type
= origin_type
;
1774 top
.default_error_action
= CONFIG_ERROR_ERROR
;
1775 top
.do_fgetc
= config_buf_fgetc
;
1776 top
.do_ungetc
= config_buf_ungetc
;
1777 top
.do_ftell
= config_buf_ftell
;
1779 return do_config_from(&top
, fn
, data
, opts
);
1782 int git_config_from_blob_oid(config_fn_t fn
,
1784 struct repository
*repo
,
1785 const struct object_id
*oid
,
1788 enum object_type type
;
1793 buf
= repo_read_object_file(repo
, oid
, &type
, &size
);
1795 return error(_("unable to load config blob object '%s'"), name
);
1796 if (type
!= OBJ_BLOB
) {
1798 return error(_("reference '%s' does not point to a blob"), name
);
1801 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
1808 static int git_config_from_blob_ref(config_fn_t fn
,
1809 struct repository
*repo
,
1813 struct object_id oid
;
1815 if (repo_get_oid(repo
, name
, &oid
) < 0)
1816 return error(_("unable to resolve config blob '%s'"), name
);
1817 return git_config_from_blob_oid(fn
, name
, repo
, &oid
, data
);
1820 char *git_system_config(void)
1822 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1824 system_config
= system_path(ETC_GITCONFIG
);
1825 normalize_path_copy(system_config
, system_config
);
1826 return system_config
;
1829 void git_global_config(char **user_out
, char **xdg_out
)
1831 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1832 char *xdg_config
= NULL
;
1835 user_config
= interpolate_path("~/.gitconfig", 0);
1836 xdg_config
= xdg_config_home("config");
1839 *user_out
= user_config
;
1840 *xdg_out
= xdg_config
;
1844 * Parse environment variable 'k' as a boolean (in various
1845 * possible spellings); if missing, use the default value 'def'.
1847 int git_env_bool(const char *k
, int def
)
1849 const char *v
= getenv(k
);
1850 return v
? git_config_bool(k
, v
) : def
;
1854 * Parse environment variable 'k' as ulong with possibly a unit
1855 * suffix; if missing, use the default value 'val'.
1857 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1859 const char *v
= getenv(k
);
1860 if (v
&& !git_parse_ulong(v
, &val
))
1861 die(_("failed to parse %s"), k
);
1865 int git_config_system(void)
1867 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1870 static int do_git_config_sequence(const struct config_options
*opts
,
1871 config_fn_t fn
, void *data
)
1874 char *system_config
= git_system_config();
1875 char *xdg_config
= NULL
;
1876 char *user_config
= NULL
;
1878 enum config_scope prev_parsing_scope
= current_parsing_scope
;
1880 if (opts
->commondir
)
1881 repo_config
= mkpathdup("%s/config", opts
->commondir
);
1882 else if (opts
->git_dir
)
1883 BUG("git_dir without commondir");
1887 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1888 if (git_config_system() && system_config
&&
1889 !access_or_die(system_config
, R_OK
,
1890 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
1891 ret
+= git_config_from_file(fn
, system_config
, data
);
1893 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1894 git_global_config(&user_config
, &xdg_config
);
1896 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1897 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1899 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1900 ret
+= git_config_from_file(fn
, user_config
, data
);
1902 current_parsing_scope
= CONFIG_SCOPE_LOCAL
;
1903 if (!opts
->ignore_repo
&& repo_config
&&
1904 !access_or_die(repo_config
, R_OK
, 0))
1905 ret
+= git_config_from_file(fn
, repo_config
, data
);
1907 current_parsing_scope
= CONFIG_SCOPE_WORKTREE
;
1908 if (!opts
->ignore_worktree
&& repository_format_worktree_config
) {
1909 char *path
= git_pathdup("config.worktree");
1910 if (!access_or_die(path
, R_OK
, 0))
1911 ret
+= git_config_from_file(fn
, path
, data
);
1915 current_parsing_scope
= CONFIG_SCOPE_COMMAND
;
1916 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
1917 die(_("unable to parse command-line config"));
1919 current_parsing_scope
= prev_parsing_scope
;
1920 free(system_config
);
1927 int config_with_options(config_fn_t fn
, void *data
,
1928 struct git_config_source
*config_source
,
1929 const struct config_options
*opts
)
1931 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1933 if (opts
->respect_includes
) {
1937 fn
= git_config_include
;
1942 current_parsing_scope
= config_source
->scope
;
1945 * If we have a specific filename, use it. Otherwise, follow the
1946 * regular lookup sequence.
1948 if (config_source
&& config_source
->use_stdin
) {
1949 return git_config_from_stdin(fn
, data
);
1950 } else if (config_source
&& config_source
->file
) {
1951 return git_config_from_file(fn
, config_source
->file
, data
);
1952 } else if (config_source
&& config_source
->blob
) {
1953 struct repository
*repo
= config_source
->repo
?
1954 config_source
->repo
: the_repository
;
1955 return git_config_from_blob_ref(fn
, repo
, config_source
->blob
,
1959 return do_git_config_sequence(opts
, fn
, data
);
1962 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1965 struct string_list
*values
;
1966 struct config_set_element
*entry
;
1967 struct configset_list
*list
= &cs
->list
;
1969 for (i
= 0; i
< list
->nr
; i
++) {
1970 entry
= list
->items
[i
].e
;
1971 value_index
= list
->items
[i
].value_index
;
1972 values
= &entry
->value_list
;
1974 current_config_kvi
= values
->items
[value_index
].util
;
1976 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1977 git_die_config_linenr(entry
->key
,
1978 current_config_kvi
->filename
,
1979 current_config_kvi
->linenr
);
1981 current_config_kvi
= NULL
;
1985 void read_early_config(config_fn_t cb
, void *data
)
1987 struct config_options opts
= {0};
1988 struct strbuf commondir
= STRBUF_INIT
;
1989 struct strbuf gitdir
= STRBUF_INIT
;
1991 opts
.respect_includes
= 1;
1993 if (have_git_dir()) {
1994 opts
.commondir
= get_git_common_dir();
1995 opts
.git_dir
= get_git_dir();
1997 * When setup_git_directory() was not yet asked to discover the
1998 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1999 * is any repository config we should use (but unlike
2000 * setup_git_directory_gently(), no global state is changed, most
2001 * notably, the current working directory is still the same after the
2004 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
2005 opts
.commondir
= commondir
.buf
;
2006 opts
.git_dir
= gitdir
.buf
;
2009 config_with_options(cb
, data
, NULL
, &opts
);
2011 strbuf_release(&commondir
);
2012 strbuf_release(&gitdir
);
2016 * Read config but only enumerate system and global settings.
2017 * Omit any repo-local, worktree-local, or command-line settings.
2019 void read_very_early_config(config_fn_t cb
, void *data
)
2021 struct config_options opts
= { 0 };
2023 opts
.respect_includes
= 1;
2024 opts
.ignore_repo
= 1;
2025 opts
.ignore_worktree
= 1;
2026 opts
.ignore_cmdline
= 1;
2027 opts
.system_gently
= 1;
2029 config_with_options(cb
, data
, NULL
, &opts
);
2032 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
2034 struct config_set_element k
;
2035 struct config_set_element
*found_entry
;
2036 char *normalized_key
;
2038 * `key` may come from the user, so normalize it before using it
2039 * for querying entries from the hashmap.
2041 if (git_config_parse_key(key
, &normalized_key
, NULL
))
2044 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2045 k
.key
= normalized_key
;
2046 found_entry
= hashmap_get_entry(&cs
->config_hash
, &k
, ent
, NULL
);
2047 free(normalized_key
);
2051 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
2053 struct config_set_element
*e
;
2054 struct string_list_item
*si
;
2055 struct configset_list_item
*l_item
;
2056 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2058 e
= configset_find_element(cs
, key
);
2060 * Since the keys are being fed by git_config*() callback mechanism, they
2061 * are already normalized. So simply add them without any further munging.
2064 e
= xmalloc(sizeof(*e
));
2065 hashmap_entry_init(&e
->ent
, strhash(key
));
2066 e
->key
= xstrdup(key
);
2067 string_list_init_dup(&e
->value_list
);
2068 hashmap_add(&cs
->config_hash
, &e
->ent
);
2070 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2072 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
2073 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
2075 l_item
->value_index
= e
->value_list
.nr
- 1;
2078 BUG("configset_add_value has no source");
2080 kv_info
->filename
= strintern(cf
->name
);
2081 kv_info
->linenr
= cf
->linenr
;
2082 kv_info
->origin_type
= cf
->origin_type
;
2084 /* for values read from `git_config_from_parameters()` */
2085 kv_info
->filename
= NULL
;
2086 kv_info
->linenr
= -1;
2087 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
2089 kv_info
->scope
= current_parsing_scope
;
2095 static int config_set_element_cmp(const void *unused_cmp_data
,
2096 const struct hashmap_entry
*eptr
,
2097 const struct hashmap_entry
*entry_or_key
,
2098 const void *unused_keydata
)
2100 const struct config_set_element
*e1
, *e2
;
2102 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2103 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2105 return strcmp(e1
->key
, e2
->key
);
2108 void git_configset_init(struct config_set
*cs
)
2110 hashmap_init(&cs
->config_hash
, config_set_element_cmp
, NULL
, 0);
2111 cs
->hash_initialized
= 1;
2114 cs
->list
.items
= NULL
;
2117 void git_configset_clear(struct config_set
*cs
)
2119 struct config_set_element
*entry
;
2120 struct hashmap_iter iter
;
2121 if (!cs
->hash_initialized
)
2124 hashmap_for_each_entry(&cs
->config_hash
, &iter
, entry
,
2125 ent
/* member name */) {
2127 string_list_clear(&entry
->value_list
, 1);
2129 hashmap_clear_and_free(&cs
->config_hash
, struct config_set_element
, ent
);
2130 cs
->hash_initialized
= 0;
2131 free(cs
->list
.items
);
2134 cs
->list
.items
= NULL
;
2137 static int config_set_callback(const char *key
, const char *value
, void *cb
)
2139 struct config_set
*cs
= cb
;
2140 configset_add_value(cs
, key
, value
);
2144 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
2146 return git_config_from_file(config_set_callback
, filename
, cs
);
2149 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
2151 const struct string_list
*values
= NULL
;
2153 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2154 * queried key in the files of the configset, the value returned will be the last
2155 * value in the value list for that key.
2157 values
= git_configset_get_value_multi(cs
, key
);
2161 assert(values
->nr
> 0);
2162 *value
= values
->items
[values
->nr
- 1].string
;
2166 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
2168 struct config_set_element
*e
= configset_find_element(cs
, key
);
2169 return e
? &e
->value_list
: NULL
;
2172 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
2175 if (!git_configset_get_value(cs
, key
, &value
))
2176 return git_config_string((const char **)dest
, key
, value
);
2181 int git_configset_get_string_tmp(struct config_set
*cs
, const char *key
,
2185 if (!git_configset_get_value(cs
, key
, &value
)) {
2187 return config_error_nonbool(key
);
2195 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
2198 if (!git_configset_get_value(cs
, key
, &value
)) {
2199 *dest
= git_config_int(key
, value
);
2205 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
2208 if (!git_configset_get_value(cs
, key
, &value
)) {
2209 *dest
= git_config_ulong(key
, value
);
2215 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
2218 if (!git_configset_get_value(cs
, key
, &value
)) {
2219 *dest
= git_config_bool(key
, value
);
2225 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
2226 int *is_bool
, int *dest
)
2229 if (!git_configset_get_value(cs
, key
, &value
)) {
2230 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
2236 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
2239 if (!git_configset_get_value(cs
, key
, &value
)) {
2240 *dest
= git_parse_maybe_bool(value
);
2248 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
2251 if (!git_configset_get_value(cs
, key
, &value
))
2252 return git_config_pathname(dest
, key
, value
);
2257 /* Functions use to read configuration from a repository */
2258 static void repo_read_config(struct repository
*repo
)
2260 struct config_options opts
= { 0 };
2262 opts
.respect_includes
= 1;
2263 opts
.commondir
= repo
->commondir
;
2264 opts
.git_dir
= repo
->gitdir
;
2267 CALLOC_ARRAY(repo
->config
, 1);
2269 git_configset_clear(repo
->config
);
2271 git_configset_init(repo
->config
);
2273 if (config_with_options(config_set_callback
, repo
->config
, NULL
, &opts
) < 0)
2275 * config_with_options() normally returns only
2276 * zero, as most errors are fatal, and
2277 * non-fatal potential errors are guarded by "if"
2278 * statements that are entered only when no error is
2281 * If we ever encounter a non-fatal error, it means
2282 * something went really wrong and we should stop
2285 die(_("unknown error occurred while reading the configuration files"));
2288 static void git_config_check_init(struct repository
*repo
)
2290 if (repo
->config
&& repo
->config
->hash_initialized
)
2292 repo_read_config(repo
);
2295 static void repo_config_clear(struct repository
*repo
)
2297 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2299 git_configset_clear(repo
->config
);
2302 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2304 git_config_check_init(repo
);
2305 configset_iter(repo
->config
, fn
, data
);
2308 int repo_config_get_value(struct repository
*repo
,
2309 const char *key
, const char **value
)
2311 git_config_check_init(repo
);
2312 return git_configset_get_value(repo
->config
, key
, value
);
2315 const struct string_list
*repo_config_get_value_multi(struct repository
*repo
,
2318 git_config_check_init(repo
);
2319 return git_configset_get_value_multi(repo
->config
, key
);
2322 int repo_config_get_string(struct repository
*repo
,
2323 const char *key
, char **dest
)
2326 git_config_check_init(repo
);
2327 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2329 git_die_config(key
, NULL
);
2333 int repo_config_get_string_tmp(struct repository
*repo
,
2334 const char *key
, const char **dest
)
2337 git_config_check_init(repo
);
2338 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2340 git_die_config(key
, NULL
);
2344 int repo_config_get_int(struct repository
*repo
,
2345 const char *key
, int *dest
)
2347 git_config_check_init(repo
);
2348 return git_configset_get_int(repo
->config
, key
, dest
);
2351 int repo_config_get_ulong(struct repository
*repo
,
2352 const char *key
, unsigned long *dest
)
2354 git_config_check_init(repo
);
2355 return git_configset_get_ulong(repo
->config
, key
, dest
);
2358 int repo_config_get_bool(struct repository
*repo
,
2359 const char *key
, int *dest
)
2361 git_config_check_init(repo
);
2362 return git_configset_get_bool(repo
->config
, key
, dest
);
2365 int repo_config_get_bool_or_int(struct repository
*repo
,
2366 const char *key
, int *is_bool
, int *dest
)
2368 git_config_check_init(repo
);
2369 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2372 int repo_config_get_maybe_bool(struct repository
*repo
,
2373 const char *key
, int *dest
)
2375 git_config_check_init(repo
);
2376 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2379 int repo_config_get_pathname(struct repository
*repo
,
2380 const char *key
, const char **dest
)
2383 git_config_check_init(repo
);
2384 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2386 git_die_config(key
, NULL
);
2390 /* Functions used historically to read configuration from 'the_repository' */
2391 void git_config(config_fn_t fn
, void *data
)
2393 repo_config(the_repository
, fn
, data
);
2396 void git_config_clear(void)
2398 repo_config_clear(the_repository
);
2401 int git_config_get_value(const char *key
, const char **value
)
2403 return repo_config_get_value(the_repository
, key
, value
);
2406 const struct string_list
*git_config_get_value_multi(const char *key
)
2408 return repo_config_get_value_multi(the_repository
, key
);
2411 int git_config_get_string(const char *key
, char **dest
)
2413 return repo_config_get_string(the_repository
, key
, dest
);
2416 int git_config_get_string_tmp(const char *key
, const char **dest
)
2418 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2421 int git_config_get_int(const char *key
, int *dest
)
2423 return repo_config_get_int(the_repository
, key
, dest
);
2426 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2428 return repo_config_get_ulong(the_repository
, key
, dest
);
2431 int git_config_get_bool(const char *key
, int *dest
)
2433 return repo_config_get_bool(the_repository
, key
, dest
);
2436 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2438 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2441 int git_config_get_maybe_bool(const char *key
, int *dest
)
2443 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2446 int git_config_get_pathname(const char *key
, const char **dest
)
2448 return repo_config_get_pathname(the_repository
, key
, dest
);
2451 int git_config_get_expiry(const char *key
, const char **output
)
2453 int ret
= git_config_get_string(key
, (char **)output
);
2456 if (strcmp(*output
, "now")) {
2457 timestamp_t now
= approxidate("now");
2458 if (approxidate(*output
) >= now
)
2459 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2464 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2466 const char *expiry_string
;
2470 if (git_config_get_string_tmp(key
, &expiry_string
))
2471 return 1; /* no such thing */
2473 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2474 const int scale
= 86400;
2475 *expiry
= now
- days
* scale
;
2479 if (!parse_expiry_date(expiry_string
, &when
)) {
2483 return -1; /* thing exists but cannot be parsed */
2486 int git_config_get_split_index(void)
2490 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2493 return -1; /* default value */
2496 int git_config_get_max_percent_split_change(void)
2500 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2501 if (0 <= val
&& val
<= 100)
2504 return error(_("splitIndex.maxPercentChange value '%d' "
2505 "should be between 0 and 100"), val
);
2508 return -1; /* default value */
2511 int git_config_get_fsmonitor(void)
2513 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor
))
2514 core_fsmonitor
= getenv("GIT_TEST_FSMONITOR");
2516 if (core_fsmonitor
&& !*core_fsmonitor
)
2517 core_fsmonitor
= NULL
;
2525 int git_config_get_index_threads(int *dest
)
2529 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2535 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2537 *dest
= val
? 0 : 1;
2547 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2550 die(_("unable to parse '%s' from command-line config"), key
);
2552 die(_("bad config variable '%s' in file '%s' at line %d"),
2553 key
, filename
, linenr
);
2556 NORETURN
__attribute__((format(printf
, 2, 3)))
2557 void git_die_config(const char *key
, const char *err
, ...)
2559 const struct string_list
*values
;
2560 struct key_value_info
*kv_info
;
2561 report_fn error_fn
= get_error_routine();
2565 va_start(params
, err
);
2566 error_fn(err
, params
);
2569 values
= git_config_get_value_multi(key
);
2570 kv_info
= values
->items
[values
->nr
- 1].util
;
2571 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
2575 * Find all the stuff for git_config_set() below.
2578 struct config_store_data
{
2582 const char *fixed_value
;
2583 regex_t
*value_pattern
;
2587 enum config_event_t type
;
2588 int is_keys_section
;
2590 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
2591 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
2594 static void config_store_data_clear(struct config_store_data
*store
)
2597 if (store
->value_pattern
!= NULL
&&
2598 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
2599 regfree(store
->value_pattern
);
2600 free(store
->value_pattern
);
2602 free(store
->parsed
);
2604 memset(store
, 0, sizeof(*store
));
2607 static int matches(const char *key
, const char *value
,
2608 const struct config_store_data
*store
)
2610 if (strcmp(key
, store
->key
))
2611 return 0; /* not ours */
2612 if (store
->fixed_value
)
2613 return !strcmp(store
->fixed_value
, value
);
2614 if (!store
->value_pattern
)
2615 return 1; /* always matches */
2616 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
2617 return 0; /* never matches */
2619 return store
->do_not_match
^
2620 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
2623 static int store_aux_event(enum config_event_t type
,
2624 size_t begin
, size_t end
, void *data
)
2626 struct config_store_data
*store
= data
;
2628 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
2629 store
->parsed
[store
->parsed_nr
].begin
= begin
;
2630 store
->parsed
[store
->parsed_nr
].end
= end
;
2631 store
->parsed
[store
->parsed_nr
].type
= type
;
2633 if (type
== CONFIG_EVENT_SECTION
) {
2634 int (*cmpfn
)(const char *, const char *, size_t);
2636 if (cf
->var
.len
< 2 || cf
->var
.buf
[cf
->var
.len
- 1] != '.')
2637 return error(_("invalid section name '%s'"), cf
->var
.buf
);
2639 if (cf
->subsection_case_sensitive
)
2640 cmpfn
= strncasecmp
;
2644 /* Is this the section we were looking for? */
2645 store
->is_keys_section
=
2646 store
->parsed
[store
->parsed_nr
].is_keys_section
=
2647 cf
->var
.len
- 1 == store
->baselen
&&
2648 !cmpfn(cf
->var
.buf
, store
->key
, store
->baselen
);
2649 if (store
->is_keys_section
) {
2650 store
->section_seen
= 1;
2651 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2653 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2662 static int store_aux(const char *key
, const char *value
, void *cb
)
2664 struct config_store_data
*store
= cb
;
2666 if (store
->key_seen
) {
2667 if (matches(key
, value
, store
)) {
2668 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
2669 warning(_("%s has multiple values"), key
);
2672 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2675 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2678 } else if (store
->is_keys_section
) {
2680 * Do not increment matches yet: this may not be a match, but we
2681 * are in the desired section.
2683 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
2684 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2685 store
->section_seen
= 1;
2687 if (matches(key
, value
, store
)) {
2689 store
->key_seen
= 1;
2696 static int write_error(const char *filename
)
2698 error(_("failed to write new configuration file %s"), filename
);
2700 /* Same error code as "failed to rename". */
2704 static struct strbuf
store_create_section(const char *key
,
2705 const struct config_store_data
*store
)
2709 struct strbuf sb
= STRBUF_INIT
;
2711 dot
= memchr(key
, '.', store
->baselen
);
2713 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
2714 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
2715 if (key
[i
] == '"' || key
[i
] == '\\')
2716 strbuf_addch(&sb
, '\\');
2717 strbuf_addch(&sb
, key
[i
]);
2719 strbuf_addstr(&sb
, "\"]\n");
2721 strbuf_addch(&sb
, '[');
2722 strbuf_add(&sb
, key
, store
->baselen
);
2723 strbuf_addstr(&sb
, "]\n");
2729 static ssize_t
write_section(int fd
, const char *key
,
2730 const struct config_store_data
*store
)
2732 struct strbuf sb
= store_create_section(key
, store
);
2735 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2736 strbuf_release(&sb
);
2741 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
2742 const struct config_store_data
*store
)
2746 const char *quote
= "";
2747 struct strbuf sb
= STRBUF_INIT
;
2750 * Check to see if the value needs to be surrounded with a dq pair.
2751 * Note that problematic characters are always backslash-quoted; this
2752 * check is about not losing leading or trailing SP and strings that
2753 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2754 * configuration parser.
2756 if (value
[0] == ' ')
2758 for (i
= 0; value
[i
]; i
++)
2759 if (value
[i
] == ';' || value
[i
] == '#')
2761 if (i
&& value
[i
- 1] == ' ')
2764 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
2766 for (i
= 0; value
[i
]; i
++)
2769 strbuf_addstr(&sb
, "\\n");
2772 strbuf_addstr(&sb
, "\\t");
2776 strbuf_addch(&sb
, '\\');
2779 strbuf_addch(&sb
, value
[i
]);
2782 strbuf_addf(&sb
, "%s\n", quote
);
2784 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2785 strbuf_release(&sb
);
2791 * If we are about to unset the last key(s) in a section, and if there are
2792 * no comments surrounding (or included in) the section, we will want to
2793 * extend begin/end to remove the entire section.
2795 * Note: the parameter `seen_ptr` points to the index into the store.seen
2796 * array. * This index may be incremented if a section has more than one
2797 * entry (which all are to be removed).
2799 static void maybe_remove_section(struct config_store_data
*store
,
2800 size_t *begin_offset
, size_t *end_offset
,
2804 int i
, seen
, section_seen
= 0;
2807 * First, ensure that this is the first key, and that there are no
2808 * comments before the entry nor before the section header.
2811 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
2812 enum config_event_t type
= store
->parsed
[i
- 1].type
;
2814 if (type
== CONFIG_EVENT_COMMENT
)
2815 /* There is a comment before this entry or section */
2817 if (type
== CONFIG_EVENT_ENTRY
) {
2819 /* This is not the section's first entry. */
2821 /* We encountered no comment before the section. */
2824 if (type
== CONFIG_EVENT_SECTION
) {
2825 if (!store
->parsed
[i
- 1].is_keys_section
)
2830 begin
= store
->parsed
[i
].begin
;
2833 * Next, make sure that we are removing the last key(s) in the section,
2834 * and that there are no comments that are possibly about the current
2837 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
2838 enum config_event_t type
= store
->parsed
[i
].type
;
2840 if (type
== CONFIG_EVENT_COMMENT
)
2842 if (type
== CONFIG_EVENT_SECTION
) {
2843 if (store
->parsed
[i
].is_keys_section
)
2847 if (type
== CONFIG_EVENT_ENTRY
) {
2848 if (++seen
< store
->seen_nr
&&
2849 i
== store
->seen
[seen
])
2850 /* We want to remove this entry, too */
2852 /* There is another entry in this section. */
2858 * We are really removing the last entry/entries from this section, and
2859 * there are no enclosed or surrounding comments. Remove the entire,
2860 * now-empty section.
2863 *begin_offset
= begin
;
2864 if (i
< store
->parsed_nr
)
2865 *end_offset
= store
->parsed
[i
].begin
;
2867 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
2870 int git_config_set_in_file_gently(const char *config_filename
,
2871 const char *key
, const char *value
)
2873 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
2876 void git_config_set_in_file(const char *config_filename
,
2877 const char *key
, const char *value
)
2879 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
2882 int git_config_set_gently(const char *key
, const char *value
)
2884 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
2887 void git_config_set(const char *key
, const char *value
)
2889 git_config_set_multivar(key
, value
, NULL
, 0);
2891 trace2_cmd_set_config(key
, value
);
2895 * If value==NULL, unset in (remove from) config,
2896 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2897 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2898 * (only add a new one)
2899 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2900 * key/values are removed before a single new pair is written. If the
2901 * flag is not present, then replace only the first match.
2903 * Returns 0 on success.
2905 * This function does this:
2907 * - it locks the config file by creating ".git/config.lock"
2909 * - it then parses the config using store_aux() as validator to find
2910 * the position on the key/value pair to replace. If it is to be unset,
2911 * it must be found exactly once.
2913 * - the config file is mmap()ed and the part before the match (if any) is
2914 * written to the lock file, then the changed part and the rest.
2916 * - the config file is removed and the lock file rename()d to it.
2919 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2920 const char *key
, const char *value
,
2921 const char *value_pattern
,
2924 int fd
= -1, in_fd
= -1;
2926 struct lock_file lock
= LOCK_INIT
;
2927 char *filename_buf
= NULL
;
2928 char *contents
= NULL
;
2930 struct config_store_data store
;
2932 memset(&store
, 0, sizeof(store
));
2934 /* parse-key returns negative; flip the sign to feed exit(3) */
2935 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2939 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
2941 if (!config_filename
)
2942 config_filename
= filename_buf
= git_pathdup("config");
2945 * The lock serves a purpose in addition to locking: the new
2946 * contents of .git/config will be written into it.
2948 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
2950 error_errno(_("could not lock config file %s"), config_filename
);
2951 ret
= CONFIG_NO_LOCK
;
2956 * If .git/config does not exist yet, write a minimal version.
2958 in_fd
= open(config_filename
, O_RDONLY
);
2960 if ( ENOENT
!= errno
) {
2961 error_errno(_("opening %s"), config_filename
);
2962 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2965 /* if nothing to unset, error out */
2966 if (value
== NULL
) {
2967 ret
= CONFIG_NOTHING_SET
;
2972 store
.key
= xstrdup(key
);
2973 if (write_section(fd
, key
, &store
) < 0 ||
2974 write_pair(fd
, key
, value
, &store
) < 0)
2978 size_t copy_begin
, copy_end
;
2979 int i
, new_line
= 0;
2980 struct config_options opts
;
2982 if (value_pattern
== NULL
)
2983 store
.value_pattern
= NULL
;
2984 else if (value_pattern
== CONFIG_REGEX_NONE
)
2985 store
.value_pattern
= CONFIG_REGEX_NONE
;
2986 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
2987 store
.fixed_value
= value_pattern
;
2989 if (value_pattern
[0] == '!') {
2990 store
.do_not_match
= 1;
2993 store
.do_not_match
= 0;
2995 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
2996 if (regcomp(store
.value_pattern
, value_pattern
,
2998 error(_("invalid pattern: %s"), value_pattern
);
2999 FREE_AND_NULL(store
.value_pattern
);
3000 ret
= CONFIG_INVALID_PATTERN
;
3005 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
3006 store
.parsed
[0].end
= 0;
3008 memset(&opts
, 0, sizeof(opts
));
3009 opts
.event_fn
= store_aux_event
;
3010 opts
.event_fn_data
= &store
;
3013 * After this, store.parsed will contain offsets of all the
3014 * parsed elements, and store.seen will contain a list of
3015 * matches, as indices into store.parsed.
3017 * As a side effect, we make sure to transform only a valid
3018 * existing config file.
3020 if (git_config_from_file_with_options(store_aux
,
3023 error(_("invalid config file %s"), config_filename
);
3024 ret
= CONFIG_INVALID_FILE
;
3028 /* if nothing to unset, or too many matches, error out */
3029 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3030 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3031 ret
= CONFIG_NOTHING_SET
;
3035 if (fstat(in_fd
, &st
) == -1) {
3036 error_errno(_("fstat on %s failed"), config_filename
);
3037 ret
= CONFIG_INVALID_FILE
;
3041 contents_sz
= xsize_t(st
.st_size
);
3042 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3043 MAP_PRIVATE
, in_fd
, 0);
3044 if (contents
== MAP_FAILED
) {
3045 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3047 error_errno(_("unable to mmap '%s'%s"),
3048 config_filename
, mmap_os_err());
3049 ret
= CONFIG_INVALID_FILE
;
3056 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3057 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3058 ret
= CONFIG_NO_WRITE
;
3062 if (store
.seen_nr
== 0) {
3063 if (!store
.seen_alloc
) {
3064 /* Did not see key nor section */
3065 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3066 store
.seen
[0] = store
.parsed_nr
3067 - !!store
.parsed_nr
;
3072 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3074 int j
= store
.seen
[i
];
3077 if (!store
.key_seen
) {
3078 copy_end
= store
.parsed
[j
].end
;
3079 /* include '\n' when copying section header */
3080 if (copy_end
> 0 && copy_end
< contents_sz
&&
3081 contents
[copy_end
- 1] != '\n' &&
3082 contents
[copy_end
] == '\n')
3084 replace_end
= copy_end
;
3086 replace_end
= store
.parsed
[j
].end
;
3087 copy_end
= store
.parsed
[j
].begin
;
3089 maybe_remove_section(&store
,
3093 * Swallow preceding white-space on the same
3096 while (copy_end
> 0 ) {
3097 char c
= contents
[copy_end
- 1];
3099 if (isspace(c
) && c
!= '\n')
3106 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3109 /* write the first part of the config */
3110 if (copy_end
> copy_begin
) {
3111 if (write_in_full(fd
, contents
+ copy_begin
,
3112 copy_end
- copy_begin
) < 0)
3115 write_str_in_full(fd
, "\n") < 0)
3118 copy_begin
= replace_end
;
3121 /* write the pair (value == NULL means unset) */
3122 if (value
!= NULL
) {
3123 if (!store
.section_seen
) {
3124 if (write_section(fd
, key
, &store
) < 0)
3127 if (write_pair(fd
, key
, value
, &store
) < 0)
3131 /* write the rest of the config */
3132 if (copy_begin
< contents_sz
)
3133 if (write_in_full(fd
, contents
+ copy_begin
,
3134 contents_sz
- copy_begin
) < 0)
3137 munmap(contents
, contents_sz
);
3141 if (commit_lock_file(&lock
) < 0) {
3142 error_errno(_("could not write config file %s"), config_filename
);
3143 ret
= CONFIG_NO_WRITE
;
3149 /* Invalidate the config cache */
3153 rollback_lock_file(&lock
);
3156 munmap(contents
, contents_sz
);
3159 config_store_data_clear(&store
);
3163 ret
= write_error(get_lock_file_path(&lock
));
3168 void git_config_set_multivar_in_file(const char *config_filename
,
3169 const char *key
, const char *value
,
3170 const char *value_pattern
, unsigned flags
)
3172 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3173 value_pattern
, flags
))
3176 die(_("could not set '%s' to '%s'"), key
, value
);
3178 die(_("could not unset '%s'"), key
);
3181 int git_config_set_multivar_gently(const char *key
, const char *value
,
3182 const char *value_pattern
, unsigned flags
)
3184 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_pattern
,
3188 void git_config_set_multivar(const char *key
, const char *value
,
3189 const char *value_pattern
, unsigned flags
)
3191 git_config_set_multivar_in_file(NULL
, key
, value
, value_pattern
,
3195 static size_t section_name_match (const char *buf
, const char *name
)
3197 size_t i
= 0, j
= 0;
3201 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3202 if (!dot
&& isspace(buf
[i
])) {
3204 if (name
[j
++] != '.')
3206 for (i
++; isspace(buf
[i
]); i
++)
3212 if (buf
[i
] == '\\' && dot
)
3214 else if (buf
[i
] == '"' && dot
) {
3215 for (i
++; isspace(buf
[i
]); i
++)
3219 if (buf
[i
] != name
[j
++])
3222 if (buf
[i
] == ']' && name
[j
] == 0) {
3224 * We match, now just find the right length offset by
3225 * gobbling up any whitespace after it, as well
3228 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3235 static int section_name_is_ok(const char *name
)
3237 /* Empty section names are bogus. */
3242 * Before a dot, we must be alphanumeric or dash. After the first dot,
3243 * anything goes, so we can stop checking.
3245 for (; *name
&& *name
!= '.'; name
++)
3246 if (*name
!= '-' && !isalnum(*name
))
3251 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3253 /* if new_name == NULL, the section is removed instead */
3254 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3255 const char *old_name
,
3256 const char *new_name
, int copy
)
3258 int ret
= 0, remove
= 0;
3259 char *filename_buf
= NULL
;
3260 struct lock_file lock
= LOCK_INIT
;
3262 struct strbuf buf
= STRBUF_INIT
;
3263 FILE *config_file
= NULL
;
3265 struct strbuf copystr
= STRBUF_INIT
;
3266 struct config_store_data store
;
3267 uint32_t line_nr
= 0;
3269 memset(&store
, 0, sizeof(store
));
3271 if (new_name
&& !section_name_is_ok(new_name
)) {
3272 ret
= error(_("invalid section name: %s"), new_name
);
3273 goto out_no_rollback
;
3276 if (!config_filename
)
3277 config_filename
= filename_buf
= git_pathdup("config");
3279 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3281 ret
= error(_("could not lock config file %s"), config_filename
);
3285 if (!(config_file
= fopen(config_filename
, "rb"))) {
3286 ret
= warn_on_fopen_errors(config_filename
);
3289 /* no config file means nothing to rename, no error */
3290 goto commit_and_out
;
3293 if (fstat(fileno(config_file
), &st
) == -1) {
3294 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3298 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3299 ret
= error_errno(_("chmod on %s failed"),
3300 get_lock_file_path(&lock
));
3304 while (!strbuf_getwholeline(&buf
, config_file
, '\n')) {
3307 char *output
= buf
.buf
;
3311 if (buf
.len
>= GIT_CONFIG_MAX_LINE_LEN
) {
3312 ret
= error(_("refusing to work with overly long line "
3313 "in '%s' on line %"PRIuMAX
),
3314 config_filename
, (uintmax_t)line_nr
);
3318 for (i
= 0; buf
.buf
[i
] && isspace(buf
.buf
[i
]); i
++)
3320 if (buf
.buf
[i
] == '[') {
3321 /* it's a section */
3326 * When encountering a new section under -c we
3327 * need to flush out any section we're already
3328 * coping and begin anew. There might be
3329 * multiple [branch "$name"] sections.
3331 if (copystr
.len
> 0) {
3332 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3333 ret
= write_error(get_lock_file_path(&lock
));
3336 strbuf_reset(©str
);
3339 offset
= section_name_match(&buf
.buf
[i
], old_name
);
3342 if (new_name
== NULL
) {
3346 store
.baselen
= strlen(new_name
);
3348 if (write_section(out_fd
, new_name
, &store
) < 0) {
3349 ret
= write_error(get_lock_file_path(&lock
));
3353 * We wrote out the new section, with
3354 * a newline, now skip the old
3357 output
+= offset
+ i
;
3358 if (strlen(output
) > 0) {
3360 * More content means there's
3361 * a declaration to put on the
3362 * next line; indent with a
3369 copystr
= store_create_section(new_name
, &store
);
3376 length
= strlen(output
);
3378 if (!is_section
&& copystr
.len
> 0) {
3379 strbuf_add(©str
, output
, length
);
3382 if (write_in_full(out_fd
, output
, length
) < 0) {
3383 ret
= write_error(get_lock_file_path(&lock
));
3389 * Copy a trailing section at the end of the config, won't be
3390 * flushed by the usual "flush because we have a new section
3391 * logic in the loop above.
3393 if (copystr
.len
> 0) {
3394 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3395 ret
= write_error(get_lock_file_path(&lock
));
3398 strbuf_reset(©str
);
3401 fclose(config_file
);
3404 if (commit_lock_file(&lock
) < 0)
3405 ret
= error_errno(_("could not write config file %s"),
3409 fclose(config_file
);
3410 rollback_lock_file(&lock
);
3413 config_store_data_clear(&store
);
3414 strbuf_release(&buf
);
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
))