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 return error(_("relative config includes must come from files"));
154 slash
= find_last_dir_sep(cf
->path
);
156 strbuf_add(&buf
, cf
->path
, slash
- cf
->path
+ 1);
157 strbuf_addstr(&buf
, path
);
161 if (!access_or_die(path
, R_OK
, 0)) {
162 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
163 die(_(include_depth_advice
), MAX_INCLUDE_DEPTH
, path
,
165 cf
->name
? cf
->name
:
167 ret
= git_config_from_file(git_config_include
, path
, inc
);
170 strbuf_release(&buf
);
175 static void add_trailing_starstar_for_dir(struct strbuf
*pat
)
177 if (pat
->len
&& is_dir_sep(pat
->buf
[pat
->len
- 1]))
178 strbuf_addstr(pat
, "**");
181 static int prepare_include_condition_pattern(struct strbuf
*pat
)
183 struct strbuf path
= STRBUF_INIT
;
187 expanded
= interpolate_path(pat
->buf
, 1);
190 strbuf_addstr(pat
, expanded
);
194 if (pat
->buf
[0] == '.' && is_dir_sep(pat
->buf
[1])) {
197 if (!cf
|| !cf
->path
)
198 return error(_("relative config include "
199 "conditionals must come from files"));
201 strbuf_realpath(&path
, cf
->path
, 1);
202 slash
= find_last_dir_sep(path
.buf
);
204 BUG("how is this possible?");
205 strbuf_splice(pat
, 0, 1, path
.buf
, slash
- path
.buf
);
206 prefix
= slash
- path
.buf
+ 1 /* slash */;
207 } else if (!is_absolute_path(pat
->buf
))
208 strbuf_insertstr(pat
, 0, "**/");
210 add_trailing_starstar_for_dir(pat
);
212 strbuf_release(&path
);
216 static int include_by_gitdir(const struct config_options
*opts
,
217 const char *cond
, size_t cond_len
, int icase
)
219 struct strbuf text
= STRBUF_INIT
;
220 struct strbuf pattern
= STRBUF_INIT
;
223 int already_tried_absolute
= 0;
226 git_dir
= opts
->git_dir
;
230 strbuf_realpath(&text
, git_dir
, 1);
231 strbuf_add(&pattern
, cond
, cond_len
);
232 prefix
= prepare_include_condition_pattern(&pattern
);
240 * perform literal matching on the prefix part so that
241 * any wildcard character in it can't create side effects.
243 if (text
.len
< prefix
)
245 if (!icase
&& strncmp(pattern
.buf
, text
.buf
, prefix
))
247 if (icase
&& strncasecmp(pattern
.buf
, text
.buf
, prefix
))
251 ret
= !wildmatch(pattern
.buf
+ prefix
, text
.buf
+ prefix
,
252 WM_PATHNAME
| (icase
? WM_CASEFOLD
: 0));
254 if (!ret
&& !already_tried_absolute
) {
256 * We've tried e.g. matching gitdir:~/work, but if
257 * ~/work is a symlink to /mnt/storage/work
258 * strbuf_realpath() will expand it, so the rule won't
259 * match. Let's match against a
260 * strbuf_add_absolute_path() version of the path,
261 * which'll do the right thing
264 strbuf_add_absolute_path(&text
, git_dir
);
265 already_tried_absolute
= 1;
269 strbuf_release(&pattern
);
270 strbuf_release(&text
);
274 static int include_by_branch(const char *cond
, size_t cond_len
)
278 struct strbuf pattern
= STRBUF_INIT
;
279 const char *refname
= !the_repository
->gitdir
?
280 NULL
: resolve_ref_unsafe("HEAD", 0, NULL
, &flags
);
281 const char *shortname
;
283 if (!refname
|| !(flags
& REF_ISSYMREF
) ||
284 !skip_prefix(refname
, "refs/heads/", &shortname
))
287 strbuf_add(&pattern
, cond
, cond_len
);
288 add_trailing_starstar_for_dir(&pattern
);
289 ret
= !wildmatch(pattern
.buf
, shortname
, WM_PATHNAME
);
290 strbuf_release(&pattern
);
294 static int include_condition_is_true(const struct config_options
*opts
,
295 const char *cond
, size_t cond_len
)
298 if (skip_prefix_mem(cond
, cond_len
, "gitdir:", &cond
, &cond_len
))
299 return include_by_gitdir(opts
, cond
, cond_len
, 0);
300 else if (skip_prefix_mem(cond
, cond_len
, "gitdir/i:", &cond
, &cond_len
))
301 return include_by_gitdir(opts
, cond
, cond_len
, 1);
302 else if (skip_prefix_mem(cond
, cond_len
, "onbranch:", &cond
, &cond_len
))
303 return include_by_branch(cond
, cond_len
);
305 /* unknown conditionals are always false */
309 int git_config_include(const char *var
, const char *value
, void *data
)
311 struct config_include_data
*inc
= data
;
312 const char *cond
, *key
;
317 * Pass along all values, including "include" directives; this makes it
318 * possible to query information on the includes themselves.
320 ret
= inc
->fn(var
, value
, inc
->data
);
324 if (!strcmp(var
, "include.path"))
325 ret
= handle_path_include(value
, inc
);
327 if (!parse_config_key(var
, "includeif", &cond
, &cond_len
, &key
) &&
328 (cond
&& include_condition_is_true(inc
->opts
, cond
, cond_len
)) &&
329 !strcmp(key
, "path"))
330 ret
= handle_path_include(value
, inc
);
335 static void git_config_push_split_parameter(const char *key
, const char *value
)
337 struct strbuf env
= STRBUF_INIT
;
338 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
340 strbuf_addstr(&env
, old
);
341 strbuf_addch(&env
, ' ');
343 sq_quote_buf(&env
, key
);
344 strbuf_addch(&env
, '=');
346 sq_quote_buf(&env
, value
);
347 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
348 strbuf_release(&env
);
351 void git_config_push_parameter(const char *text
)
358 * section.subsection=with=equals.key=value
360 * we cannot tell if it means:
362 * [section "subsection=with=equals"]
368 * subsection = with=equals.key=value
370 * We parse left-to-right for the first "=", meaning we'll prefer to
371 * keep the value intact over the subsection. This is historical, but
372 * also sensible since values are more likely to contain odd or
373 * untrusted input than a section name.
375 * A missing equals is explicitly allowed (as a bool-only entry).
377 value
= strchr(text
, '=');
379 char *key
= xmemdupz(text
, value
- text
);
380 git_config_push_split_parameter(key
, value
+ 1);
383 git_config_push_split_parameter(text
, NULL
);
387 void git_config_push_env(const char *spec
)
390 const char *env_name
;
391 const char *env_value
;
393 env_name
= strrchr(spec
, '=');
395 die(_("invalid config format: %s"), spec
);
396 key
= xmemdupz(spec
, env_name
- spec
);
399 die(_("missing environment variable name for configuration '%.*s'"),
400 (int)(env_name
- spec
- 1), spec
);
402 env_value
= getenv(env_name
);
404 die(_("missing environment variable '%s' for configuration '%.*s'"),
405 env_name
, (int)(env_name
- spec
- 1), spec
);
407 git_config_push_split_parameter(key
, env_value
);
411 static inline int iskeychar(int c
)
413 return isalnum(c
) || c
== '-';
417 * Auxiliary function to sanity-check and split the key into the section
418 * identifier and variable name.
420 * Returns 0 on success, -1 when there is an invalid character in the key and
421 * -2 if there is no section name in the key.
423 * store_key - pointer to char* which will hold a copy of the key with
424 * lowercase section and variable name
425 * baselen - pointer to size_t which will hold the length of the
426 * section + subsection part, can be NULL
428 int git_config_parse_key(const char *key
, char **store_key
, size_t *baselen_
)
432 const char *last_dot
= strrchr(key
, '.');
435 * Since "key" actually contains the section name and the real
436 * key name separated by a dot, we have to know where the dot is.
439 if (last_dot
== NULL
|| last_dot
== key
) {
440 error(_("key does not contain a section: %s"), key
);
441 return -CONFIG_NO_SECTION_OR_NAME
;
445 error(_("key does not contain variable name: %s"), key
);
446 return -CONFIG_NO_SECTION_OR_NAME
;
449 baselen
= last_dot
- key
;
454 * Validate the key and while at it, lower case it for matching.
456 *store_key
= xmallocz(strlen(key
));
459 for (i
= 0; key
[i
]; i
++) {
460 unsigned char c
= key
[i
];
463 /* Leave the extended basename untouched.. */
464 if (!dot
|| i
> baselen
) {
466 (i
== baselen
+ 1 && !isalpha(c
))) {
467 error(_("invalid key: %s"), key
);
471 } else if (c
== '\n') {
472 error(_("invalid key (newline): %s"), key
);
481 FREE_AND_NULL(*store_key
);
482 return -CONFIG_INVALID_KEY
;
485 static int config_parse_pair(const char *key
, const char *value
,
486 config_fn_t fn
, void *data
)
488 char *canonical_name
;
492 return error(_("empty config key"));
493 if (git_config_parse_key(key
, &canonical_name
, NULL
))
496 ret
= (fn(canonical_name
, value
, data
) < 0) ? -1 : 0;
497 free(canonical_name
);
501 int git_config_parse_parameter(const char *text
,
502 config_fn_t fn
, void *data
)
505 struct strbuf
**pair
;
508 pair
= strbuf_split_str(text
, '=', 2);
510 return error(_("bogus config parameter: %s"), text
);
512 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
513 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
514 value
= pair
[1] ? pair
[1]->buf
: "";
519 strbuf_trim(pair
[0]);
521 strbuf_list_free(pair
);
522 return error(_("bogus config parameter: %s"), text
);
525 ret
= config_parse_pair(pair
[0]->buf
, value
, fn
, data
);
526 strbuf_list_free(pair
);
530 static int parse_config_env_list(char *env
, config_fn_t fn
, void *data
)
533 while (cur
&& *cur
) {
534 const char *key
= sq_dequote_step(cur
, &cur
);
536 return error(_("bogus format in %s"),
537 CONFIG_DATA_ENVIRONMENT
);
539 if (!cur
|| isspace(*cur
)) {
540 /* old-style 'key=value' */
541 if (git_config_parse_parameter(key
, fn
, data
) < 0)
544 else if (*cur
== '=') {
545 /* new-style 'key'='value' */
551 value
= sq_dequote_step(cur
, &cur
);
552 if (!value
|| (cur
&& !isspace(*cur
))) {
553 return error(_("bogus format in %s"),
554 CONFIG_DATA_ENVIRONMENT
);
556 } else if (!*cur
|| isspace(*cur
)) {
557 /* implicit bool: 'key'= */
560 return error(_("bogus format in %s"),
561 CONFIG_DATA_ENVIRONMENT
);
564 if (config_parse_pair(key
, value
, fn
, data
) < 0)
569 return error(_("bogus format in %s"),
570 CONFIG_DATA_ENVIRONMENT
);
574 while (isspace(*cur
))
581 int git_config_from_parameters(config_fn_t fn
, void *data
)
584 struct strbuf envvar
= STRBUF_INIT
;
585 struct strvec to_free
= STRVEC_INIT
;
588 struct config_source source
;
590 memset(&source
, 0, sizeof(source
));
592 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
595 env
= getenv(CONFIG_COUNT_ENVIRONMENT
);
601 count
= strtoul(env
, &endp
, 10);
603 ret
= error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT
);
606 if (count
> INT_MAX
) {
607 ret
= error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT
);
611 for (i
= 0; i
< count
; i
++) {
612 const char *key
, *value
;
614 strbuf_addf(&envvar
, "GIT_CONFIG_KEY_%d", i
);
615 key
= getenv_safe(&to_free
, envvar
.buf
);
617 ret
= error(_("missing config key %s"), envvar
.buf
);
620 strbuf_reset(&envvar
);
622 strbuf_addf(&envvar
, "GIT_CONFIG_VALUE_%d", i
);
623 value
= getenv_safe(&to_free
, envvar
.buf
);
625 ret
= error(_("missing config value %s"), envvar
.buf
);
628 strbuf_reset(&envvar
);
630 if (config_parse_pair(key
, value
, fn
, data
) < 0) {
637 env
= getenv(CONFIG_DATA_ENVIRONMENT
);
639 /* sq_dequote will write over it */
641 if (parse_config_env_list(envw
, fn
, data
) < 0) {
648 strbuf_release(&envvar
);
649 strvec_clear(&to_free
);
655 static int get_next_char(void)
657 int c
= cf
->do_fgetc(cf
);
660 /* DOS like systems */
661 c
= cf
->do_fgetc(cf
);
664 cf
->do_ungetc(c
, cf
);
669 if (c
!= EOF
&& ++cf
->total_len
> INT_MAX
) {
671 * This is an absurdly long config file; refuse to parse
672 * further in order to protect downstream code from integer
673 * overflows. Note that we can't return an error specifically,
674 * but we can mark EOF and put trash in the return value,
675 * which will trigger a parse error.
691 static char *parse_value(void)
693 int quote
= 0, comment
= 0, space
= 0;
695 strbuf_reset(&cf
->value
);
697 int c
= get_next_char();
703 return cf
->value
.buf
;
707 if (isspace(c
) && !quote
) {
713 if (c
== ';' || c
== '#') {
718 for (; space
; space
--)
719 strbuf_addch(&cf
->value
, ' ');
734 /* Some characters escape as themselves */
737 /* Reject unknown escape sequences */
741 strbuf_addch(&cf
->value
, c
);
748 strbuf_addch(&cf
->value
, c
);
752 static int get_value(config_fn_t fn
, void *data
, struct strbuf
*name
)
758 /* Get the full name */
765 strbuf_addch(name
, tolower(c
));
768 while (c
== ' ' || c
== '\t')
775 value
= parse_value();
780 * We already consumed the \n, but we need linenr to point to
781 * the line we just parsed during the call to fn to get
782 * accurate line number in error messages.
785 ret
= fn(name
->buf
, value
, data
);
791 static int get_extended_base_var(struct strbuf
*name
, int c
)
793 cf
->subsection_case_sensitive
= 0;
796 goto error_incomplete_line
;
798 } while (isspace(c
));
800 /* We require the format to be '[base "extension"]' */
803 strbuf_addch(name
, '.');
806 int c
= get_next_char();
808 goto error_incomplete_line
;
814 goto error_incomplete_line
;
816 strbuf_addch(name
, c
);
820 if (get_next_char() != ']')
823 error_incomplete_line
:
828 static int get_base_var(struct strbuf
*name
)
830 cf
->subsection_case_sensitive
= 1;
832 int c
= get_next_char();
838 return get_extended_base_var(name
, c
);
839 if (!iskeychar(c
) && c
!= '.')
841 strbuf_addch(name
, tolower(c
));
845 struct parse_event_data
{
846 enum config_event_t previous_type
;
847 size_t previous_offset
;
848 const struct config_options
*opts
;
851 static int do_event(enum config_event_t type
, struct parse_event_data
*data
)
855 if (!data
->opts
|| !data
->opts
->event_fn
)
858 if (type
== CONFIG_EVENT_WHITESPACE
&&
859 data
->previous_type
== type
)
862 offset
= cf
->do_ftell(cf
);
864 * At EOF, the parser always "inserts" an extra '\n', therefore
865 * the end offset of the event is the current file position, otherwise
866 * we will already have advanced to the next event.
868 if (type
!= CONFIG_EVENT_EOF
)
871 if (data
->previous_type
!= CONFIG_EVENT_EOF
&&
872 data
->opts
->event_fn(data
->previous_type
, data
->previous_offset
,
873 offset
, data
->opts
->event_fn_data
) < 0)
876 data
->previous_type
= type
;
877 data
->previous_offset
= offset
;
882 static int git_parse_source(config_fn_t fn
, void *data
,
883 const struct config_options
*opts
)
887 struct strbuf
*var
= &cf
->var
;
888 int error_return
= 0;
889 char *error_msg
= NULL
;
891 /* U+FEFF Byte Order Mark in UTF8 */
892 const char *bomptr
= utf8_bom
;
894 /* For the parser event callback */
895 struct parse_event_data event_data
= {
896 CONFIG_EVENT_EOF
, 0, opts
903 if (bomptr
&& *bomptr
) {
904 /* We are at the file beginning; skip UTF8-encoded BOM
905 * if present. Sane editors won't put this in on their
906 * own, but e.g. Windows Notepad will do it happily. */
907 if (c
== (*bomptr
& 0377)) {
911 /* Do not tolerate partial BOM. */
912 if (bomptr
!= utf8_bom
)
914 /* No BOM at file beginning. Cool. */
920 if (do_event(CONFIG_EVENT_EOF
, &event_data
) < 0)
924 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
932 if (do_event(CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
936 if (c
== '#' || c
== ';') {
937 if (do_event(CONFIG_EVENT_COMMENT
, &event_data
) < 0)
943 if (do_event(CONFIG_EVENT_SECTION
, &event_data
) < 0)
946 /* Reset prior to determining a new stem */
948 if (get_base_var(var
) < 0 || var
->len
< 1)
950 strbuf_addch(var
, '.');
957 if (do_event(CONFIG_EVENT_ENTRY
, &event_data
) < 0)
961 * Truncate the var name back to the section header
962 * stem prior to grabbing the suffix part of the name
965 strbuf_setlen(var
, baselen
);
966 strbuf_addch(var
, tolower(c
));
967 if (get_value(fn
, data
, var
) < 0)
971 if (do_event(CONFIG_EVENT_ERROR
, &event_data
) < 0)
974 switch (cf
->origin_type
) {
975 case CONFIG_ORIGIN_BLOB
:
976 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
977 cf
->linenr
, cf
->name
);
979 case CONFIG_ORIGIN_FILE
:
980 error_msg
= xstrfmt(_("bad config line %d in file %s"),
981 cf
->linenr
, cf
->name
);
983 case CONFIG_ORIGIN_STDIN
:
984 error_msg
= xstrfmt(_("bad config line %d in standard input"),
987 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
988 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
989 cf
->linenr
, cf
->name
);
991 case CONFIG_ORIGIN_CMDLINE
:
992 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
993 cf
->linenr
, cf
->name
);
996 error_msg
= xstrfmt(_("bad config line %d in %s"),
997 cf
->linenr
, cf
->name
);
1000 switch (opts
&& opts
->error_action
?
1001 opts
->error_action
:
1002 cf
->default_error_action
) {
1003 case CONFIG_ERROR_DIE
:
1004 die("%s", error_msg
);
1006 case CONFIG_ERROR_ERROR
:
1007 error_return
= error("%s", error_msg
);
1009 case CONFIG_ERROR_SILENT
:
1012 case CONFIG_ERROR_UNSET
:
1013 BUG("config error action unset");
1017 return error_return
;
1020 static uintmax_t get_unit_factor(const char *end
)
1024 else if (!strcasecmp(end
, "k"))
1026 else if (!strcasecmp(end
, "m"))
1028 else if (!strcasecmp(end
, "g"))
1029 return 1024 * 1024 * 1024;
1033 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
1035 if (value
&& *value
) {
1042 val
= strtoimax(value
, &end
, 0);
1043 if (errno
== ERANGE
)
1045 factor
= get_unit_factor(end
);
1050 uval
= val
< 0 ? -val
: val
;
1051 if (unsigned_mult_overflows(factor
, uval
) ||
1052 factor
* uval
> max
) {
1064 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
1066 if (value
&& *value
) {
1072 val
= strtoumax(value
, &end
, 0);
1073 if (errno
== ERANGE
)
1075 factor
= get_unit_factor(end
);
1080 if (unsigned_mult_overflows(factor
, val
) ||
1081 factor
* val
> max
) {
1093 static int git_parse_int(const char *value
, int *ret
)
1096 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
1102 static int git_parse_int64(const char *value
, int64_t *ret
)
1105 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
1111 int git_parse_ulong(const char *value
, unsigned long *ret
)
1114 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
1120 int git_parse_ssize_t(const char *value
, ssize_t
*ret
)
1123 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(ssize_t
)))
1130 static void die_bad_number(const char *name
, const char *value
)
1132 const char *error_type
= (errno
== ERANGE
) ?
1133 N_("out of range") : N_("invalid unit");
1134 const char *bad_numeric
= N_("bad numeric config value '%s' for '%s': %s");
1139 if (!(cf
&& cf
->name
))
1140 die(_(bad_numeric
), value
, name
, _(error_type
));
1142 switch (cf
->origin_type
) {
1143 case CONFIG_ORIGIN_BLOB
:
1144 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1145 value
, name
, cf
->name
, _(error_type
));
1146 case CONFIG_ORIGIN_FILE
:
1147 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1148 value
, name
, cf
->name
, _(error_type
));
1149 case CONFIG_ORIGIN_STDIN
:
1150 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1151 value
, name
, _(error_type
));
1152 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1153 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1154 value
, name
, cf
->name
, _(error_type
));
1155 case CONFIG_ORIGIN_CMDLINE
:
1156 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1157 value
, name
, cf
->name
, _(error_type
));
1159 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1160 value
, name
, cf
->name
, _(error_type
));
1164 int git_config_int(const char *name
, const char *value
)
1167 if (!git_parse_int(value
, &ret
))
1168 die_bad_number(name
, value
);
1172 int64_t git_config_int64(const char *name
, const char *value
)
1175 if (!git_parse_int64(value
, &ret
))
1176 die_bad_number(name
, value
);
1180 unsigned long git_config_ulong(const char *name
, const char *value
)
1183 if (!git_parse_ulong(value
, &ret
))
1184 die_bad_number(name
, value
);
1188 ssize_t
git_config_ssize_t(const char *name
, const char *value
)
1191 if (!git_parse_ssize_t(value
, &ret
))
1192 die_bad_number(name
, value
);
1196 static int git_parse_maybe_bool_text(const char *value
)
1202 if (!strcasecmp(value
, "true")
1203 || !strcasecmp(value
, "yes")
1204 || !strcasecmp(value
, "on"))
1206 if (!strcasecmp(value
, "false")
1207 || !strcasecmp(value
, "no")
1208 || !strcasecmp(value
, "off"))
1213 int git_parse_maybe_bool(const char *value
)
1215 int v
= git_parse_maybe_bool_text(value
);
1218 if (git_parse_int(value
, &v
))
1223 int git_config_bool_or_int(const char *name
, const char *value
, int *is_bool
)
1225 int v
= git_parse_maybe_bool_text(value
);
1231 return git_config_int(name
, value
);
1234 int git_config_bool(const char *name
, const char *value
)
1236 int v
= git_parse_maybe_bool(value
);
1238 die(_("bad boolean config value '%s' for '%s'"), value
, name
);
1242 int git_config_string(const char **dest
, const char *var
, const char *value
)
1245 return config_error_nonbool(var
);
1246 *dest
= xstrdup(value
);
1250 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
1253 return config_error_nonbool(var
);
1254 *dest
= interpolate_path(value
, 0);
1256 die(_("failed to expand user dir in: '%s'"), value
);
1260 int git_config_expiry_date(timestamp_t
*timestamp
, const char *var
, const char *value
)
1263 return config_error_nonbool(var
);
1264 if (parse_expiry_date(value
, timestamp
))
1265 return error(_("'%s' for '%s' is not a valid timestamp"),
1270 int git_config_color(char *dest
, const char *var
, const char *value
)
1273 return config_error_nonbool(var
);
1274 if (color_parse(value
, dest
) < 0)
1279 static int git_default_core_config(const char *var
, const char *value
, void *cb
)
1281 /* This needs a better name */
1282 if (!strcmp(var
, "core.filemode")) {
1283 trust_executable_bit
= git_config_bool(var
, value
);
1286 if (!strcmp(var
, "core.trustctime")) {
1287 trust_ctime
= git_config_bool(var
, value
);
1290 if (!strcmp(var
, "core.checkstat")) {
1291 if (!strcasecmp(value
, "default"))
1293 else if (!strcasecmp(value
, "minimal"))
1297 if (!strcmp(var
, "core.quotepath")) {
1298 quote_path_fully
= git_config_bool(var
, value
);
1302 if (!strcmp(var
, "core.symlinks")) {
1303 has_symlinks
= git_config_bool(var
, value
);
1307 if (!strcmp(var
, "core.ignorecase")) {
1308 ignore_case
= git_config_bool(var
, value
);
1312 if (!strcmp(var
, "core.attributesfile"))
1313 return git_config_pathname(&git_attributes_file
, var
, value
);
1315 if (!strcmp(var
, "core.hookspath"))
1316 return git_config_pathname(&git_hooks_path
, var
, value
);
1318 if (!strcmp(var
, "core.bare")) {
1319 is_bare_repository_cfg
= git_config_bool(var
, value
);
1323 if (!strcmp(var
, "core.ignorestat")) {
1324 assume_unchanged
= git_config_bool(var
, value
);
1328 if (!strcmp(var
, "core.prefersymlinkrefs")) {
1329 prefer_symlink_refs
= git_config_bool(var
, value
);
1333 if (!strcmp(var
, "core.logallrefupdates")) {
1334 if (value
&& !strcasecmp(value
, "always"))
1335 log_all_ref_updates
= LOG_REFS_ALWAYS
;
1336 else if (git_config_bool(var
, value
))
1337 log_all_ref_updates
= LOG_REFS_NORMAL
;
1339 log_all_ref_updates
= LOG_REFS_NONE
;
1343 if (!strcmp(var
, "core.warnambiguousrefs")) {
1344 warn_ambiguous_refs
= git_config_bool(var
, value
);
1348 if (!strcmp(var
, "core.abbrev")) {
1350 return config_error_nonbool(var
);
1351 if (!strcasecmp(value
, "auto"))
1352 default_abbrev
= -1;
1353 else if (!git_parse_maybe_bool_text(value
))
1354 default_abbrev
= the_hash_algo
->hexsz
;
1356 int abbrev
= git_config_int(var
, value
);
1357 if (abbrev
< minimum_abbrev
|| abbrev
> the_hash_algo
->hexsz
)
1358 return error(_("abbrev length out of range: %d"), abbrev
);
1359 default_abbrev
= abbrev
;
1364 if (!strcmp(var
, "core.disambiguate"))
1365 return set_disambiguate_hint_config(var
, value
);
1367 if (!strcmp(var
, "core.loosecompression")) {
1368 int level
= git_config_int(var
, value
);
1370 level
= Z_DEFAULT_COMPRESSION
;
1371 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1372 die(_("bad zlib compression level %d"), level
);
1373 zlib_compression_level
= level
;
1374 zlib_compression_seen
= 1;
1378 if (!strcmp(var
, "core.compression")) {
1379 int level
= git_config_int(var
, value
);
1381 level
= Z_DEFAULT_COMPRESSION
;
1382 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1383 die(_("bad zlib compression level %d"), level
);
1384 if (!zlib_compression_seen
)
1385 zlib_compression_level
= level
;
1386 if (!pack_compression_seen
)
1387 pack_compression_level
= level
;
1391 if (!strcmp(var
, "core.packedgitwindowsize")) {
1392 int pgsz_x2
= getpagesize() * 2;
1393 packed_git_window_size
= git_config_ulong(var
, value
);
1395 /* This value must be multiple of (pagesize * 2) */
1396 packed_git_window_size
/= pgsz_x2
;
1397 if (packed_git_window_size
< 1)
1398 packed_git_window_size
= 1;
1399 packed_git_window_size
*= pgsz_x2
;
1403 if (!strcmp(var
, "core.bigfilethreshold")) {
1404 big_file_threshold
= git_config_ulong(var
, value
);
1408 if (!strcmp(var
, "core.packedgitlimit")) {
1409 packed_git_limit
= git_config_ulong(var
, value
);
1413 if (!strcmp(var
, "core.deltabasecachelimit")) {
1414 delta_base_cache_limit
= git_config_ulong(var
, value
);
1418 if (!strcmp(var
, "core.autocrlf")) {
1419 if (value
&& !strcasecmp(value
, "input")) {
1420 auto_crlf
= AUTO_CRLF_INPUT
;
1423 auto_crlf
= git_config_bool(var
, value
);
1427 if (!strcmp(var
, "core.safecrlf")) {
1429 if (value
&& !strcasecmp(value
, "warn")) {
1430 global_conv_flags_eol
= CONV_EOL_RNDTRP_WARN
;
1433 eol_rndtrp_die
= git_config_bool(var
, value
);
1434 global_conv_flags_eol
= eol_rndtrp_die
?
1435 CONV_EOL_RNDTRP_DIE
: 0;
1439 if (!strcmp(var
, "core.eol")) {
1440 if (value
&& !strcasecmp(value
, "lf"))
1442 else if (value
&& !strcasecmp(value
, "crlf"))
1443 core_eol
= EOL_CRLF
;
1444 else if (value
&& !strcasecmp(value
, "native"))
1445 core_eol
= EOL_NATIVE
;
1447 core_eol
= EOL_UNSET
;
1451 if (!strcmp(var
, "core.checkroundtripencoding")) {
1452 check_roundtrip_encoding
= xstrdup(value
);
1456 if (!strcmp(var
, "core.notesref")) {
1457 notes_ref_name
= xstrdup(value
);
1461 if (!strcmp(var
, "core.editor"))
1462 return git_config_string(&editor_program
, var
, value
);
1464 if (!strcmp(var
, "core.commentchar")) {
1466 return config_error_nonbool(var
);
1467 else if (!strcasecmp(value
, "auto"))
1468 auto_comment_line_char
= 1;
1469 else if (value
[0] && !value
[1]) {
1470 comment_line_char
= value
[0];
1471 auto_comment_line_char
= 0;
1473 return error(_("core.commentChar should only be one character"));
1477 if (!strcmp(var
, "core.askpass"))
1478 return git_config_string(&askpass_program
, var
, value
);
1480 if (!strcmp(var
, "core.excludesfile"))
1481 return git_config_pathname(&excludes_file
, var
, value
);
1483 if (!strcmp(var
, "core.whitespace")) {
1485 return config_error_nonbool(var
);
1486 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1490 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1491 fsync_object_files
= git_config_bool(var
, value
);
1495 if (!strcmp(var
, "core.preloadindex")) {
1496 core_preload_index
= git_config_bool(var
, value
);
1500 if (!strcmp(var
, "core.createobject")) {
1501 if (!strcmp(value
, "rename"))
1502 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1503 else if (!strcmp(value
, "link"))
1504 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1506 die(_("invalid mode for object creation: %s"), value
);
1510 if (!strcmp(var
, "core.sparsecheckout")) {
1511 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1515 if (!strcmp(var
, "core.sparsecheckoutcone")) {
1516 core_sparse_checkout_cone
= git_config_bool(var
, value
);
1520 if (!strcmp(var
, "core.precomposeunicode")) {
1521 precomposed_unicode
= git_config_bool(var
, value
);
1525 if (!strcmp(var
, "core.protecthfs")) {
1526 protect_hfs
= git_config_bool(var
, value
);
1530 if (!strcmp(var
, "core.protectntfs")) {
1531 protect_ntfs
= git_config_bool(var
, value
);
1535 if (!strcmp(var
, "core.usereplacerefs")) {
1536 read_replace_refs
= git_config_bool(var
, value
);
1540 /* Add other config variables here and to Documentation/config.txt. */
1541 return platform_core_config(var
, value
, cb
);
1544 static int git_default_i18n_config(const char *var
, const char *value
)
1546 if (!strcmp(var
, "i18n.commitencoding"))
1547 return git_config_string(&git_commit_encoding
, var
, value
);
1549 if (!strcmp(var
, "i18n.logoutputencoding"))
1550 return git_config_string(&git_log_output_encoding
, var
, value
);
1552 /* Add other config variables here and to Documentation/config.txt. */
1556 static int git_default_branch_config(const char *var
, const char *value
)
1558 if (!strcmp(var
, "branch.autosetupmerge")) {
1559 if (value
&& !strcasecmp(value
, "always")) {
1560 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1563 git_branch_track
= git_config_bool(var
, value
);
1566 if (!strcmp(var
, "branch.autosetuprebase")) {
1568 return config_error_nonbool(var
);
1569 else if (!strcmp(value
, "never"))
1570 autorebase
= AUTOREBASE_NEVER
;
1571 else if (!strcmp(value
, "local"))
1572 autorebase
= AUTOREBASE_LOCAL
;
1573 else if (!strcmp(value
, "remote"))
1574 autorebase
= AUTOREBASE_REMOTE
;
1575 else if (!strcmp(value
, "always"))
1576 autorebase
= AUTOREBASE_ALWAYS
;
1578 return error(_("malformed value for %s"), var
);
1582 /* Add other config variables here and to Documentation/config.txt. */
1586 static int git_default_push_config(const char *var
, const char *value
)
1588 if (!strcmp(var
, "push.default")) {
1590 return config_error_nonbool(var
);
1591 else if (!strcmp(value
, "nothing"))
1592 push_default
= PUSH_DEFAULT_NOTHING
;
1593 else if (!strcmp(value
, "matching"))
1594 push_default
= PUSH_DEFAULT_MATCHING
;
1595 else if (!strcmp(value
, "simple"))
1596 push_default
= PUSH_DEFAULT_SIMPLE
;
1597 else if (!strcmp(value
, "upstream"))
1598 push_default
= PUSH_DEFAULT_UPSTREAM
;
1599 else if (!strcmp(value
, "tracking")) /* deprecated */
1600 push_default
= PUSH_DEFAULT_UPSTREAM
;
1601 else if (!strcmp(value
, "current"))
1602 push_default
= PUSH_DEFAULT_CURRENT
;
1604 error(_("malformed value for %s: %s"), var
, value
);
1605 return error(_("must be one of nothing, matching, simple, "
1606 "upstream or current"));
1611 /* Add other config variables here and to Documentation/config.txt. */
1615 static int git_default_mailmap_config(const char *var
, const char *value
)
1617 if (!strcmp(var
, "mailmap.file"))
1618 return git_config_pathname(&git_mailmap_file
, var
, value
);
1619 if (!strcmp(var
, "mailmap.blob"))
1620 return git_config_string(&git_mailmap_blob
, var
, value
);
1622 /* Add other config variables here and to Documentation/config.txt. */
1626 int git_default_config(const char *var
, const char *value
, void *cb
)
1628 if (starts_with(var
, "core."))
1629 return git_default_core_config(var
, value
, cb
);
1631 if (starts_with(var
, "user.") ||
1632 starts_with(var
, "author.") ||
1633 starts_with(var
, "committer."))
1634 return git_ident_config(var
, value
, cb
);
1636 if (starts_with(var
, "i18n."))
1637 return git_default_i18n_config(var
, value
);
1639 if (starts_with(var
, "branch."))
1640 return git_default_branch_config(var
, value
);
1642 if (starts_with(var
, "push."))
1643 return git_default_push_config(var
, value
);
1645 if (starts_with(var
, "mailmap."))
1646 return git_default_mailmap_config(var
, value
);
1648 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1649 return git_default_advice_config(var
, value
);
1651 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1652 pager_use_color
= git_config_bool(var
,value
);
1656 if (!strcmp(var
, "pack.packsizelimit")) {
1657 pack_size_limit_cfg
= git_config_ulong(var
, value
);
1661 if (!strcmp(var
, "pack.compression")) {
1662 int level
= git_config_int(var
, value
);
1664 level
= Z_DEFAULT_COMPRESSION
;
1665 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1666 die(_("bad pack compression level %d"), level
);
1667 pack_compression_level
= level
;
1668 pack_compression_seen
= 1;
1672 /* Add other config variables here and to Documentation/config.txt. */
1677 * All source specific fields in the union, die_on_error, name and the callbacks
1678 * fgetc, ungetc, ftell of top need to be initialized before calling
1681 static int do_config_from(struct config_source
*top
, config_fn_t fn
, void *data
,
1682 const struct config_options
*opts
)
1686 /* push config-file parsing state stack */
1691 strbuf_init(&top
->value
, 1024);
1692 strbuf_init(&top
->var
, 1024);
1695 ret
= git_parse_source(fn
, data
, opts
);
1697 /* pop config-file parsing state stack */
1698 strbuf_release(&top
->value
);
1699 strbuf_release(&top
->var
);
1705 static int do_config_from_file(config_fn_t fn
,
1706 const enum config_origin_type origin_type
,
1707 const char *name
, const char *path
, FILE *f
,
1708 void *data
, const struct config_options
*opts
)
1710 struct config_source top
;
1714 top
.origin_type
= origin_type
;
1717 top
.default_error_action
= CONFIG_ERROR_DIE
;
1718 top
.do_fgetc
= config_file_fgetc
;
1719 top
.do_ungetc
= config_file_ungetc
;
1720 top
.do_ftell
= config_file_ftell
;
1723 ret
= do_config_from(&top
, fn
, data
, opts
);
1728 static int git_config_from_stdin(config_fn_t fn
, void *data
)
1730 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
,
1734 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
1736 const struct config_options
*opts
)
1741 f
= fopen_or_warn(filename
, "r");
1743 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
,
1744 filename
, f
, data
, opts
);
1750 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1752 return git_config_from_file_with_options(fn
, filename
, data
, NULL
);
1755 int git_config_from_mem(config_fn_t fn
,
1756 const enum config_origin_type origin_type
,
1757 const char *name
, const char *buf
, size_t len
,
1758 void *data
, const struct config_options
*opts
)
1760 struct config_source top
;
1762 top
.u
.buf
.buf
= buf
;
1763 top
.u
.buf
.len
= len
;
1765 top
.origin_type
= origin_type
;
1768 top
.default_error_action
= CONFIG_ERROR_ERROR
;
1769 top
.do_fgetc
= config_buf_fgetc
;
1770 top
.do_ungetc
= config_buf_ungetc
;
1771 top
.do_ftell
= config_buf_ftell
;
1773 return do_config_from(&top
, fn
, data
, opts
);
1776 int git_config_from_blob_oid(config_fn_t fn
,
1778 struct repository
*repo
,
1779 const struct object_id
*oid
,
1782 enum object_type type
;
1787 buf
= repo_read_object_file(repo
, oid
, &type
, &size
);
1789 return error(_("unable to load config blob object '%s'"), name
);
1790 if (type
!= OBJ_BLOB
) {
1792 return error(_("reference '%s' does not point to a blob"), name
);
1795 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
1802 static int git_config_from_blob_ref(config_fn_t fn
,
1803 struct repository
*repo
,
1807 struct object_id oid
;
1809 if (repo_get_oid(repo
, name
, &oid
) < 0)
1810 return error(_("unable to resolve config blob '%s'"), name
);
1811 return git_config_from_blob_oid(fn
, name
, repo
, &oid
, data
);
1814 char *git_system_config(void)
1816 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1818 system_config
= system_path(ETC_GITCONFIG
);
1819 normalize_path_copy(system_config
, system_config
);
1820 return system_config
;
1823 void git_global_config(char **user_out
, char **xdg_out
)
1825 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1826 char *xdg_config
= NULL
;
1829 user_config
= interpolate_path("~/.gitconfig", 0);
1830 xdg_config
= xdg_config_home("config");
1833 *user_out
= user_config
;
1834 *xdg_out
= xdg_config
;
1838 * Parse environment variable 'k' as a boolean (in various
1839 * possible spellings); if missing, use the default value 'def'.
1841 int git_env_bool(const char *k
, int def
)
1843 const char *v
= getenv(k
);
1844 return v
? git_config_bool(k
, v
) : def
;
1848 * Parse environment variable 'k' as ulong with possibly a unit
1849 * suffix; if missing, use the default value 'val'.
1851 unsigned long git_env_ulong(const char *k
, unsigned long val
)
1853 const char *v
= getenv(k
);
1854 if (v
&& !git_parse_ulong(v
, &val
))
1855 die(_("failed to parse %s"), k
);
1859 int git_config_system(void)
1861 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1864 static int do_git_config_sequence(const struct config_options
*opts
,
1865 config_fn_t fn
, void *data
)
1868 char *system_config
= git_system_config();
1869 char *xdg_config
= NULL
;
1870 char *user_config
= NULL
;
1872 enum config_scope prev_parsing_scope
= current_parsing_scope
;
1874 if (opts
->commondir
)
1875 repo_config
= mkpathdup("%s/config", opts
->commondir
);
1876 else if (opts
->git_dir
)
1877 BUG("git_dir without commondir");
1881 current_parsing_scope
= CONFIG_SCOPE_SYSTEM
;
1882 if (git_config_system() && system_config
&&
1883 !access_or_die(system_config
, R_OK
,
1884 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
1885 ret
+= git_config_from_file(fn
, system_config
, data
);
1887 current_parsing_scope
= CONFIG_SCOPE_GLOBAL
;
1888 git_global_config(&user_config
, &xdg_config
);
1890 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
1891 ret
+= git_config_from_file(fn
, xdg_config
, data
);
1893 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
1894 ret
+= git_config_from_file(fn
, user_config
, data
);
1896 current_parsing_scope
= CONFIG_SCOPE_LOCAL
;
1897 if (!opts
->ignore_repo
&& repo_config
&&
1898 !access_or_die(repo_config
, R_OK
, 0))
1899 ret
+= git_config_from_file(fn
, repo_config
, data
);
1901 current_parsing_scope
= CONFIG_SCOPE_WORKTREE
;
1902 if (!opts
->ignore_worktree
&& repository_format_worktree_config
) {
1903 char *path
= git_pathdup("config.worktree");
1904 if (!access_or_die(path
, R_OK
, 0))
1905 ret
+= git_config_from_file(fn
, path
, data
);
1909 current_parsing_scope
= CONFIG_SCOPE_COMMAND
;
1910 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
1911 die(_("unable to parse command-line config"));
1913 current_parsing_scope
= prev_parsing_scope
;
1914 free(system_config
);
1921 int config_with_options(config_fn_t fn
, void *data
,
1922 struct git_config_source
*config_source
,
1923 const struct config_options
*opts
)
1925 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
1927 if (opts
->respect_includes
) {
1931 fn
= git_config_include
;
1936 current_parsing_scope
= config_source
->scope
;
1939 * If we have a specific filename, use it. Otherwise, follow the
1940 * regular lookup sequence.
1942 if (config_source
&& config_source
->use_stdin
) {
1943 return git_config_from_stdin(fn
, data
);
1944 } else if (config_source
&& config_source
->file
) {
1945 return git_config_from_file(fn
, config_source
->file
, data
);
1946 } else if (config_source
&& config_source
->blob
) {
1947 struct repository
*repo
= config_source
->repo
?
1948 config_source
->repo
: the_repository
;
1949 return git_config_from_blob_ref(fn
, repo
, config_source
->blob
,
1953 return do_git_config_sequence(opts
, fn
, data
);
1956 static void configset_iter(struct config_set
*cs
, config_fn_t fn
, void *data
)
1959 struct string_list
*values
;
1960 struct config_set_element
*entry
;
1961 struct configset_list
*list
= &cs
->list
;
1963 for (i
= 0; i
< list
->nr
; i
++) {
1964 entry
= list
->items
[i
].e
;
1965 value_index
= list
->items
[i
].value_index
;
1966 values
= &entry
->value_list
;
1968 current_config_kvi
= values
->items
[value_index
].util
;
1970 if (fn(entry
->key
, values
->items
[value_index
].string
, data
) < 0)
1971 git_die_config_linenr(entry
->key
,
1972 current_config_kvi
->filename
,
1973 current_config_kvi
->linenr
);
1975 current_config_kvi
= NULL
;
1979 void read_early_config(config_fn_t cb
, void *data
)
1981 struct config_options opts
= {0};
1982 struct strbuf commondir
= STRBUF_INIT
;
1983 struct strbuf gitdir
= STRBUF_INIT
;
1985 opts
.respect_includes
= 1;
1987 if (have_git_dir()) {
1988 opts
.commondir
= get_git_common_dir();
1989 opts
.git_dir
= get_git_dir();
1991 * When setup_git_directory() was not yet asked to discover the
1992 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1993 * is any repository config we should use (but unlike
1994 * setup_git_directory_gently(), no global state is changed, most
1995 * notably, the current working directory is still the same after the
1998 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
1999 opts
.commondir
= commondir
.buf
;
2000 opts
.git_dir
= gitdir
.buf
;
2003 config_with_options(cb
, data
, NULL
, &opts
);
2005 strbuf_release(&commondir
);
2006 strbuf_release(&gitdir
);
2010 * Read config but only enumerate system and global settings.
2011 * Omit any repo-local, worktree-local, or command-line settings.
2013 void read_very_early_config(config_fn_t cb
, void *data
)
2015 struct config_options opts
= { 0 };
2017 opts
.respect_includes
= 1;
2018 opts
.ignore_repo
= 1;
2019 opts
.ignore_worktree
= 1;
2020 opts
.ignore_cmdline
= 1;
2021 opts
.system_gently
= 1;
2023 config_with_options(cb
, data
, NULL
, &opts
);
2026 static struct config_set_element
*configset_find_element(struct config_set
*cs
, const char *key
)
2028 struct config_set_element k
;
2029 struct config_set_element
*found_entry
;
2030 char *normalized_key
;
2032 * `key` may come from the user, so normalize it before using it
2033 * for querying entries from the hashmap.
2035 if (git_config_parse_key(key
, &normalized_key
, NULL
))
2038 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2039 k
.key
= normalized_key
;
2040 found_entry
= hashmap_get_entry(&cs
->config_hash
, &k
, ent
, NULL
);
2041 free(normalized_key
);
2045 static int configset_add_value(struct config_set
*cs
, const char *key
, const char *value
)
2047 struct config_set_element
*e
;
2048 struct string_list_item
*si
;
2049 struct configset_list_item
*l_item
;
2050 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2052 e
= configset_find_element(cs
, key
);
2054 * Since the keys are being fed by git_config*() callback mechanism, they
2055 * are already normalized. So simply add them without any further munging.
2058 e
= xmalloc(sizeof(*e
));
2059 hashmap_entry_init(&e
->ent
, strhash(key
));
2060 e
->key
= xstrdup(key
);
2061 string_list_init_dup(&e
->value_list
);
2062 hashmap_add(&cs
->config_hash
, &e
->ent
);
2064 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2066 ALLOC_GROW(cs
->list
.items
, cs
->list
.nr
+ 1, cs
->list
.alloc
);
2067 l_item
= &cs
->list
.items
[cs
->list
.nr
++];
2069 l_item
->value_index
= e
->value_list
.nr
- 1;
2072 BUG("configset_add_value has no source");
2074 kv_info
->filename
= strintern(cf
->name
);
2075 kv_info
->linenr
= cf
->linenr
;
2076 kv_info
->origin_type
= cf
->origin_type
;
2078 /* for values read from `git_config_from_parameters()` */
2079 kv_info
->filename
= NULL
;
2080 kv_info
->linenr
= -1;
2081 kv_info
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
2083 kv_info
->scope
= current_parsing_scope
;
2089 static int config_set_element_cmp(const void *unused_cmp_data
,
2090 const struct hashmap_entry
*eptr
,
2091 const struct hashmap_entry
*entry_or_key
,
2092 const void *unused_keydata
)
2094 const struct config_set_element
*e1
, *e2
;
2096 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2097 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2099 return strcmp(e1
->key
, e2
->key
);
2102 void git_configset_init(struct config_set
*cs
)
2104 hashmap_init(&cs
->config_hash
, config_set_element_cmp
, NULL
, 0);
2105 cs
->hash_initialized
= 1;
2108 cs
->list
.items
= NULL
;
2111 void git_configset_clear(struct config_set
*cs
)
2113 struct config_set_element
*entry
;
2114 struct hashmap_iter iter
;
2115 if (!cs
->hash_initialized
)
2118 hashmap_for_each_entry(&cs
->config_hash
, &iter
, entry
,
2119 ent
/* member name */) {
2121 string_list_clear(&entry
->value_list
, 1);
2123 hashmap_clear_and_free(&cs
->config_hash
, struct config_set_element
, ent
);
2124 cs
->hash_initialized
= 0;
2125 free(cs
->list
.items
);
2128 cs
->list
.items
= NULL
;
2131 static int config_set_callback(const char *key
, const char *value
, void *cb
)
2133 struct config_set
*cs
= cb
;
2134 configset_add_value(cs
, key
, value
);
2138 int git_configset_add_file(struct config_set
*cs
, const char *filename
)
2140 return git_config_from_file(config_set_callback
, filename
, cs
);
2143 int git_configset_get_value(struct config_set
*cs
, const char *key
, const char **value
)
2145 const struct string_list
*values
= NULL
;
2147 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2148 * queried key in the files of the configset, the value returned will be the last
2149 * value in the value list for that key.
2151 values
= git_configset_get_value_multi(cs
, key
);
2155 assert(values
->nr
> 0);
2156 *value
= values
->items
[values
->nr
- 1].string
;
2160 const struct string_list
*git_configset_get_value_multi(struct config_set
*cs
, const char *key
)
2162 struct config_set_element
*e
= configset_find_element(cs
, key
);
2163 return e
? &e
->value_list
: NULL
;
2166 int git_configset_get_string(struct config_set
*cs
, const char *key
, char **dest
)
2169 if (!git_configset_get_value(cs
, key
, &value
))
2170 return git_config_string((const char **)dest
, key
, value
);
2175 int git_configset_get_string_tmp(struct config_set
*cs
, const char *key
,
2179 if (!git_configset_get_value(cs
, key
, &value
)) {
2181 return config_error_nonbool(key
);
2189 int git_configset_get_int(struct config_set
*cs
, const char *key
, int *dest
)
2192 if (!git_configset_get_value(cs
, key
, &value
)) {
2193 *dest
= git_config_int(key
, value
);
2199 int git_configset_get_ulong(struct config_set
*cs
, const char *key
, unsigned long *dest
)
2202 if (!git_configset_get_value(cs
, key
, &value
)) {
2203 *dest
= git_config_ulong(key
, value
);
2209 int git_configset_get_bool(struct config_set
*cs
, const char *key
, int *dest
)
2212 if (!git_configset_get_value(cs
, key
, &value
)) {
2213 *dest
= git_config_bool(key
, value
);
2219 int git_configset_get_bool_or_int(struct config_set
*cs
, const char *key
,
2220 int *is_bool
, int *dest
)
2223 if (!git_configset_get_value(cs
, key
, &value
)) {
2224 *dest
= git_config_bool_or_int(key
, value
, is_bool
);
2230 int git_configset_get_maybe_bool(struct config_set
*cs
, const char *key
, int *dest
)
2233 if (!git_configset_get_value(cs
, key
, &value
)) {
2234 *dest
= git_parse_maybe_bool(value
);
2242 int git_configset_get_pathname(struct config_set
*cs
, const char *key
, const char **dest
)
2245 if (!git_configset_get_value(cs
, key
, &value
))
2246 return git_config_pathname(dest
, key
, value
);
2251 /* Functions use to read configuration from a repository */
2252 static void repo_read_config(struct repository
*repo
)
2254 struct config_options opts
= { 0 };
2256 opts
.respect_includes
= 1;
2257 opts
.commondir
= repo
->commondir
;
2258 opts
.git_dir
= repo
->gitdir
;
2261 CALLOC_ARRAY(repo
->config
, 1);
2263 git_configset_clear(repo
->config
);
2265 git_configset_init(repo
->config
);
2267 if (config_with_options(config_set_callback
, repo
->config
, NULL
, &opts
) < 0)
2269 * config_with_options() normally returns only
2270 * zero, as most errors are fatal, and
2271 * non-fatal potential errors are guarded by "if"
2272 * statements that are entered only when no error is
2275 * If we ever encounter a non-fatal error, it means
2276 * something went really wrong and we should stop
2279 die(_("unknown error occurred while reading the configuration files"));
2282 static void git_config_check_init(struct repository
*repo
)
2284 if (repo
->config
&& repo
->config
->hash_initialized
)
2286 repo_read_config(repo
);
2289 static void repo_config_clear(struct repository
*repo
)
2291 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2293 git_configset_clear(repo
->config
);
2296 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2298 git_config_check_init(repo
);
2299 configset_iter(repo
->config
, fn
, data
);
2302 int repo_config_get_value(struct repository
*repo
,
2303 const char *key
, const char **value
)
2305 git_config_check_init(repo
);
2306 return git_configset_get_value(repo
->config
, key
, value
);
2309 const struct string_list
*repo_config_get_value_multi(struct repository
*repo
,
2312 git_config_check_init(repo
);
2313 return git_configset_get_value_multi(repo
->config
, key
);
2316 int repo_config_get_string(struct repository
*repo
,
2317 const char *key
, char **dest
)
2320 git_config_check_init(repo
);
2321 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2323 git_die_config(key
, NULL
);
2327 int repo_config_get_string_tmp(struct repository
*repo
,
2328 const char *key
, const char **dest
)
2331 git_config_check_init(repo
);
2332 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2334 git_die_config(key
, NULL
);
2338 int repo_config_get_int(struct repository
*repo
,
2339 const char *key
, int *dest
)
2341 git_config_check_init(repo
);
2342 return git_configset_get_int(repo
->config
, key
, dest
);
2345 int repo_config_get_ulong(struct repository
*repo
,
2346 const char *key
, unsigned long *dest
)
2348 git_config_check_init(repo
);
2349 return git_configset_get_ulong(repo
->config
, key
, dest
);
2352 int repo_config_get_bool(struct repository
*repo
,
2353 const char *key
, int *dest
)
2355 git_config_check_init(repo
);
2356 return git_configset_get_bool(repo
->config
, key
, dest
);
2359 int repo_config_get_bool_or_int(struct repository
*repo
,
2360 const char *key
, int *is_bool
, int *dest
)
2362 git_config_check_init(repo
);
2363 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2366 int repo_config_get_maybe_bool(struct repository
*repo
,
2367 const char *key
, int *dest
)
2369 git_config_check_init(repo
);
2370 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2373 int repo_config_get_pathname(struct repository
*repo
,
2374 const char *key
, const char **dest
)
2377 git_config_check_init(repo
);
2378 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2380 git_die_config(key
, NULL
);
2384 /* Functions used historically to read configuration from 'the_repository' */
2385 void git_config(config_fn_t fn
, void *data
)
2387 repo_config(the_repository
, fn
, data
);
2390 void git_config_clear(void)
2392 repo_config_clear(the_repository
);
2395 int git_config_get_value(const char *key
, const char **value
)
2397 return repo_config_get_value(the_repository
, key
, value
);
2400 const struct string_list
*git_config_get_value_multi(const char *key
)
2402 return repo_config_get_value_multi(the_repository
, key
);
2405 int git_config_get_string(const char *key
, char **dest
)
2407 return repo_config_get_string(the_repository
, key
, dest
);
2410 int git_config_get_string_tmp(const char *key
, const char **dest
)
2412 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2415 int git_config_get_int(const char *key
, int *dest
)
2417 return repo_config_get_int(the_repository
, key
, dest
);
2420 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2422 return repo_config_get_ulong(the_repository
, key
, dest
);
2425 int git_config_get_bool(const char *key
, int *dest
)
2427 return repo_config_get_bool(the_repository
, key
, dest
);
2430 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2432 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2435 int git_config_get_maybe_bool(const char *key
, int *dest
)
2437 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2440 int git_config_get_pathname(const char *key
, const char **dest
)
2442 return repo_config_get_pathname(the_repository
, key
, dest
);
2445 int git_config_get_expiry(const char *key
, const char **output
)
2447 int ret
= git_config_get_string(key
, (char **)output
);
2450 if (strcmp(*output
, "now")) {
2451 timestamp_t now
= approxidate("now");
2452 if (approxidate(*output
) >= now
)
2453 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2458 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2460 const char *expiry_string
;
2464 if (git_config_get_string_tmp(key
, &expiry_string
))
2465 return 1; /* no such thing */
2467 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2468 const int scale
= 86400;
2469 *expiry
= now
- days
* scale
;
2473 if (!parse_expiry_date(expiry_string
, &when
)) {
2477 return -1; /* thing exists but cannot be parsed */
2480 int git_config_get_split_index(void)
2484 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2487 return -1; /* default value */
2490 int git_config_get_max_percent_split_change(void)
2494 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2495 if (0 <= val
&& val
<= 100)
2498 return error(_("splitIndex.maxPercentChange value '%d' "
2499 "should be between 0 and 100"), val
);
2502 return -1; /* default value */
2505 int git_config_get_fsmonitor(void)
2507 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor
))
2508 core_fsmonitor
= getenv("GIT_TEST_FSMONITOR");
2510 if (core_fsmonitor
&& !*core_fsmonitor
)
2511 core_fsmonitor
= NULL
;
2519 int git_config_get_index_threads(int *dest
)
2523 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2529 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2531 *dest
= val
? 0 : 1;
2541 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2544 die(_("unable to parse '%s' from command-line config"), key
);
2546 die(_("bad config variable '%s' in file '%s' at line %d"),
2547 key
, filename
, linenr
);
2550 NORETURN
__attribute__((format(printf
, 2, 3)))
2551 void git_die_config(const char *key
, const char *err
, ...)
2553 const struct string_list
*values
;
2554 struct key_value_info
*kv_info
;
2558 va_start(params
, err
);
2559 vreportf("error: ", err
, params
);
2562 values
= git_config_get_value_multi(key
);
2563 kv_info
= values
->items
[values
->nr
- 1].util
;
2564 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
2568 * Find all the stuff for git_config_set() below.
2571 struct config_store_data
{
2575 const char *fixed_value
;
2576 regex_t
*value_pattern
;
2580 enum config_event_t type
;
2581 int is_keys_section
;
2583 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
2584 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
2587 static void config_store_data_clear(struct config_store_data
*store
)
2590 if (store
->value_pattern
!= NULL
&&
2591 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
2592 regfree(store
->value_pattern
);
2593 free(store
->value_pattern
);
2595 free(store
->parsed
);
2597 memset(store
, 0, sizeof(*store
));
2600 static int matches(const char *key
, const char *value
,
2601 const struct config_store_data
*store
)
2603 if (strcmp(key
, store
->key
))
2604 return 0; /* not ours */
2605 if (store
->fixed_value
)
2606 return !strcmp(store
->fixed_value
, value
);
2607 if (!store
->value_pattern
)
2608 return 1; /* always matches */
2609 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
2610 return 0; /* never matches */
2612 return store
->do_not_match
^
2613 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
2616 static int store_aux_event(enum config_event_t type
,
2617 size_t begin
, size_t end
, void *data
)
2619 struct config_store_data
*store
= data
;
2621 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
2622 store
->parsed
[store
->parsed_nr
].begin
= begin
;
2623 store
->parsed
[store
->parsed_nr
].end
= end
;
2624 store
->parsed
[store
->parsed_nr
].type
= type
;
2626 if (type
== CONFIG_EVENT_SECTION
) {
2627 int (*cmpfn
)(const char *, const char *, size_t);
2629 if (cf
->var
.len
< 2 || cf
->var
.buf
[cf
->var
.len
- 1] != '.')
2630 return error(_("invalid section name '%s'"), cf
->var
.buf
);
2632 if (cf
->subsection_case_sensitive
)
2633 cmpfn
= strncasecmp
;
2637 /* Is this the section we were looking for? */
2638 store
->is_keys_section
=
2639 store
->parsed
[store
->parsed_nr
].is_keys_section
=
2640 cf
->var
.len
- 1 == store
->baselen
&&
2641 !cmpfn(cf
->var
.buf
, store
->key
, store
->baselen
);
2642 if (store
->is_keys_section
) {
2643 store
->section_seen
= 1;
2644 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2646 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2655 static int store_aux(const char *key
, const char *value
, void *cb
)
2657 struct config_store_data
*store
= cb
;
2659 if (store
->key_seen
) {
2660 if (matches(key
, value
, store
)) {
2661 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
2662 warning(_("%s has multiple values"), key
);
2665 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2668 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2671 } else if (store
->is_keys_section
) {
2673 * Do not increment matches yet: this may not be a match, but we
2674 * are in the desired section.
2676 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
2677 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2678 store
->section_seen
= 1;
2680 if (matches(key
, value
, store
)) {
2682 store
->key_seen
= 1;
2689 static int write_error(const char *filename
)
2691 error(_("failed to write new configuration file %s"), filename
);
2693 /* Same error code as "failed to rename". */
2697 static struct strbuf
store_create_section(const char *key
,
2698 const struct config_store_data
*store
)
2702 struct strbuf sb
= STRBUF_INIT
;
2704 dot
= memchr(key
, '.', store
->baselen
);
2706 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
2707 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
2708 if (key
[i
] == '"' || key
[i
] == '\\')
2709 strbuf_addch(&sb
, '\\');
2710 strbuf_addch(&sb
, key
[i
]);
2712 strbuf_addstr(&sb
, "\"]\n");
2714 strbuf_addch(&sb
, '[');
2715 strbuf_add(&sb
, key
, store
->baselen
);
2716 strbuf_addstr(&sb
, "]\n");
2722 static ssize_t
write_section(int fd
, const char *key
,
2723 const struct config_store_data
*store
)
2725 struct strbuf sb
= store_create_section(key
, store
);
2728 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2729 strbuf_release(&sb
);
2734 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
2735 const struct config_store_data
*store
)
2739 const char *quote
= "";
2740 struct strbuf sb
= STRBUF_INIT
;
2743 * Check to see if the value needs to be surrounded with a dq pair.
2744 * Note that problematic characters are always backslash-quoted; this
2745 * check is about not losing leading or trailing SP and strings that
2746 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2747 * configuration parser.
2749 if (value
[0] == ' ')
2751 for (i
= 0; value
[i
]; i
++)
2752 if (value
[i
] == ';' || value
[i
] == '#')
2754 if (i
&& value
[i
- 1] == ' ')
2757 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
2759 for (i
= 0; value
[i
]; i
++)
2762 strbuf_addstr(&sb
, "\\n");
2765 strbuf_addstr(&sb
, "\\t");
2769 strbuf_addch(&sb
, '\\');
2772 strbuf_addch(&sb
, value
[i
]);
2775 strbuf_addf(&sb
, "%s\n", quote
);
2777 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
2778 strbuf_release(&sb
);
2784 * If we are about to unset the last key(s) in a section, and if there are
2785 * no comments surrounding (or included in) the section, we will want to
2786 * extend begin/end to remove the entire section.
2788 * Note: the parameter `seen_ptr` points to the index into the store.seen
2789 * array. * This index may be incremented if a section has more than one
2790 * entry (which all are to be removed).
2792 static void maybe_remove_section(struct config_store_data
*store
,
2793 size_t *begin_offset
, size_t *end_offset
,
2797 int i
, seen
, section_seen
= 0;
2800 * First, ensure that this is the first key, and that there are no
2801 * comments before the entry nor before the section header.
2804 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
2805 enum config_event_t type
= store
->parsed
[i
- 1].type
;
2807 if (type
== CONFIG_EVENT_COMMENT
)
2808 /* There is a comment before this entry or section */
2810 if (type
== CONFIG_EVENT_ENTRY
) {
2812 /* This is not the section's first entry. */
2814 /* We encountered no comment before the section. */
2817 if (type
== CONFIG_EVENT_SECTION
) {
2818 if (!store
->parsed
[i
- 1].is_keys_section
)
2823 begin
= store
->parsed
[i
].begin
;
2826 * Next, make sure that we are removing the last key(s) in the section,
2827 * and that there are no comments that are possibly about the current
2830 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
2831 enum config_event_t type
= store
->parsed
[i
].type
;
2833 if (type
== CONFIG_EVENT_COMMENT
)
2835 if (type
== CONFIG_EVENT_SECTION
) {
2836 if (store
->parsed
[i
].is_keys_section
)
2840 if (type
== CONFIG_EVENT_ENTRY
) {
2841 if (++seen
< store
->seen_nr
&&
2842 i
== store
->seen
[seen
])
2843 /* We want to remove this entry, too */
2845 /* There is another entry in this section. */
2851 * We are really removing the last entry/entries from this section, and
2852 * there are no enclosed or surrounding comments. Remove the entire,
2853 * now-empty section.
2856 *begin_offset
= begin
;
2857 if (i
< store
->parsed_nr
)
2858 *end_offset
= store
->parsed
[i
].begin
;
2860 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
2863 int git_config_set_in_file_gently(const char *config_filename
,
2864 const char *key
, const char *value
)
2866 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
2869 void git_config_set_in_file(const char *config_filename
,
2870 const char *key
, const char *value
)
2872 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
2875 int git_config_set_gently(const char *key
, const char *value
)
2877 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
2880 void git_config_set(const char *key
, const char *value
)
2882 git_config_set_multivar(key
, value
, NULL
, 0);
2884 trace2_cmd_set_config(key
, value
);
2888 * If value==NULL, unset in (remove from) config,
2889 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2890 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2891 * (only add a new one)
2892 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2893 * key/values are removed before a single new pair is written. If the
2894 * flag is not present, then replace only the first match.
2896 * Returns 0 on success.
2898 * This function does this:
2900 * - it locks the config file by creating ".git/config.lock"
2902 * - it then parses the config using store_aux() as validator to find
2903 * the position on the key/value pair to replace. If it is to be unset,
2904 * it must be found exactly once.
2906 * - the config file is mmap()ed and the part before the match (if any) is
2907 * written to the lock file, then the changed part and the rest.
2909 * - the config file is removed and the lock file rename()d to it.
2912 int git_config_set_multivar_in_file_gently(const char *config_filename
,
2913 const char *key
, const char *value
,
2914 const char *value_pattern
,
2917 int fd
= -1, in_fd
= -1;
2919 struct lock_file lock
= LOCK_INIT
;
2920 char *filename_buf
= NULL
;
2921 char *contents
= NULL
;
2923 struct config_store_data store
;
2925 memset(&store
, 0, sizeof(store
));
2927 /* parse-key returns negative; flip the sign to feed exit(3) */
2928 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
2932 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
2934 if (!config_filename
)
2935 config_filename
= filename_buf
= git_pathdup("config");
2938 * The lock serves a purpose in addition to locking: the new
2939 * contents of .git/config will be written into it.
2941 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
2943 error_errno(_("could not lock config file %s"), config_filename
);
2944 ret
= CONFIG_NO_LOCK
;
2949 * If .git/config does not exist yet, write a minimal version.
2951 in_fd
= open(config_filename
, O_RDONLY
);
2953 if ( ENOENT
!= errno
) {
2954 error_errno(_("opening %s"), config_filename
);
2955 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
2958 /* if nothing to unset, error out */
2959 if (value
== NULL
) {
2960 ret
= CONFIG_NOTHING_SET
;
2965 store
.key
= xstrdup(key
);
2966 if (write_section(fd
, key
, &store
) < 0 ||
2967 write_pair(fd
, key
, value
, &store
) < 0)
2971 size_t copy_begin
, copy_end
;
2972 int i
, new_line
= 0;
2973 struct config_options opts
;
2975 if (value_pattern
== NULL
)
2976 store
.value_pattern
= NULL
;
2977 else if (value_pattern
== CONFIG_REGEX_NONE
)
2978 store
.value_pattern
= CONFIG_REGEX_NONE
;
2979 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
2980 store
.fixed_value
= value_pattern
;
2982 if (value_pattern
[0] == '!') {
2983 store
.do_not_match
= 1;
2986 store
.do_not_match
= 0;
2988 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
2989 if (regcomp(store
.value_pattern
, value_pattern
,
2991 error(_("invalid pattern: %s"), value_pattern
);
2992 FREE_AND_NULL(store
.value_pattern
);
2993 ret
= CONFIG_INVALID_PATTERN
;
2998 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
2999 store
.parsed
[0].end
= 0;
3001 memset(&opts
, 0, sizeof(opts
));
3002 opts
.event_fn
= store_aux_event
;
3003 opts
.event_fn_data
= &store
;
3006 * After this, store.parsed will contain offsets of all the
3007 * parsed elements, and store.seen will contain a list of
3008 * matches, as indices into store.parsed.
3010 * As a side effect, we make sure to transform only a valid
3011 * existing config file.
3013 if (git_config_from_file_with_options(store_aux
,
3016 error(_("invalid config file %s"), config_filename
);
3017 ret
= CONFIG_INVALID_FILE
;
3021 /* if nothing to unset, or too many matches, error out */
3022 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3023 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3024 ret
= CONFIG_NOTHING_SET
;
3028 if (fstat(in_fd
, &st
) == -1) {
3029 error_errno(_("fstat on %s failed"), config_filename
);
3030 ret
= CONFIG_INVALID_FILE
;
3034 contents_sz
= xsize_t(st
.st_size
);
3035 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3036 MAP_PRIVATE
, in_fd
, 0);
3037 if (contents
== MAP_FAILED
) {
3038 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3040 error_errno(_("unable to mmap '%s'%s"),
3041 config_filename
, mmap_os_err());
3042 ret
= CONFIG_INVALID_FILE
;
3049 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3050 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3051 ret
= CONFIG_NO_WRITE
;
3055 if (store
.seen_nr
== 0) {
3056 if (!store
.seen_alloc
) {
3057 /* Did not see key nor section */
3058 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3059 store
.seen
[0] = store
.parsed_nr
3060 - !!store
.parsed_nr
;
3065 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3067 int j
= store
.seen
[i
];
3070 if (!store
.key_seen
) {
3071 copy_end
= store
.parsed
[j
].end
;
3072 /* include '\n' when copying section header */
3073 if (copy_end
> 0 && copy_end
< contents_sz
&&
3074 contents
[copy_end
- 1] != '\n' &&
3075 contents
[copy_end
] == '\n')
3077 replace_end
= copy_end
;
3079 replace_end
= store
.parsed
[j
].end
;
3080 copy_end
= store
.parsed
[j
].begin
;
3082 maybe_remove_section(&store
,
3086 * Swallow preceding white-space on the same
3089 while (copy_end
> 0 ) {
3090 char c
= contents
[copy_end
- 1];
3092 if (isspace(c
) && c
!= '\n')
3099 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3102 /* write the first part of the config */
3103 if (copy_end
> copy_begin
) {
3104 if (write_in_full(fd
, contents
+ copy_begin
,
3105 copy_end
- copy_begin
) < 0)
3108 write_str_in_full(fd
, "\n") < 0)
3111 copy_begin
= replace_end
;
3114 /* write the pair (value == NULL means unset) */
3115 if (value
!= NULL
) {
3116 if (!store
.section_seen
) {
3117 if (write_section(fd
, key
, &store
) < 0)
3120 if (write_pair(fd
, key
, value
, &store
) < 0)
3124 /* write the rest of the config */
3125 if (copy_begin
< contents_sz
)
3126 if (write_in_full(fd
, contents
+ copy_begin
,
3127 contents_sz
- copy_begin
) < 0)
3130 munmap(contents
, contents_sz
);
3134 if (commit_lock_file(&lock
) < 0) {
3135 error_errno(_("could not write config file %s"), config_filename
);
3136 ret
= CONFIG_NO_WRITE
;
3142 /* Invalidate the config cache */
3146 rollback_lock_file(&lock
);
3149 munmap(contents
, contents_sz
);
3152 config_store_data_clear(&store
);
3156 ret
= write_error(get_lock_file_path(&lock
));
3161 void git_config_set_multivar_in_file(const char *config_filename
,
3162 const char *key
, const char *value
,
3163 const char *value_pattern
, unsigned flags
)
3165 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3166 value_pattern
, flags
))
3169 die(_("could not set '%s' to '%s'"), key
, value
);
3171 die(_("could not unset '%s'"), key
);
3174 int git_config_set_multivar_gently(const char *key
, const char *value
,
3175 const char *value_pattern
, unsigned flags
)
3177 return git_config_set_multivar_in_file_gently(NULL
, key
, value
, value_pattern
,
3181 void git_config_set_multivar(const char *key
, const char *value
,
3182 const char *value_pattern
, unsigned flags
)
3184 git_config_set_multivar_in_file(NULL
, key
, value
, value_pattern
,
3188 static int section_name_match (const char *buf
, const char *name
)
3190 int i
= 0, j
= 0, dot
= 0;
3193 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3194 if (!dot
&& isspace(buf
[i
])) {
3196 if (name
[j
++] != '.')
3198 for (i
++; isspace(buf
[i
]); i
++)
3204 if (buf
[i
] == '\\' && dot
)
3206 else if (buf
[i
] == '"' && dot
) {
3207 for (i
++; isspace(buf
[i
]); i
++)
3211 if (buf
[i
] != name
[j
++])
3214 if (buf
[i
] == ']' && name
[j
] == 0) {
3216 * We match, now just find the right length offset by
3217 * gobbling up any whitespace after it, as well
3220 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3227 static int section_name_is_ok(const char *name
)
3229 /* Empty section names are bogus. */
3234 * Before a dot, we must be alphanumeric or dash. After the first dot,
3235 * anything goes, so we can stop checking.
3237 for (; *name
&& *name
!= '.'; name
++)
3238 if (*name
!= '-' && !isalnum(*name
))
3243 /* if new_name == NULL, the section is removed instead */
3244 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3245 const char *old_name
,
3246 const char *new_name
, int copy
)
3248 int ret
= 0, remove
= 0;
3249 char *filename_buf
= NULL
;
3250 struct lock_file lock
= LOCK_INIT
;
3253 FILE *config_file
= NULL
;
3255 struct strbuf copystr
= STRBUF_INIT
;
3256 struct config_store_data store
;
3258 memset(&store
, 0, sizeof(store
));
3260 if (new_name
&& !section_name_is_ok(new_name
)) {
3261 ret
= error(_("invalid section name: %s"), new_name
);
3262 goto out_no_rollback
;
3265 if (!config_filename
)
3266 config_filename
= filename_buf
= git_pathdup("config");
3268 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3270 ret
= error(_("could not lock config file %s"), config_filename
);
3274 if (!(config_file
= fopen(config_filename
, "rb"))) {
3275 ret
= warn_on_fopen_errors(config_filename
);
3278 /* no config file means nothing to rename, no error */
3279 goto commit_and_out
;
3282 if (fstat(fileno(config_file
), &st
) == -1) {
3283 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3287 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3288 ret
= error_errno(_("chmod on %s failed"),
3289 get_lock_file_path(&lock
));
3293 while (fgets(buf
, sizeof(buf
), config_file
)) {
3298 for (i
= 0; buf
[i
] && isspace(buf
[i
]); i
++)
3300 if (buf
[i
] == '[') {
3301 /* it's a section */
3306 * When encountering a new section under -c we
3307 * need to flush out any section we're already
3308 * coping and begin anew. There might be
3309 * multiple [branch "$name"] sections.
3311 if (copystr
.len
> 0) {
3312 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3313 ret
= write_error(get_lock_file_path(&lock
));
3316 strbuf_reset(©str
);
3319 offset
= section_name_match(&buf
[i
], old_name
);
3322 if (new_name
== NULL
) {
3326 store
.baselen
= strlen(new_name
);
3328 if (write_section(out_fd
, new_name
, &store
) < 0) {
3329 ret
= write_error(get_lock_file_path(&lock
));
3333 * We wrote out the new section, with
3334 * a newline, now skip the old
3337 output
+= offset
+ i
;
3338 if (strlen(output
) > 0) {
3340 * More content means there's
3341 * a declaration to put on the
3342 * next line; indent with a
3349 copystr
= store_create_section(new_name
, &store
);
3356 length
= strlen(output
);
3358 if (!is_section
&& copystr
.len
> 0) {
3359 strbuf_add(©str
, output
, length
);
3362 if (write_in_full(out_fd
, output
, length
) < 0) {
3363 ret
= write_error(get_lock_file_path(&lock
));
3369 * Copy a trailing section at the end of the config, won't be
3370 * flushed by the usual "flush because we have a new section
3371 * logic in the loop above.
3373 if (copystr
.len
> 0) {
3374 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3375 ret
= write_error(get_lock_file_path(&lock
));
3378 strbuf_reset(©str
);
3381 fclose(config_file
);
3384 if (commit_lock_file(&lock
) < 0)
3385 ret
= error_errno(_("could not write config file %s"),
3389 fclose(config_file
);
3390 rollback_lock_file(&lock
);
3393 config_store_data_clear(&store
);
3397 int git_config_rename_section_in_file(const char *config_filename
,
3398 const char *old_name
, const char *new_name
)
3400 return git_config_copy_or_rename_section_in_file(config_filename
,
3401 old_name
, new_name
, 0);
3404 int git_config_rename_section(const char *old_name
, const char *new_name
)
3406 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
3409 int git_config_copy_section_in_file(const char *config_filename
,
3410 const char *old_name
, const char *new_name
)
3412 return git_config_copy_or_rename_section_in_file(config_filename
,
3413 old_name
, new_name
, 1);
3416 int git_config_copy_section(const char *old_name
, const char *new_name
)
3418 return git_config_copy_section_in_file(NULL
, old_name
, new_name
);
3422 * Call this to report error for your variable that should not
3423 * get a boolean value (i.e. "[my] var" means "true").
3425 #undef config_error_nonbool
3426 int config_error_nonbool(const char *var
)
3428 return error(_("missing value for '%s'"), var
);
3431 int parse_config_key(const char *var
,
3432 const char *section
,
3433 const char **subsection
, size_t *subsection_len
,
3438 /* Does it start with "section." ? */
3439 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
3443 * Find the key; we don't know yet if we have a subsection, but we must
3444 * parse backwards from the end, since the subsection may have dots in
3447 dot
= strrchr(var
, '.');
3450 /* Did we have a subsection at all? */
3454 *subsection_len
= 0;
3460 *subsection
= var
+ 1;
3461 *subsection_len
= dot
- *subsection
;
3467 const char *current_config_origin_type(void)
3470 if (current_config_kvi
)
3471 type
= current_config_kvi
->origin_type
;
3473 type
= cf
->origin_type
;
3475 BUG("current_config_origin_type called outside config callback");
3478 case CONFIG_ORIGIN_BLOB
:
3480 case CONFIG_ORIGIN_FILE
:
3482 case CONFIG_ORIGIN_STDIN
:
3483 return "standard input";
3484 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
3485 return "submodule-blob";
3486 case CONFIG_ORIGIN_CMDLINE
:
3487 return "command line";
3489 BUG("unknown config origin type");
3493 const char *config_scope_name(enum config_scope scope
)
3496 case CONFIG_SCOPE_SYSTEM
:
3498 case CONFIG_SCOPE_GLOBAL
:
3500 case CONFIG_SCOPE_LOCAL
:
3502 case CONFIG_SCOPE_WORKTREE
:
3504 case CONFIG_SCOPE_COMMAND
:
3506 case CONFIG_SCOPE_SUBMODULE
:
3513 const char *current_config_name(void)
3516 if (current_config_kvi
)
3517 name
= current_config_kvi
->filename
;
3521 BUG("current_config_name called outside config callback");
3522 return name
? name
: "";
3525 enum config_scope
current_config_scope(void)
3527 if (current_config_kvi
)
3528 return current_config_kvi
->scope
;
3530 return current_parsing_scope
;
3533 int current_config_line(void)
3535 if (current_config_kvi
)
3536 return current_config_kvi
->linenr
;
3541 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
)
3545 for (i
= 0; i
< nr_mapping
; i
++) {
3546 const char *name
= mapping
[i
];
3548 if (name
&& !strcasecmp(var
, name
))