2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
8 #include "git-compat-util.h"
16 #include "environment.h"
19 #include "repository.h"
26 #include "string-list.h"
27 #include "object-name.h"
28 #include "object-store.h"
33 #include "replace-object.h"
40 #include "write-or-die.h"
42 struct config_source
{
43 struct config_source
*prev
;
52 enum config_origin_type origin_type
;
55 enum config_error_action default_error_action
;
61 unsigned subsection_case_sensitive
: 1;
63 int (*do_fgetc
)(struct config_source
*c
);
64 int (*do_ungetc
)(int c
, struct config_source
*conf
);
65 long (*do_ftell
)(struct config_source
*c
);
67 #define CONFIG_SOURCE_INIT { 0 }
69 struct config_reader
{
71 * These members record the "current" config source, which can be
72 * accessed by parsing callbacks.
74 * The "source" variable will be non-NULL only when we are actually
75 * parsing a real config source (file, blob, cmdline, etc).
77 struct config_source
*source
;
80 * Where possible, prefer to accept "struct config_reader" as an arg than to use
81 * "the_reader". "the_reader" should only be used if that is infeasible, e.g. in
84 static struct config_reader the_reader
;
86 static inline void config_reader_push_source(struct config_reader
*reader
,
87 struct config_source
*top
)
89 top
->prev
= reader
->source
;
93 static inline struct config_source
*config_reader_pop_source(struct config_reader
*reader
)
95 struct config_source
*ret
;
97 BUG("tried to pop config source, but we weren't reading config");
99 reader
->source
= reader
->source
->prev
;
103 static int pack_compression_seen
;
104 static int zlib_compression_seen
;
107 * Config that comes from trusted scopes, namely:
108 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
109 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
110 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
112 * This is declared here for code cleanliness, but unlike the other
113 * static variables, this does not hold config parser state.
115 static struct config_set protected_config
;
117 static int config_file_fgetc(struct config_source
*conf
)
119 return getc_unlocked(conf
->u
.file
);
122 static int config_file_ungetc(int c
, struct config_source
*conf
)
124 return ungetc(c
, conf
->u
.file
);
127 static long config_file_ftell(struct config_source
*conf
)
129 return ftell(conf
->u
.file
);
133 static int config_buf_fgetc(struct config_source
*conf
)
135 if (conf
->u
.buf
.pos
< conf
->u
.buf
.len
)
136 return conf
->u
.buf
.buf
[conf
->u
.buf
.pos
++];
141 static int config_buf_ungetc(int c
, struct config_source
*conf
)
143 if (conf
->u
.buf
.pos
> 0) {
145 if (conf
->u
.buf
.buf
[conf
->u
.buf
.pos
] != c
)
146 BUG("config_buf can only ungetc the same character");
153 static long config_buf_ftell(struct config_source
*conf
)
155 return conf
->u
.buf
.pos
;
158 struct config_include_data
{
162 const struct config_options
*opts
;
163 struct git_config_source
*config_source
;
164 struct repository
*repo
;
167 * All remote URLs discovered when reading all config files.
169 struct string_list
*remote_urls
;
171 #define CONFIG_INCLUDE_INIT { 0 }
173 static int git_config_include(const char *var
, const char *value
,
174 const struct config_context
*ctx
, void *data
);
176 #define MAX_INCLUDE_DEPTH 10
177 static const char include_depth_advice
[] = N_(
178 "exceeded maximum include depth (%d) while including\n"
182 "This might be due to circular includes.");
183 static int handle_path_include(const struct key_value_info
*kvi
,
185 struct config_include_data
*inc
)
188 struct strbuf buf
= STRBUF_INIT
;
192 return config_error_nonbool("include.path");
194 expanded
= interpolate_path(path
, 0);
196 return error(_("could not expand include path '%s'"), path
);
200 * Use an absolute path as-is, but interpret relative paths
201 * based on the including config file.
203 if (!is_absolute_path(path
)) {
206 if (!kvi
|| !kvi
->path
) {
207 ret
= error(_("relative config includes must come from files"));
211 slash
= find_last_dir_sep(kvi
->path
);
213 strbuf_add(&buf
, kvi
->path
, slash
- kvi
->path
+ 1);
214 strbuf_addstr(&buf
, path
);
218 if (!access_or_die(path
, R_OK
, 0)) {
219 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
220 die(_(include_depth_advice
), MAX_INCLUDE_DEPTH
, path
,
222 kvi
->filename
? kvi
->filename
:
224 ret
= git_config_from_file_with_options(git_config_include
, path
, inc
,
229 strbuf_release(&buf
);
234 static void add_trailing_starstar_for_dir(struct strbuf
*pat
)
236 if (pat
->len
&& is_dir_sep(pat
->buf
[pat
->len
- 1]))
237 strbuf_addstr(pat
, "**");
240 static int prepare_include_condition_pattern(const struct key_value_info
*kvi
,
243 struct strbuf path
= STRBUF_INIT
;
247 expanded
= interpolate_path(pat
->buf
, 1);
250 strbuf_addstr(pat
, expanded
);
254 if (pat
->buf
[0] == '.' && is_dir_sep(pat
->buf
[1])) {
257 if (!kvi
|| !kvi
->path
)
258 return error(_("relative config include "
259 "conditionals must come from files"));
261 strbuf_realpath(&path
, kvi
->path
, 1);
262 slash
= find_last_dir_sep(path
.buf
);
264 BUG("how is this possible?");
265 strbuf_splice(pat
, 0, 1, path
.buf
, slash
- path
.buf
);
266 prefix
= slash
- path
.buf
+ 1 /* slash */;
267 } else if (!is_absolute_path(pat
->buf
))
268 strbuf_insertstr(pat
, 0, "**/");
270 add_trailing_starstar_for_dir(pat
);
272 strbuf_release(&path
);
276 static int include_by_gitdir(const struct key_value_info
*kvi
,
277 const struct config_options
*opts
,
278 const char *cond
, size_t cond_len
, int icase
)
280 struct strbuf text
= STRBUF_INIT
;
281 struct strbuf pattern
= STRBUF_INIT
;
284 int already_tried_absolute
= 0;
287 git_dir
= opts
->git_dir
;
291 strbuf_realpath(&text
, git_dir
, 1);
292 strbuf_add(&pattern
, cond
, cond_len
);
293 prefix
= prepare_include_condition_pattern(kvi
, &pattern
);
301 * perform literal matching on the prefix part so that
302 * any wildcard character in it can't create side effects.
304 if (text
.len
< prefix
)
306 if (!icase
&& strncmp(pattern
.buf
, text
.buf
, prefix
))
308 if (icase
&& strncasecmp(pattern
.buf
, text
.buf
, prefix
))
312 ret
= !wildmatch(pattern
.buf
+ prefix
, text
.buf
+ prefix
,
313 WM_PATHNAME
| (icase
? WM_CASEFOLD
: 0));
315 if (!ret
&& !already_tried_absolute
) {
317 * We've tried e.g. matching gitdir:~/work, but if
318 * ~/work is a symlink to /mnt/storage/work
319 * strbuf_realpath() will expand it, so the rule won't
320 * match. Let's match against a
321 * strbuf_add_absolute_path() version of the path,
322 * which'll do the right thing
325 strbuf_add_absolute_path(&text
, git_dir
);
326 already_tried_absolute
= 1;
330 strbuf_release(&pattern
);
331 strbuf_release(&text
);
335 static int include_by_branch(const char *cond
, size_t cond_len
)
339 struct strbuf pattern
= STRBUF_INIT
;
340 const char *refname
= !the_repository
->gitdir
?
341 NULL
: resolve_ref_unsafe("HEAD", 0, NULL
, &flags
);
342 const char *shortname
;
344 if (!refname
|| !(flags
& REF_ISSYMREF
) ||
345 !skip_prefix(refname
, "refs/heads/", &shortname
))
348 strbuf_add(&pattern
, cond
, cond_len
);
349 add_trailing_starstar_for_dir(&pattern
);
350 ret
= !wildmatch(pattern
.buf
, shortname
, WM_PATHNAME
);
351 strbuf_release(&pattern
);
355 static int add_remote_url(const char *var
, const char *value
,
356 const struct config_context
*ctx UNUSED
, void *data
)
358 struct string_list
*remote_urls
= data
;
359 const char *remote_name
;
360 size_t remote_name_len
;
363 if (!parse_config_key(var
, "remote", &remote_name
, &remote_name_len
,
367 string_list_append(remote_urls
, value
);
371 static void populate_remote_urls(struct config_include_data
*inc
)
373 struct config_options opts
;
376 opts
.unconditional_remote_url
= 1;
378 inc
->remote_urls
= xmalloc(sizeof(*inc
->remote_urls
));
379 string_list_init_dup(inc
->remote_urls
);
380 config_with_options(add_remote_url
, inc
->remote_urls
,
381 inc
->config_source
, inc
->repo
, &opts
);
384 static int forbid_remote_url(const char *var
, const char *value UNUSED
,
385 const struct config_context
*ctx UNUSED
,
388 const char *remote_name
;
389 size_t remote_name_len
;
392 if (!parse_config_key(var
, "remote", &remote_name
, &remote_name_len
,
396 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
400 static int at_least_one_url_matches_glob(const char *glob
, int glob_len
,
401 struct string_list
*remote_urls
)
403 struct strbuf pattern
= STRBUF_INIT
;
404 struct string_list_item
*url_item
;
407 strbuf_add(&pattern
, glob
, glob_len
);
408 for_each_string_list_item(url_item
, remote_urls
) {
409 if (!wildmatch(pattern
.buf
, url_item
->string
, WM_PATHNAME
)) {
414 strbuf_release(&pattern
);
418 static int include_by_remote_url(struct config_include_data
*inc
,
419 const char *cond
, size_t cond_len
)
421 if (inc
->opts
->unconditional_remote_url
)
423 if (!inc
->remote_urls
)
424 populate_remote_urls(inc
);
425 return at_least_one_url_matches_glob(cond
, cond_len
,
429 static int include_condition_is_true(const struct key_value_info
*kvi
,
430 struct config_include_data
*inc
,
431 const char *cond
, size_t cond_len
)
433 const struct config_options
*opts
= inc
->opts
;
435 if (skip_prefix_mem(cond
, cond_len
, "gitdir:", &cond
, &cond_len
))
436 return include_by_gitdir(kvi
, opts
, cond
, cond_len
, 0);
437 else if (skip_prefix_mem(cond
, cond_len
, "gitdir/i:", &cond
, &cond_len
))
438 return include_by_gitdir(kvi
, opts
, cond
, cond_len
, 1);
439 else if (skip_prefix_mem(cond
, cond_len
, "onbranch:", &cond
, &cond_len
))
440 return include_by_branch(cond
, cond_len
);
441 else if (skip_prefix_mem(cond
, cond_len
, "hasconfig:remote.*.url:", &cond
,
443 return include_by_remote_url(inc
, cond
, cond_len
);
445 /* unknown conditionals are always false */
449 static int git_config_include(const char *var
, const char *value
,
450 const struct config_context
*ctx
,
453 struct config_include_data
*inc
= data
;
454 const char *cond
, *key
;
459 * Pass along all values, including "include" directives; this makes it
460 * possible to query information on the includes themselves.
462 ret
= inc
->fn(var
, value
, ctx
, inc
->data
);
466 if (!strcmp(var
, "include.path"))
467 ret
= handle_path_include(ctx
->kvi
, value
, inc
);
469 if (!parse_config_key(var
, "includeif", &cond
, &cond_len
, &key
) &&
470 cond
&& include_condition_is_true(ctx
->kvi
, inc
, cond
, cond_len
) &&
471 !strcmp(key
, "path")) {
472 config_fn_t old_fn
= inc
->fn
;
474 if (inc
->opts
->unconditional_remote_url
)
475 inc
->fn
= forbid_remote_url
;
476 ret
= handle_path_include(ctx
->kvi
, value
, inc
);
483 static void git_config_push_split_parameter(const char *key
, const char *value
)
485 struct strbuf env
= STRBUF_INIT
;
486 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
488 strbuf_addstr(&env
, old
);
489 strbuf_addch(&env
, ' ');
491 sq_quote_buf(&env
, key
);
492 strbuf_addch(&env
, '=');
494 sq_quote_buf(&env
, value
);
495 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
496 strbuf_release(&env
);
499 void git_config_push_parameter(const char *text
)
506 * section.subsection=with=equals.key=value
508 * we cannot tell if it means:
510 * [section "subsection=with=equals"]
516 * subsection = with=equals.key=value
518 * We parse left-to-right for the first "=", meaning we'll prefer to
519 * keep the value intact over the subsection. This is historical, but
520 * also sensible since values are more likely to contain odd or
521 * untrusted input than a section name.
523 * A missing equals is explicitly allowed (as a bool-only entry).
525 value
= strchr(text
, '=');
527 char *key
= xmemdupz(text
, value
- text
);
528 git_config_push_split_parameter(key
, value
+ 1);
531 git_config_push_split_parameter(text
, NULL
);
535 void git_config_push_env(const char *spec
)
538 const char *env_name
;
539 const char *env_value
;
541 env_name
= strrchr(spec
, '=');
543 die(_("invalid config format: %s"), spec
);
544 key
= xmemdupz(spec
, env_name
- spec
);
547 die(_("missing environment variable name for configuration '%.*s'"),
548 (int)(env_name
- spec
- 1), spec
);
550 env_value
= getenv(env_name
);
552 die(_("missing environment variable '%s' for configuration '%.*s'"),
553 env_name
, (int)(env_name
- spec
- 1), spec
);
555 git_config_push_split_parameter(key
, env_value
);
559 static inline int iskeychar(int c
)
561 return isalnum(c
) || c
== '-';
565 * Auxiliary function to sanity-check and split the key into the section
566 * identifier and variable name.
568 * Returns 0 on success, -1 when there is an invalid character in the key and
569 * -2 if there is no section name in the key.
571 * store_key - pointer to char* which will hold a copy of the key with
572 * lowercase section and variable name
573 * baselen - pointer to size_t which will hold the length of the
574 * section + subsection part, can be NULL
576 int git_config_parse_key(const char *key
, char **store_key
, size_t *baselen_
)
580 const char *last_dot
= strrchr(key
, '.');
583 * Since "key" actually contains the section name and the real
584 * key name separated by a dot, we have to know where the dot is.
587 if (last_dot
== NULL
|| last_dot
== key
) {
588 error(_("key does not contain a section: %s"), key
);
589 return -CONFIG_NO_SECTION_OR_NAME
;
593 error(_("key does not contain variable name: %s"), key
);
594 return -CONFIG_NO_SECTION_OR_NAME
;
597 baselen
= last_dot
- key
;
602 * Validate the key and while at it, lower case it for matching.
604 *store_key
= xmallocz(strlen(key
));
607 for (i
= 0; key
[i
]; i
++) {
608 unsigned char c
= key
[i
];
611 /* Leave the extended basename untouched.. */
612 if (!dot
|| i
> baselen
) {
614 (i
== baselen
+ 1 && !isalpha(c
))) {
615 error(_("invalid key: %s"), key
);
619 } else if (c
== '\n') {
620 error(_("invalid key (newline): %s"), key
);
629 FREE_AND_NULL(*store_key
);
630 return -CONFIG_INVALID_KEY
;
633 static int config_parse_pair(const char *key
, const char *value
,
634 struct key_value_info
*kvi
,
635 config_fn_t fn
, void *data
)
637 char *canonical_name
;
639 struct config_context ctx
= {
644 return error(_("empty config key"));
645 if (git_config_parse_key(key
, &canonical_name
, NULL
))
648 ret
= (fn(canonical_name
, value
, &ctx
, data
) < 0) ? -1 : 0;
649 free(canonical_name
);
654 /* for values read from `git_config_from_parameters()` */
655 void kvi_from_param(struct key_value_info
*out
)
657 out
->filename
= NULL
;
659 out
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
660 out
->scope
= CONFIG_SCOPE_COMMAND
;
664 int git_config_parse_parameter(const char *text
,
665 config_fn_t fn
, void *data
)
668 struct strbuf
**pair
;
670 struct key_value_info kvi
= KVI_INIT
;
672 kvi_from_param(&kvi
);
674 pair
= strbuf_split_str(text
, '=', 2);
676 return error(_("bogus config parameter: %s"), text
);
678 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
679 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
680 value
= pair
[1] ? pair
[1]->buf
: "";
685 strbuf_trim(pair
[0]);
687 strbuf_list_free(pair
);
688 return error(_("bogus config parameter: %s"), text
);
691 ret
= config_parse_pair(pair
[0]->buf
, value
, &kvi
, fn
, data
);
692 strbuf_list_free(pair
);
696 static int parse_config_env_list(char *env
, struct key_value_info
*kvi
,
697 config_fn_t fn
, void *data
)
700 while (cur
&& *cur
) {
701 const char *key
= sq_dequote_step(cur
, &cur
);
703 return error(_("bogus format in %s"),
704 CONFIG_DATA_ENVIRONMENT
);
706 if (!cur
|| isspace(*cur
)) {
707 /* old-style 'key=value' */
708 if (git_config_parse_parameter(key
, fn
, data
) < 0)
711 else if (*cur
== '=') {
712 /* new-style 'key'='value' */
718 value
= sq_dequote_step(cur
, &cur
);
719 if (!value
|| (cur
&& !isspace(*cur
))) {
720 return error(_("bogus format in %s"),
721 CONFIG_DATA_ENVIRONMENT
);
723 } else if (!*cur
|| isspace(*cur
)) {
724 /* implicit bool: 'key'= */
727 return error(_("bogus format in %s"),
728 CONFIG_DATA_ENVIRONMENT
);
731 if (config_parse_pair(key
, value
, kvi
, fn
, data
) < 0)
736 return error(_("bogus format in %s"),
737 CONFIG_DATA_ENVIRONMENT
);
741 while (isspace(*cur
))
748 int git_config_from_parameters(config_fn_t fn
, void *data
)
751 struct strbuf envvar
= STRBUF_INIT
;
752 struct strvec to_free
= STRVEC_INIT
;
755 struct config_source source
= CONFIG_SOURCE_INIT
;
756 struct key_value_info kvi
= KVI_INIT
;
758 source
.origin_type
= CONFIG_ORIGIN_CMDLINE
;
759 config_reader_push_source(&the_reader
, &source
);
761 kvi_from_param(&kvi
);
763 env
= getenv(CONFIG_COUNT_ENVIRONMENT
);
769 count
= strtoul(env
, &endp
, 10);
771 ret
= error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT
);
774 if (count
> INT_MAX
) {
775 ret
= error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT
);
779 for (i
= 0; i
< count
; i
++) {
780 const char *key
, *value
;
782 strbuf_addf(&envvar
, "GIT_CONFIG_KEY_%d", i
);
783 key
= getenv_safe(&to_free
, envvar
.buf
);
785 ret
= error(_("missing config key %s"), envvar
.buf
);
788 strbuf_reset(&envvar
);
790 strbuf_addf(&envvar
, "GIT_CONFIG_VALUE_%d", i
);
791 value
= getenv_safe(&to_free
, envvar
.buf
);
793 ret
= error(_("missing config value %s"), envvar
.buf
);
796 strbuf_reset(&envvar
);
798 if (config_parse_pair(key
, value
, &kvi
, fn
, data
) < 0) {
805 env
= getenv(CONFIG_DATA_ENVIRONMENT
);
807 /* sq_dequote will write over it */
809 if (parse_config_env_list(envw
, &kvi
, fn
, data
) < 0) {
816 strbuf_release(&envvar
);
817 strvec_clear(&to_free
);
819 config_reader_pop_source(&the_reader
);
823 static int get_next_char(struct config_source
*cs
)
825 int c
= cs
->do_fgetc(cs
);
828 /* DOS like systems */
829 c
= cs
->do_fgetc(cs
);
832 cs
->do_ungetc(c
, cs
);
837 if (c
!= EOF
&& ++cs
->total_len
> INT_MAX
) {
839 * This is an absurdly long config file; refuse to parse
840 * further in order to protect downstream code from integer
841 * overflows. Note that we can't return an error specifically,
842 * but we can mark EOF and put trash in the return value,
843 * which will trigger a parse error.
859 static char *parse_value(struct config_source
*cs
)
861 int quote
= 0, comment
= 0, space
= 0;
863 strbuf_reset(&cs
->value
);
865 int c
= get_next_char(cs
);
871 return cs
->value
.buf
;
875 if (isspace(c
) && !quote
) {
881 if (c
== ';' || c
== '#') {
886 for (; space
; space
--)
887 strbuf_addch(&cs
->value
, ' ');
889 c
= get_next_char(cs
);
902 /* Some characters escape as themselves */
905 /* Reject unknown escape sequences */
909 strbuf_addch(&cs
->value
, c
);
916 strbuf_addch(&cs
->value
, c
);
920 static int get_value(struct config_source
*cs
, struct key_value_info
*kvi
,
921 config_fn_t fn
, void *data
, struct strbuf
*name
)
926 struct config_context ctx
= {
930 /* Get the full name */
932 c
= get_next_char(cs
);
937 strbuf_addch(name
, tolower(c
));
940 while (c
== ' ' || c
== '\t')
941 c
= get_next_char(cs
);
947 value
= parse_value(cs
);
952 * We already consumed the \n, but we need linenr to point to
953 * the line we just parsed during the call to fn to get
954 * accurate line number in error messages.
957 kvi
->linenr
= cs
->linenr
;
958 ret
= fn(name
->buf
, value
, &ctx
, data
);
964 static int get_extended_base_var(struct config_source
*cs
, struct strbuf
*name
,
967 cs
->subsection_case_sensitive
= 0;
970 goto error_incomplete_line
;
971 c
= get_next_char(cs
);
972 } while (isspace(c
));
974 /* We require the format to be '[base "extension"]' */
977 strbuf_addch(name
, '.');
980 int c
= get_next_char(cs
);
982 goto error_incomplete_line
;
986 c
= get_next_char(cs
);
988 goto error_incomplete_line
;
990 strbuf_addch(name
, c
);
994 if (get_next_char(cs
) != ']')
997 error_incomplete_line
:
1002 static int get_base_var(struct config_source
*cs
, struct strbuf
*name
)
1004 cs
->subsection_case_sensitive
= 1;
1006 int c
= get_next_char(cs
);
1012 return get_extended_base_var(cs
, name
, c
);
1013 if (!iskeychar(c
) && c
!= '.')
1015 strbuf_addch(name
, tolower(c
));
1019 struct parse_event_data
{
1020 enum config_event_t previous_type
;
1021 size_t previous_offset
;
1022 const struct config_options
*opts
;
1025 static int do_event(struct config_source
*cs
, enum config_event_t type
,
1026 struct parse_event_data
*data
)
1030 if (!data
->opts
|| !data
->opts
->event_fn
)
1033 if (type
== CONFIG_EVENT_WHITESPACE
&&
1034 data
->previous_type
== type
)
1037 offset
= cs
->do_ftell(cs
);
1039 * At EOF, the parser always "inserts" an extra '\n', therefore
1040 * the end offset of the event is the current file position, otherwise
1041 * we will already have advanced to the next event.
1043 if (type
!= CONFIG_EVENT_EOF
)
1046 if (data
->previous_type
!= CONFIG_EVENT_EOF
&&
1047 data
->opts
->event_fn(data
->previous_type
, data
->previous_offset
,
1048 offset
, data
->opts
->event_fn_data
) < 0)
1051 data
->previous_type
= type
;
1052 data
->previous_offset
= offset
;
1057 static void kvi_from_source(struct config_source
*cs
,
1058 enum config_scope scope
,
1059 struct key_value_info
*out
)
1061 out
->filename
= strintern(cs
->name
);
1062 out
->origin_type
= cs
->origin_type
;
1063 out
->linenr
= cs
->linenr
;
1065 out
->path
= cs
->path
;
1068 static int git_parse_source(struct config_source
*cs
, config_fn_t fn
,
1069 struct key_value_info
*kvi
, void *data
,
1070 const struct config_options
*opts
)
1074 struct strbuf
*var
= &cs
->var
;
1075 int error_return
= 0;
1076 char *error_msg
= NULL
;
1078 /* U+FEFF Byte Order Mark in UTF8 */
1079 const char *bomptr
= utf8_bom
;
1081 /* For the parser event callback */
1082 struct parse_event_data event_data
= {
1083 CONFIG_EVENT_EOF
, 0, opts
1089 c
= get_next_char(cs
);
1090 if (bomptr
&& *bomptr
) {
1091 /* We are at the file beginning; skip UTF8-encoded BOM
1092 * if present. Sane editors won't put this in on their
1093 * own, but e.g. Windows Notepad will do it happily. */
1094 if (c
== (*bomptr
& 0377)) {
1098 /* Do not tolerate partial BOM. */
1099 if (bomptr
!= utf8_bom
)
1101 /* No BOM at file beginning. Cool. */
1107 if (do_event(cs
, CONFIG_EVENT_EOF
, &event_data
) < 0)
1111 if (do_event(cs
, CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
1119 if (do_event(cs
, CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
1123 if (c
== '#' || c
== ';') {
1124 if (do_event(cs
, CONFIG_EVENT_COMMENT
, &event_data
) < 0)
1130 if (do_event(cs
, CONFIG_EVENT_SECTION
, &event_data
) < 0)
1133 /* Reset prior to determining a new stem */
1135 if (get_base_var(cs
, var
) < 0 || var
->len
< 1)
1137 strbuf_addch(var
, '.');
1144 if (do_event(cs
, CONFIG_EVENT_ENTRY
, &event_data
) < 0)
1148 * Truncate the var name back to the section header
1149 * stem prior to grabbing the suffix part of the name
1152 strbuf_setlen(var
, baselen
);
1153 strbuf_addch(var
, tolower(c
));
1154 if (get_value(cs
, kvi
, fn
, data
, var
) < 0)
1158 if (do_event(cs
, CONFIG_EVENT_ERROR
, &event_data
) < 0)
1161 switch (cs
->origin_type
) {
1162 case CONFIG_ORIGIN_BLOB
:
1163 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
1164 cs
->linenr
, cs
->name
);
1166 case CONFIG_ORIGIN_FILE
:
1167 error_msg
= xstrfmt(_("bad config line %d in file %s"),
1168 cs
->linenr
, cs
->name
);
1170 case CONFIG_ORIGIN_STDIN
:
1171 error_msg
= xstrfmt(_("bad config line %d in standard input"),
1174 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1175 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
1176 cs
->linenr
, cs
->name
);
1178 case CONFIG_ORIGIN_CMDLINE
:
1179 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
1180 cs
->linenr
, cs
->name
);
1183 error_msg
= xstrfmt(_("bad config line %d in %s"),
1184 cs
->linenr
, cs
->name
);
1187 switch (opts
&& opts
->error_action
?
1188 opts
->error_action
:
1189 cs
->default_error_action
) {
1190 case CONFIG_ERROR_DIE
:
1191 die("%s", error_msg
);
1193 case CONFIG_ERROR_ERROR
:
1194 error_return
= error("%s", error_msg
);
1196 case CONFIG_ERROR_SILENT
:
1199 case CONFIG_ERROR_UNSET
:
1200 BUG("config error action unset");
1204 return error_return
;
1207 static uintmax_t get_unit_factor(const char *end
)
1211 else if (!strcasecmp(end
, "k"))
1213 else if (!strcasecmp(end
, "m"))
1215 else if (!strcasecmp(end
, "g"))
1216 return 1024 * 1024 * 1024;
1220 static int git_parse_signed(const char *value
, intmax_t *ret
, intmax_t max
)
1222 if (value
&& *value
) {
1228 BUG("max must be a positive integer");
1231 val
= strtoimax(value
, &end
, 0);
1232 if (errno
== ERANGE
)
1238 factor
= get_unit_factor(end
);
1243 if ((val
< 0 && -max
/ factor
> val
) ||
1244 (val
> 0 && max
/ factor
< val
)) {
1256 static int git_parse_unsigned(const char *value
, uintmax_t *ret
, uintmax_t max
)
1258 if (value
&& *value
) {
1263 /* negative values would be accepted by strtoumax */
1264 if (strchr(value
, '-')) {
1269 val
= strtoumax(value
, &end
, 0);
1270 if (errno
== ERANGE
)
1276 factor
= get_unit_factor(end
);
1281 if (unsigned_mult_overflows(factor
, val
) ||
1282 factor
* val
> max
) {
1294 int git_parse_int(const char *value
, int *ret
)
1297 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int)))
1303 static int git_parse_int64(const char *value
, int64_t *ret
)
1306 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(int64_t)))
1312 int git_parse_ulong(const char *value
, unsigned long *ret
)
1315 if (!git_parse_unsigned(value
, &tmp
, maximum_unsigned_value_of_type(long)))
1321 int git_parse_ssize_t(const char *value
, ssize_t
*ret
)
1324 if (!git_parse_signed(value
, &tmp
, maximum_signed_value_of_type(ssize_t
)))
1331 static void die_bad_number(const char *name
, const char *value
,
1332 const struct key_value_info
*kvi
)
1334 const char *error_type
= (errno
== ERANGE
) ?
1335 N_("out of range") : N_("invalid unit");
1336 const char *bad_numeric
= N_("bad numeric config value '%s' for '%s': %s");
1339 BUG("kvi should not be NULL");
1345 die(_(bad_numeric
), value
, name
, _(error_type
));
1347 switch (kvi
->origin_type
) {
1348 case CONFIG_ORIGIN_BLOB
:
1349 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1350 value
, name
, kvi
->filename
, _(error_type
));
1351 case CONFIG_ORIGIN_FILE
:
1352 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1353 value
, name
, kvi
->filename
, _(error_type
));
1354 case CONFIG_ORIGIN_STDIN
:
1355 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1356 value
, name
, _(error_type
));
1357 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1358 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1359 value
, name
, kvi
->filename
, _(error_type
));
1360 case CONFIG_ORIGIN_CMDLINE
:
1361 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1362 value
, name
, kvi
->filename
, _(error_type
));
1364 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1365 value
, name
, kvi
->filename
, _(error_type
));
1369 int git_config_int(const char *name
, const char *value
,
1370 const struct key_value_info
*kvi
)
1373 if (!git_parse_int(value
, &ret
))
1374 die_bad_number(name
, value
, kvi
);
1378 int64_t git_config_int64(const char *name
, const char *value
,
1379 const struct key_value_info
*kvi
)
1382 if (!git_parse_int64(value
, &ret
))
1383 die_bad_number(name
, value
, kvi
);
1387 unsigned long git_config_ulong(const char *name
, const char *value
,
1388 const struct key_value_info
*kvi
)
1391 if (!git_parse_ulong(value
, &ret
))
1392 die_bad_number(name
, value
, kvi
);
1396 ssize_t
git_config_ssize_t(const char *name
, const char *value
,
1397 const struct key_value_info
*kvi
)
1400 if (!git_parse_ssize_t(value
, &ret
))
1401 die_bad_number(name
, value
, kvi
);
1405 static int git_parse_maybe_bool_text(const char *value
)
1411 if (!strcasecmp(value
, "true")
1412 || !strcasecmp(value
, "yes")
1413 || !strcasecmp(value
, "on"))
1415 if (!strcasecmp(value
, "false")
1416 || !strcasecmp(value
, "no")
1417 || !strcasecmp(value
, "off"))
1422 static const struct fsync_component_name
{
1424 enum fsync_component component_bits
;
1425 } fsync_component_names
[] = {
1426 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT
},
1427 { "pack", FSYNC_COMPONENT_PACK
},
1428 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA
},
1429 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH
},
1430 { "index", FSYNC_COMPONENT_INDEX
},
1431 { "objects", FSYNC_COMPONENTS_OBJECTS
},
1432 { "reference", FSYNC_COMPONENT_REFERENCE
},
1433 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA
},
1434 { "committed", FSYNC_COMPONENTS_COMMITTED
},
1435 { "added", FSYNC_COMPONENTS_ADDED
},
1436 { "all", FSYNC_COMPONENTS_ALL
},
1439 static enum fsync_component
parse_fsync_components(const char *var
, const char *string
)
1441 enum fsync_component current
= FSYNC_COMPONENTS_PLATFORM_DEFAULT
;
1442 enum fsync_component positive
= 0, negative
= 0;
1451 string
= string
+ strspn(string
, ", \t\n\r");
1452 ep
= strchrnul(string
, ',');
1454 if (!strcmp(string
, "none")) {
1455 current
= FSYNC_COMPONENT_NONE
;
1459 if (*string
== '-') {
1464 warning(_("invalid value for variable %s"), var
);
1470 for (i
= 0; i
< ARRAY_SIZE(fsync_component_names
); ++i
) {
1471 const struct fsync_component_name
*n
= &fsync_component_names
[i
];
1473 if (strncmp(n
->name
, string
, len
))
1478 negative
|= n
->component_bits
;
1480 positive
|= n
->component_bits
;
1484 char *component
= xstrndup(string
, len
);
1485 warning(_("ignoring unknown core.fsync component '%s'"), component
);
1493 return (current
& ~negative
) | positive
;
1496 int git_parse_maybe_bool(const char *value
)
1498 int v
= git_parse_maybe_bool_text(value
);
1501 if (git_parse_int(value
, &v
))
1506 int git_config_bool_or_int(const char *name
, const char *value
,
1507 const struct key_value_info
*kvi
, int *is_bool
)
1509 int v
= git_parse_maybe_bool_text(value
);
1515 return git_config_int(name
, value
, kvi
);
1518 int git_config_bool(const char *name
, const char *value
)
1520 int v
= git_parse_maybe_bool(value
);
1522 die(_("bad boolean config value '%s' for '%s'"), value
, name
);
1526 int git_config_string(const char **dest
, const char *var
, const char *value
)
1529 return config_error_nonbool(var
);
1530 *dest
= xstrdup(value
);
1534 int git_config_pathname(const char **dest
, const char *var
, const char *value
)
1537 return config_error_nonbool(var
);
1538 *dest
= interpolate_path(value
, 0);
1540 die(_("failed to expand user dir in: '%s'"), value
);
1544 int git_config_expiry_date(timestamp_t
*timestamp
, const char *var
, const char *value
)
1547 return config_error_nonbool(var
);
1548 if (parse_expiry_date(value
, timestamp
))
1549 return error(_("'%s' for '%s' is not a valid timestamp"),
1554 int git_config_color(char *dest
, const char *var
, const char *value
)
1557 return config_error_nonbool(var
);
1558 if (color_parse(value
, dest
) < 0)
1563 static int git_default_core_config(const char *var
, const char *value
,
1564 const struct config_context
*ctx
, void *cb
)
1566 /* This needs a better name */
1567 if (!strcmp(var
, "core.filemode")) {
1568 trust_executable_bit
= git_config_bool(var
, value
);
1571 if (!strcmp(var
, "core.trustctime")) {
1572 trust_ctime
= git_config_bool(var
, value
);
1575 if (!strcmp(var
, "core.checkstat")) {
1576 if (!strcasecmp(value
, "default"))
1578 else if (!strcasecmp(value
, "minimal"))
1582 if (!strcmp(var
, "core.quotepath")) {
1583 quote_path_fully
= git_config_bool(var
, value
);
1587 if (!strcmp(var
, "core.symlinks")) {
1588 has_symlinks
= git_config_bool(var
, value
);
1592 if (!strcmp(var
, "core.ignorecase")) {
1593 ignore_case
= git_config_bool(var
, value
);
1597 if (!strcmp(var
, "core.attributesfile"))
1598 return git_config_pathname(&git_attributes_file
, var
, value
);
1600 if (!strcmp(var
, "core.hookspath"))
1601 return git_config_pathname(&git_hooks_path
, var
, value
);
1603 if (!strcmp(var
, "core.bare")) {
1604 is_bare_repository_cfg
= git_config_bool(var
, value
);
1608 if (!strcmp(var
, "core.ignorestat")) {
1609 assume_unchanged
= git_config_bool(var
, value
);
1613 if (!strcmp(var
, "core.prefersymlinkrefs")) {
1614 prefer_symlink_refs
= git_config_bool(var
, value
);
1618 if (!strcmp(var
, "core.logallrefupdates")) {
1619 if (value
&& !strcasecmp(value
, "always"))
1620 log_all_ref_updates
= LOG_REFS_ALWAYS
;
1621 else if (git_config_bool(var
, value
))
1622 log_all_ref_updates
= LOG_REFS_NORMAL
;
1624 log_all_ref_updates
= LOG_REFS_NONE
;
1628 if (!strcmp(var
, "core.warnambiguousrefs")) {
1629 warn_ambiguous_refs
= git_config_bool(var
, value
);
1633 if (!strcmp(var
, "core.abbrev")) {
1635 return config_error_nonbool(var
);
1636 if (!strcasecmp(value
, "auto"))
1637 default_abbrev
= -1;
1638 else if (!git_parse_maybe_bool_text(value
))
1639 default_abbrev
= the_hash_algo
->hexsz
;
1641 int abbrev
= git_config_int(var
, value
, ctx
->kvi
);
1642 if (abbrev
< minimum_abbrev
|| abbrev
> the_hash_algo
->hexsz
)
1643 return error(_("abbrev length out of range: %d"), abbrev
);
1644 default_abbrev
= abbrev
;
1649 if (!strcmp(var
, "core.disambiguate"))
1650 return set_disambiguate_hint_config(var
, value
);
1652 if (!strcmp(var
, "core.loosecompression")) {
1653 int level
= git_config_int(var
, value
, ctx
->kvi
);
1655 level
= Z_DEFAULT_COMPRESSION
;
1656 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1657 die(_("bad zlib compression level %d"), level
);
1658 zlib_compression_level
= level
;
1659 zlib_compression_seen
= 1;
1663 if (!strcmp(var
, "core.compression")) {
1664 int level
= git_config_int(var
, value
, ctx
->kvi
);
1666 level
= Z_DEFAULT_COMPRESSION
;
1667 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1668 die(_("bad zlib compression level %d"), level
);
1669 if (!zlib_compression_seen
)
1670 zlib_compression_level
= level
;
1671 if (!pack_compression_seen
)
1672 pack_compression_level
= level
;
1676 if (!strcmp(var
, "core.packedgitwindowsize")) {
1677 int pgsz_x2
= getpagesize() * 2;
1678 packed_git_window_size
= git_config_ulong(var
, value
, ctx
->kvi
);
1680 /* This value must be multiple of (pagesize * 2) */
1681 packed_git_window_size
/= pgsz_x2
;
1682 if (packed_git_window_size
< 1)
1683 packed_git_window_size
= 1;
1684 packed_git_window_size
*= pgsz_x2
;
1688 if (!strcmp(var
, "core.bigfilethreshold")) {
1689 big_file_threshold
= git_config_ulong(var
, value
, ctx
->kvi
);
1693 if (!strcmp(var
, "core.packedgitlimit")) {
1694 packed_git_limit
= git_config_ulong(var
, value
, ctx
->kvi
);
1698 if (!strcmp(var
, "core.deltabasecachelimit")) {
1699 delta_base_cache_limit
= git_config_ulong(var
, value
, ctx
->kvi
);
1703 if (!strcmp(var
, "core.autocrlf")) {
1704 if (value
&& !strcasecmp(value
, "input")) {
1705 auto_crlf
= AUTO_CRLF_INPUT
;
1708 auto_crlf
= git_config_bool(var
, value
);
1712 if (!strcmp(var
, "core.safecrlf")) {
1714 if (value
&& !strcasecmp(value
, "warn")) {
1715 global_conv_flags_eol
= CONV_EOL_RNDTRP_WARN
;
1718 eol_rndtrp_die
= git_config_bool(var
, value
);
1719 global_conv_flags_eol
= eol_rndtrp_die
?
1720 CONV_EOL_RNDTRP_DIE
: 0;
1724 if (!strcmp(var
, "core.eol")) {
1725 if (value
&& !strcasecmp(value
, "lf"))
1727 else if (value
&& !strcasecmp(value
, "crlf"))
1728 core_eol
= EOL_CRLF
;
1729 else if (value
&& !strcasecmp(value
, "native"))
1730 core_eol
= EOL_NATIVE
;
1732 core_eol
= EOL_UNSET
;
1736 if (!strcmp(var
, "core.checkroundtripencoding")) {
1737 check_roundtrip_encoding
= xstrdup(value
);
1741 if (!strcmp(var
, "core.notesref")) {
1742 notes_ref_name
= xstrdup(value
);
1746 if (!strcmp(var
, "core.editor"))
1747 return git_config_string(&editor_program
, var
, value
);
1749 if (!strcmp(var
, "core.commentchar")) {
1751 return config_error_nonbool(var
);
1752 else if (!strcasecmp(value
, "auto"))
1753 auto_comment_line_char
= 1;
1754 else if (value
[0] && !value
[1]) {
1755 comment_line_char
= value
[0];
1756 auto_comment_line_char
= 0;
1758 return error(_("core.commentChar should only be one ASCII character"));
1762 if (!strcmp(var
, "core.askpass"))
1763 return git_config_string(&askpass_program
, var
, value
);
1765 if (!strcmp(var
, "core.excludesfile"))
1766 return git_config_pathname(&excludes_file
, var
, value
);
1768 if (!strcmp(var
, "core.whitespace")) {
1770 return config_error_nonbool(var
);
1771 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1775 if (!strcmp(var
, "core.fsync")) {
1777 return config_error_nonbool(var
);
1778 fsync_components
= parse_fsync_components(var
, value
);
1782 if (!strcmp(var
, "core.fsyncmethod")) {
1784 return config_error_nonbool(var
);
1785 if (!strcmp(value
, "fsync"))
1786 fsync_method
= FSYNC_METHOD_FSYNC
;
1787 else if (!strcmp(value
, "writeout-only"))
1788 fsync_method
= FSYNC_METHOD_WRITEOUT_ONLY
;
1789 else if (!strcmp(value
, "batch"))
1790 fsync_method
= FSYNC_METHOD_BATCH
;
1792 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value
);
1796 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1797 if (fsync_object_files
< 0)
1798 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1799 fsync_object_files
= git_config_bool(var
, value
);
1803 if (!strcmp(var
, "core.preloadindex")) {
1804 core_preload_index
= git_config_bool(var
, value
);
1808 if (!strcmp(var
, "core.createobject")) {
1809 if (!strcmp(value
, "rename"))
1810 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1811 else if (!strcmp(value
, "link"))
1812 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1814 die(_("invalid mode for object creation: %s"), value
);
1818 if (!strcmp(var
, "core.sparsecheckout")) {
1819 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1823 if (!strcmp(var
, "core.sparsecheckoutcone")) {
1824 core_sparse_checkout_cone
= git_config_bool(var
, value
);
1828 if (!strcmp(var
, "core.precomposeunicode")) {
1829 precomposed_unicode
= git_config_bool(var
, value
);
1833 if (!strcmp(var
, "core.protecthfs")) {
1834 protect_hfs
= git_config_bool(var
, value
);
1838 if (!strcmp(var
, "core.protectntfs")) {
1839 protect_ntfs
= git_config_bool(var
, value
);
1843 /* Add other config variables here and to Documentation/config.txt. */
1844 return platform_core_config(var
, value
, ctx
, cb
);
1847 static int git_default_sparse_config(const char *var
, const char *value
)
1849 if (!strcmp(var
, "sparse.expectfilesoutsideofpatterns")) {
1850 sparse_expect_files_outside_of_patterns
= git_config_bool(var
, value
);
1854 /* Add other config variables here and to Documentation/config/sparse.txt. */
1858 static int git_default_i18n_config(const char *var
, const char *value
)
1860 if (!strcmp(var
, "i18n.commitencoding"))
1861 return git_config_string(&git_commit_encoding
, var
, value
);
1863 if (!strcmp(var
, "i18n.logoutputencoding"))
1864 return git_config_string(&git_log_output_encoding
, var
, value
);
1866 /* Add other config variables here and to Documentation/config.txt. */
1870 static int git_default_branch_config(const char *var
, const char *value
)
1872 if (!strcmp(var
, "branch.autosetupmerge")) {
1873 if (value
&& !strcmp(value
, "always")) {
1874 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1876 } else if (value
&& !strcmp(value
, "inherit")) {
1877 git_branch_track
= BRANCH_TRACK_INHERIT
;
1879 } else if (value
&& !strcmp(value
, "simple")) {
1880 git_branch_track
= BRANCH_TRACK_SIMPLE
;
1883 git_branch_track
= git_config_bool(var
, value
);
1886 if (!strcmp(var
, "branch.autosetuprebase")) {
1888 return config_error_nonbool(var
);
1889 else if (!strcmp(value
, "never"))
1890 autorebase
= AUTOREBASE_NEVER
;
1891 else if (!strcmp(value
, "local"))
1892 autorebase
= AUTOREBASE_LOCAL
;
1893 else if (!strcmp(value
, "remote"))
1894 autorebase
= AUTOREBASE_REMOTE
;
1895 else if (!strcmp(value
, "always"))
1896 autorebase
= AUTOREBASE_ALWAYS
;
1898 return error(_("malformed value for %s"), var
);
1902 /* Add other config variables here and to Documentation/config.txt. */
1906 static int git_default_push_config(const char *var
, const char *value
)
1908 if (!strcmp(var
, "push.default")) {
1910 return config_error_nonbool(var
);
1911 else if (!strcmp(value
, "nothing"))
1912 push_default
= PUSH_DEFAULT_NOTHING
;
1913 else if (!strcmp(value
, "matching"))
1914 push_default
= PUSH_DEFAULT_MATCHING
;
1915 else if (!strcmp(value
, "simple"))
1916 push_default
= PUSH_DEFAULT_SIMPLE
;
1917 else if (!strcmp(value
, "upstream"))
1918 push_default
= PUSH_DEFAULT_UPSTREAM
;
1919 else if (!strcmp(value
, "tracking")) /* deprecated */
1920 push_default
= PUSH_DEFAULT_UPSTREAM
;
1921 else if (!strcmp(value
, "current"))
1922 push_default
= PUSH_DEFAULT_CURRENT
;
1924 error(_("malformed value for %s: %s"), var
, value
);
1925 return error(_("must be one of nothing, matching, simple, "
1926 "upstream or current"));
1931 /* Add other config variables here and to Documentation/config.txt. */
1935 static int git_default_mailmap_config(const char *var
, const char *value
)
1937 if (!strcmp(var
, "mailmap.file"))
1938 return git_config_pathname(&git_mailmap_file
, var
, value
);
1939 if (!strcmp(var
, "mailmap.blob"))
1940 return git_config_string(&git_mailmap_blob
, var
, value
);
1942 /* Add other config variables here and to Documentation/config.txt. */
1946 int git_default_config(const char *var
, const char *value
,
1947 const struct config_context
*ctx
, void *cb
)
1949 if (starts_with(var
, "core."))
1950 return git_default_core_config(var
, value
, ctx
, cb
);
1952 if (starts_with(var
, "user.") ||
1953 starts_with(var
, "author.") ||
1954 starts_with(var
, "committer."))
1955 return git_ident_config(var
, value
, ctx
, cb
);
1957 if (starts_with(var
, "i18n."))
1958 return git_default_i18n_config(var
, value
);
1960 if (starts_with(var
, "branch."))
1961 return git_default_branch_config(var
, value
);
1963 if (starts_with(var
, "push."))
1964 return git_default_push_config(var
, value
);
1966 if (starts_with(var
, "mailmap."))
1967 return git_default_mailmap_config(var
, value
);
1969 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1970 return git_default_advice_config(var
, value
);
1972 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1973 pager_use_color
= git_config_bool(var
,value
);
1977 if (!strcmp(var
, "pack.packsizelimit")) {
1978 pack_size_limit_cfg
= git_config_ulong(var
, value
, ctx
->kvi
);
1982 if (!strcmp(var
, "pack.compression")) {
1983 int level
= git_config_int(var
, value
, ctx
->kvi
);
1985 level
= Z_DEFAULT_COMPRESSION
;
1986 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1987 die(_("bad pack compression level %d"), level
);
1988 pack_compression_level
= level
;
1989 pack_compression_seen
= 1;
1993 if (starts_with(var
, "sparse."))
1994 return git_default_sparse_config(var
, value
);
1996 /* Add other config variables here and to Documentation/config.txt. */
2001 * All source specific fields in the union, die_on_error, name and the callbacks
2002 * fgetc, ungetc, ftell of top need to be initialized before calling
2005 static int do_config_from(struct config_reader
*reader
,
2006 struct config_source
*top
, config_fn_t fn
,
2007 void *data
, enum config_scope scope
,
2008 const struct config_options
*opts
)
2010 struct key_value_info kvi
= KVI_INIT
;
2013 /* push config-file parsing state stack */
2017 strbuf_init(&top
->value
, 1024);
2018 strbuf_init(&top
->var
, 1024);
2019 config_reader_push_source(reader
, top
);
2020 kvi_from_source(top
, scope
, &kvi
);
2022 ret
= git_parse_source(top
, fn
, &kvi
, data
, opts
);
2024 /* pop config-file parsing state stack */
2025 strbuf_release(&top
->value
);
2026 strbuf_release(&top
->var
);
2027 config_reader_pop_source(reader
);
2032 static int do_config_from_file(struct config_reader
*reader
,
2034 const enum config_origin_type origin_type
,
2035 const char *name
, const char *path
, FILE *f
,
2036 void *data
, enum config_scope scope
,
2037 const struct config_options
*opts
)
2039 struct config_source top
= CONFIG_SOURCE_INIT
;
2043 top
.origin_type
= origin_type
;
2046 top
.default_error_action
= CONFIG_ERROR_DIE
;
2047 top
.do_fgetc
= config_file_fgetc
;
2048 top
.do_ungetc
= config_file_ungetc
;
2049 top
.do_ftell
= config_file_ftell
;
2052 ret
= do_config_from(reader
, &top
, fn
, data
, scope
, opts
);
2057 static int git_config_from_stdin(config_fn_t fn
, void *data
,
2058 enum config_scope scope
)
2060 return do_config_from_file(&the_reader
, fn
, CONFIG_ORIGIN_STDIN
, "",
2061 NULL
, stdin
, data
, scope
, NULL
);
2064 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
2065 void *data
, enum config_scope scope
,
2066 const struct config_options
*opts
)
2072 BUG("filename cannot be NULL");
2073 f
= fopen_or_warn(filename
, "r");
2075 ret
= do_config_from_file(&the_reader
, fn
, CONFIG_ORIGIN_FILE
,
2076 filename
, filename
, f
, data
, scope
,
2083 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
2085 return git_config_from_file_with_options(fn
, filename
, data
,
2086 CONFIG_SCOPE_UNKNOWN
, NULL
);
2089 int git_config_from_mem(config_fn_t fn
,
2090 const enum config_origin_type origin_type
,
2091 const char *name
, const char *buf
, size_t len
,
2092 void *data
, enum config_scope scope
,
2093 const struct config_options
*opts
)
2095 struct config_source top
= CONFIG_SOURCE_INIT
;
2097 top
.u
.buf
.buf
= buf
;
2098 top
.u
.buf
.len
= len
;
2100 top
.origin_type
= origin_type
;
2103 top
.default_error_action
= CONFIG_ERROR_ERROR
;
2104 top
.do_fgetc
= config_buf_fgetc
;
2105 top
.do_ungetc
= config_buf_ungetc
;
2106 top
.do_ftell
= config_buf_ftell
;
2108 return do_config_from(&the_reader
, &top
, fn
, data
, scope
, opts
);
2111 int git_config_from_blob_oid(config_fn_t fn
,
2113 struct repository
*repo
,
2114 const struct object_id
*oid
,
2116 enum config_scope scope
)
2118 enum object_type type
;
2123 buf
= repo_read_object_file(repo
, oid
, &type
, &size
);
2125 return error(_("unable to load config blob object '%s'"), name
);
2126 if (type
!= OBJ_BLOB
) {
2128 return error(_("reference '%s' does not point to a blob"), name
);
2131 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
2138 static int git_config_from_blob_ref(config_fn_t fn
,
2139 struct repository
*repo
,
2142 enum config_scope scope
)
2144 struct object_id oid
;
2146 if (repo_get_oid(repo
, name
, &oid
) < 0)
2147 return error(_("unable to resolve config blob '%s'"), name
);
2148 return git_config_from_blob_oid(fn
, name
, repo
, &oid
, data
, scope
);
2151 char *git_system_config(void)
2153 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2155 system_config
= system_path(ETC_GITCONFIG
);
2156 normalize_path_copy(system_config
, system_config
);
2157 return system_config
;
2160 void git_global_config(char **user_out
, char **xdg_out
)
2162 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2163 char *xdg_config
= NULL
;
2166 user_config
= interpolate_path("~/.gitconfig", 0);
2167 xdg_config
= xdg_config_home("config");
2170 *user_out
= user_config
;
2171 *xdg_out
= xdg_config
;
2175 * Parse environment variable 'k' as a boolean (in various
2176 * possible spellings); if missing, use the default value 'def'.
2178 int git_env_bool(const char *k
, int def
)
2180 const char *v
= getenv(k
);
2181 return v
? git_config_bool(k
, v
) : def
;
2185 * Parse environment variable 'k' as ulong with possibly a unit
2186 * suffix; if missing, use the default value 'val'.
2188 unsigned long git_env_ulong(const char *k
, unsigned long val
)
2190 const char *v
= getenv(k
);
2191 if (v
&& !git_parse_ulong(v
, &val
))
2192 die(_("failed to parse %s"), k
);
2196 int git_config_system(void)
2198 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2201 static int do_git_config_sequence(struct config_reader
*reader
,
2202 const struct config_options
*opts
,
2203 const struct repository
*repo
,
2204 config_fn_t fn
, void *data
)
2207 char *system_config
= git_system_config();
2208 char *xdg_config
= NULL
;
2209 char *user_config
= NULL
;
2211 char *worktree_config
;
2214 * Ensure that either:
2215 * - the git_dir and commondir are both set, or
2216 * - the git_dir and commondir are both NULL
2218 if (!opts
->git_dir
!= !opts
->commondir
)
2219 BUG("only one of commondir and git_dir is non-NULL");
2221 if (opts
->commondir
) {
2222 repo_config
= mkpathdup("%s/config", opts
->commondir
);
2223 worktree_config
= mkpathdup("%s/config.worktree", opts
->git_dir
);
2226 worktree_config
= NULL
;
2229 if (git_config_system() && system_config
&&
2230 !access_or_die(system_config
, R_OK
,
2231 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
2232 ret
+= git_config_from_file_with_options(fn
, system_config
,
2233 data
, CONFIG_SCOPE_SYSTEM
,
2236 git_global_config(&user_config
, &xdg_config
);
2238 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
2239 ret
+= git_config_from_file_with_options(fn
, xdg_config
, data
,
2240 CONFIG_SCOPE_GLOBAL
, NULL
);
2242 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
2243 ret
+= git_config_from_file_with_options(fn
, user_config
, data
,
2244 CONFIG_SCOPE_GLOBAL
, NULL
);
2246 if (!opts
->ignore_repo
&& repo_config
&&
2247 !access_or_die(repo_config
, R_OK
, 0))
2248 ret
+= git_config_from_file_with_options(fn
, repo_config
, data
,
2249 CONFIG_SCOPE_LOCAL
, NULL
);
2251 if (!opts
->ignore_worktree
&& worktree_config
&&
2252 repo
&& repo
->repository_format_worktree_config
&&
2253 !access_or_die(worktree_config
, R_OK
, 0)) {
2254 ret
+= git_config_from_file_with_options(fn
, worktree_config
, data
,
2255 CONFIG_SCOPE_WORKTREE
,
2259 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
2260 die(_("unable to parse command-line config"));
2262 free(system_config
);
2266 free(worktree_config
);
2270 int config_with_options(config_fn_t fn
, void *data
,
2271 struct git_config_source
*config_source
,
2272 struct repository
*repo
,
2273 const struct config_options
*opts
)
2275 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
2278 if (opts
->respect_includes
) {
2283 inc
.config_source
= config_source
;
2284 fn
= git_config_include
;
2289 * If we have a specific filename, use it. Otherwise, follow the
2290 * regular lookup sequence.
2292 if (config_source
&& config_source
->use_stdin
) {
2293 ret
= git_config_from_stdin(fn
, data
, config_source
->scope
);
2294 } else if (config_source
&& config_source
->file
) {
2295 ret
= git_config_from_file_with_options(fn
, config_source
->file
,
2296 data
, config_source
->scope
,
2298 } else if (config_source
&& config_source
->blob
) {
2299 ret
= git_config_from_blob_ref(fn
, repo
, config_source
->blob
,
2300 data
, config_source
->scope
);
2302 ret
= do_git_config_sequence(&the_reader
, opts
, repo
, fn
, data
);
2305 if (inc
.remote_urls
) {
2306 string_list_clear(inc
.remote_urls
, 0);
2307 FREE_AND_NULL(inc
.remote_urls
);
2312 static void configset_iter(struct config_set
*set
, config_fn_t fn
, void *data
)
2315 struct string_list
*values
;
2316 struct config_set_element
*entry
;
2317 struct configset_list
*list
= &set
->list
;
2318 struct config_context ctx
= CONFIG_CONTEXT_INIT
;
2320 for (i
= 0; i
< list
->nr
; i
++) {
2321 entry
= list
->items
[i
].e
;
2322 value_index
= list
->items
[i
].value_index
;
2323 values
= &entry
->value_list
;
2325 ctx
.kvi
= values
->items
[value_index
].util
;
2326 if (fn(entry
->key
, values
->items
[value_index
].string
, &ctx
, data
) < 0)
2327 git_die_config_linenr(entry
->key
,
2333 void read_early_config(config_fn_t cb
, void *data
)
2335 struct config_options opts
= {0};
2336 struct strbuf commondir
= STRBUF_INIT
;
2337 struct strbuf gitdir
= STRBUF_INIT
;
2339 opts
.respect_includes
= 1;
2341 if (have_git_dir()) {
2342 opts
.commondir
= get_git_common_dir();
2343 opts
.git_dir
= get_git_dir();
2345 * When setup_git_directory() was not yet asked to discover the
2346 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2347 * is any repository config we should use (but unlike
2348 * setup_git_directory_gently(), no global state is changed, most
2349 * notably, the current working directory is still the same after the
2352 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
2353 opts
.commondir
= commondir
.buf
;
2354 opts
.git_dir
= gitdir
.buf
;
2357 config_with_options(cb
, data
, NULL
, NULL
, &opts
);
2359 strbuf_release(&commondir
);
2360 strbuf_release(&gitdir
);
2364 * Read config but only enumerate system and global settings.
2365 * Omit any repo-local, worktree-local, or command-line settings.
2367 void read_very_early_config(config_fn_t cb
, void *data
)
2369 struct config_options opts
= { 0 };
2371 opts
.respect_includes
= 1;
2372 opts
.ignore_repo
= 1;
2373 opts
.ignore_worktree
= 1;
2374 opts
.ignore_cmdline
= 1;
2375 opts
.system_gently
= 1;
2377 config_with_options(cb
, data
, NULL
, NULL
, &opts
);
2381 static int configset_find_element(struct config_set
*set
, const char *key
,
2382 struct config_set_element
**dest
)
2384 struct config_set_element k
;
2385 struct config_set_element
*found_entry
;
2386 char *normalized_key
;
2390 * `key` may come from the user, so normalize it before using it
2391 * for querying entries from the hashmap.
2393 ret
= git_config_parse_key(key
, &normalized_key
, NULL
);
2397 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2398 k
.key
= normalized_key
;
2399 found_entry
= hashmap_get_entry(&set
->config_hash
, &k
, ent
, NULL
);
2400 free(normalized_key
);
2401 *dest
= found_entry
;
2405 static int configset_add_value(const struct key_value_info
*kvi_p
,
2406 struct config_set
*set
, const char *key
,
2409 struct config_set_element
*e
;
2410 struct string_list_item
*si
;
2411 struct configset_list_item
*l_item
;
2412 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2415 ret
= configset_find_element(set
, key
, &e
);
2419 * Since the keys are being fed by git_config*() callback mechanism, they
2420 * are already normalized. So simply add them without any further munging.
2423 e
= xmalloc(sizeof(*e
));
2424 hashmap_entry_init(&e
->ent
, strhash(key
));
2425 e
->key
= xstrdup(key
);
2426 string_list_init_dup(&e
->value_list
);
2427 hashmap_add(&set
->config_hash
, &e
->ent
);
2429 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2431 ALLOC_GROW(set
->list
.items
, set
->list
.nr
+ 1, set
->list
.alloc
);
2432 l_item
= &set
->list
.items
[set
->list
.nr
++];
2434 l_item
->value_index
= e
->value_list
.nr
- 1;
2442 static int config_set_element_cmp(const void *cmp_data UNUSED
,
2443 const struct hashmap_entry
*eptr
,
2444 const struct hashmap_entry
*entry_or_key
,
2445 const void *keydata UNUSED
)
2447 const struct config_set_element
*e1
, *e2
;
2449 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2450 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2452 return strcmp(e1
->key
, e2
->key
);
2455 void git_configset_init(struct config_set
*set
)
2457 hashmap_init(&set
->config_hash
, config_set_element_cmp
, NULL
, 0);
2458 set
->hash_initialized
= 1;
2460 set
->list
.alloc
= 0;
2461 set
->list
.items
= NULL
;
2464 void git_configset_clear(struct config_set
*set
)
2466 struct config_set_element
*entry
;
2467 struct hashmap_iter iter
;
2468 if (!set
->hash_initialized
)
2471 hashmap_for_each_entry(&set
->config_hash
, &iter
, entry
,
2472 ent
/* member name */) {
2474 string_list_clear(&entry
->value_list
, 1);
2476 hashmap_clear_and_free(&set
->config_hash
, struct config_set_element
, ent
);
2477 set
->hash_initialized
= 0;
2478 free(set
->list
.items
);
2480 set
->list
.alloc
= 0;
2481 set
->list
.items
= NULL
;
2484 static int config_set_callback(const char *key
, const char *value
,
2485 const struct config_context
*ctx
,
2488 struct config_set
*set
= cb
;
2489 configset_add_value(ctx
->kvi
, set
, key
, value
);
2493 int git_configset_add_file(struct config_set
*set
, const char *filename
)
2495 return git_config_from_file(config_set_callback
, filename
, set
);
2498 int git_configset_get_value(struct config_set
*set
, const char *key
,
2499 const char **value
, struct key_value_info
*kvi
)
2501 const struct string_list
*values
= NULL
;
2503 struct string_list_item item
;
2505 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2506 * queried key in the files of the configset, the value returned will be the last
2507 * value in the value list for that key.
2509 if ((ret
= git_configset_get_value_multi(set
, key
, &values
)))
2512 assert(values
->nr
> 0);
2513 item
= values
->items
[values
->nr
- 1];
2514 *value
= item
.string
;
2516 *kvi
= *((struct key_value_info
*)item
.util
);
2520 int git_configset_get_value_multi(struct config_set
*set
, const char *key
,
2521 const struct string_list
**dest
)
2523 struct config_set_element
*e
;
2526 if ((ret
= configset_find_element(set
, key
, &e
)))
2530 *dest
= &e
->value_list
;
2535 static int check_multi_string(struct string_list_item
*item
, void *util
)
2537 return item
->string
? 0 : config_error_nonbool(util
);
2540 int git_configset_get_string_multi(struct config_set
*cs
, const char *key
,
2541 const struct string_list
**dest
)
2545 if ((ret
= git_configset_get_value_multi(cs
, key
, dest
)))
2547 if ((ret
= for_each_string_list((struct string_list
*)*dest
,
2548 check_multi_string
, (void *)key
)))
2554 int git_configset_get(struct config_set
*set
, const char *key
)
2556 struct config_set_element
*e
;
2559 if ((ret
= configset_find_element(set
, key
, &e
)))
2566 int git_configset_get_string(struct config_set
*set
, const char *key
, char **dest
)
2569 if (!git_configset_get_value(set
, key
, &value
, NULL
))
2570 return git_config_string((const char **)dest
, key
, value
);
2575 static int git_configset_get_string_tmp(struct config_set
*set
, const char *key
,
2579 if (!git_configset_get_value(set
, key
, &value
, NULL
)) {
2581 return config_error_nonbool(key
);
2589 int git_configset_get_int(struct config_set
*set
, const char *key
, int *dest
)
2592 struct key_value_info kvi
;
2594 if (!git_configset_get_value(set
, key
, &value
, &kvi
)) {
2595 *dest
= git_config_int(key
, value
, &kvi
);
2601 int git_configset_get_ulong(struct config_set
*set
, const char *key
, unsigned long *dest
)
2604 struct key_value_info kvi
;
2606 if (!git_configset_get_value(set
, key
, &value
, &kvi
)) {
2607 *dest
= git_config_ulong(key
, value
, &kvi
);
2613 int git_configset_get_bool(struct config_set
*set
, const char *key
, int *dest
)
2616 if (!git_configset_get_value(set
, key
, &value
, NULL
)) {
2617 *dest
= git_config_bool(key
, value
);
2623 int git_configset_get_bool_or_int(struct config_set
*set
, const char *key
,
2624 int *is_bool
, int *dest
)
2627 struct key_value_info kvi
;
2629 if (!git_configset_get_value(set
, key
, &value
, &kvi
)) {
2630 *dest
= git_config_bool_or_int(key
, value
, &kvi
, is_bool
);
2636 int git_configset_get_maybe_bool(struct config_set
*set
, const char *key
, int *dest
)
2639 if (!git_configset_get_value(set
, key
, &value
, NULL
)) {
2640 *dest
= git_parse_maybe_bool(value
);
2648 int git_configset_get_pathname(struct config_set
*set
, const char *key
, const char **dest
)
2651 if (!git_configset_get_value(set
, key
, &value
, NULL
))
2652 return git_config_pathname(dest
, key
, value
);
2657 /* Functions use to read configuration from a repository */
2658 static void repo_read_config(struct repository
*repo
)
2660 struct config_options opts
= { 0 };
2662 opts
.respect_includes
= 1;
2663 opts
.commondir
= repo
->commondir
;
2664 opts
.git_dir
= repo
->gitdir
;
2667 CALLOC_ARRAY(repo
->config
, 1);
2669 git_configset_clear(repo
->config
);
2671 git_configset_init(repo
->config
);
2672 if (config_with_options(config_set_callback
, repo
->config
, NULL
,
2675 * config_with_options() normally returns only
2676 * zero, as most errors are fatal, and
2677 * non-fatal potential errors are guarded by "if"
2678 * statements that are entered only when no error is
2681 * If we ever encounter a non-fatal error, it means
2682 * something went really wrong and we should stop
2685 die(_("unknown error occurred while reading the configuration files"));
2688 static void git_config_check_init(struct repository
*repo
)
2690 if (repo
->config
&& repo
->config
->hash_initialized
)
2692 repo_read_config(repo
);
2695 static void repo_config_clear(struct repository
*repo
)
2697 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2699 git_configset_clear(repo
->config
);
2702 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2704 git_config_check_init(repo
);
2705 configset_iter(repo
->config
, fn
, data
);
2708 int repo_config_get(struct repository
*repo
, const char *key
)
2710 git_config_check_init(repo
);
2711 return git_configset_get(repo
->config
, key
);
2714 int repo_config_get_value(struct repository
*repo
,
2715 const char *key
, const char **value
)
2717 git_config_check_init(repo
);
2718 return git_configset_get_value(repo
->config
, key
, value
, NULL
);
2721 int repo_config_get_value_multi(struct repository
*repo
, const char *key
,
2722 const struct string_list
**dest
)
2724 git_config_check_init(repo
);
2725 return git_configset_get_value_multi(repo
->config
, key
, dest
);
2728 int repo_config_get_string_multi(struct repository
*repo
, const char *key
,
2729 const struct string_list
**dest
)
2731 git_config_check_init(repo
);
2732 return git_configset_get_string_multi(repo
->config
, key
, dest
);
2735 int repo_config_get_string(struct repository
*repo
,
2736 const char *key
, char **dest
)
2739 git_config_check_init(repo
);
2740 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2742 git_die_config(key
, NULL
);
2746 int repo_config_get_string_tmp(struct repository
*repo
,
2747 const char *key
, const char **dest
)
2750 git_config_check_init(repo
);
2751 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2753 git_die_config(key
, NULL
);
2757 int repo_config_get_int(struct repository
*repo
,
2758 const char *key
, int *dest
)
2760 git_config_check_init(repo
);
2761 return git_configset_get_int(repo
->config
, key
, dest
);
2764 int repo_config_get_ulong(struct repository
*repo
,
2765 const char *key
, unsigned long *dest
)
2767 git_config_check_init(repo
);
2768 return git_configset_get_ulong(repo
->config
, key
, dest
);
2771 int repo_config_get_bool(struct repository
*repo
,
2772 const char *key
, int *dest
)
2774 git_config_check_init(repo
);
2775 return git_configset_get_bool(repo
->config
, key
, dest
);
2778 int repo_config_get_bool_or_int(struct repository
*repo
,
2779 const char *key
, int *is_bool
, int *dest
)
2781 git_config_check_init(repo
);
2782 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2785 int repo_config_get_maybe_bool(struct repository
*repo
,
2786 const char *key
, int *dest
)
2788 git_config_check_init(repo
);
2789 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2792 int repo_config_get_pathname(struct repository
*repo
,
2793 const char *key
, const char **dest
)
2796 git_config_check_init(repo
);
2797 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2799 git_die_config(key
, NULL
);
2803 /* Read values into protected_config. */
2804 static void read_protected_config(void)
2806 struct config_options opts
= {
2807 .respect_includes
= 1,
2809 .ignore_worktree
= 1,
2813 git_configset_init(&protected_config
);
2814 config_with_options(config_set_callback
, &protected_config
, NULL
,
2818 void git_protected_config(config_fn_t fn
, void *data
)
2820 if (!protected_config
.hash_initialized
)
2821 read_protected_config();
2822 configset_iter(&protected_config
, fn
, data
);
2825 /* Functions used historically to read configuration from 'the_repository' */
2826 void git_config(config_fn_t fn
, void *data
)
2828 repo_config(the_repository
, fn
, data
);
2831 void git_config_clear(void)
2833 repo_config_clear(the_repository
);
2836 int git_config_get(const char *key
)
2838 return repo_config_get(the_repository
, key
);
2841 int git_config_get_value(const char *key
, const char **value
)
2843 return repo_config_get_value(the_repository
, key
, value
);
2846 int git_config_get_value_multi(const char *key
, const struct string_list
**dest
)
2848 return repo_config_get_value_multi(the_repository
, key
, dest
);
2851 int git_config_get_string_multi(const char *key
,
2852 const struct string_list
**dest
)
2854 return repo_config_get_string_multi(the_repository
, key
, dest
);
2857 int git_config_get_string(const char *key
, char **dest
)
2859 return repo_config_get_string(the_repository
, key
, dest
);
2862 int git_config_get_string_tmp(const char *key
, const char **dest
)
2864 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2867 int git_config_get_int(const char *key
, int *dest
)
2869 return repo_config_get_int(the_repository
, key
, dest
);
2872 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2874 return repo_config_get_ulong(the_repository
, key
, dest
);
2877 int git_config_get_bool(const char *key
, int *dest
)
2879 return repo_config_get_bool(the_repository
, key
, dest
);
2882 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2884 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2887 int git_config_get_maybe_bool(const char *key
, int *dest
)
2889 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2892 int git_config_get_pathname(const char *key
, const char **dest
)
2894 return repo_config_get_pathname(the_repository
, key
, dest
);
2897 int git_config_get_expiry(const char *key
, const char **output
)
2899 int ret
= git_config_get_string(key
, (char **)output
);
2902 if (strcmp(*output
, "now")) {
2903 timestamp_t now
= approxidate("now");
2904 if (approxidate(*output
) >= now
)
2905 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2910 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2912 const char *expiry_string
;
2916 if (git_config_get_string_tmp(key
, &expiry_string
))
2917 return 1; /* no such thing */
2919 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2920 const int scale
= 86400;
2921 *expiry
= now
- days
* scale
;
2925 if (!parse_expiry_date(expiry_string
, &when
)) {
2929 return -1; /* thing exists but cannot be parsed */
2932 int git_config_get_split_index(void)
2936 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2939 return -1; /* default value */
2942 int git_config_get_max_percent_split_change(void)
2946 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2947 if (0 <= val
&& val
<= 100)
2950 return error(_("splitIndex.maxPercentChange value '%d' "
2951 "should be between 0 and 100"), val
);
2954 return -1; /* default value */
2957 int git_config_get_index_threads(int *dest
)
2961 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2967 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2969 *dest
= val
? 0 : 1;
2979 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2982 die(_("unable to parse '%s' from command-line config"), key
);
2984 die(_("bad config variable '%s' in file '%s' at line %d"),
2985 key
, filename
, linenr
);
2988 NORETURN
__attribute__((format(printf
, 2, 3)))
2989 void git_die_config(const char *key
, const char *err
, ...)
2991 const struct string_list
*values
;
2992 struct key_value_info
*kv_info
;
2993 report_fn error_fn
= get_error_routine();
2997 va_start(params
, err
);
2998 error_fn(err
, params
);
3001 if (git_config_get_value_multi(key
, &values
))
3002 BUG("for key '%s' we must have a value to report on", key
);
3003 kv_info
= values
->items
[values
->nr
- 1].util
;
3004 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
3008 * Find all the stuff for git_config_set() below.
3011 struct config_store_data
{
3012 struct config_reader
*config_reader
;
3016 const char *fixed_value
;
3017 regex_t
*value_pattern
;
3021 enum config_event_t type
;
3022 int is_keys_section
;
3024 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
3025 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
3027 #define CONFIG_STORE_INIT { 0 }
3029 static void config_store_data_clear(struct config_store_data
*store
)
3032 if (store
->value_pattern
!= NULL
&&
3033 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
3034 regfree(store
->value_pattern
);
3035 free(store
->value_pattern
);
3037 free(store
->parsed
);
3039 memset(store
, 0, sizeof(*store
));
3042 static int matches(const char *key
, const char *value
,
3043 const struct config_store_data
*store
)
3045 if (strcmp(key
, store
->key
))
3046 return 0; /* not ours */
3047 if (store
->fixed_value
)
3048 return !strcmp(store
->fixed_value
, value
);
3049 if (!store
->value_pattern
)
3050 return 1; /* always matches */
3051 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
3052 return 0; /* never matches */
3054 return store
->do_not_match
^
3055 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
3058 static int store_aux_event(enum config_event_t type
,
3059 size_t begin
, size_t end
, void *data
)
3061 struct config_store_data
*store
= data
;
3062 struct config_source
*cs
= store
->config_reader
->source
;
3064 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
3065 store
->parsed
[store
->parsed_nr
].begin
= begin
;
3066 store
->parsed
[store
->parsed_nr
].end
= end
;
3067 store
->parsed
[store
->parsed_nr
].type
= type
;
3069 if (type
== CONFIG_EVENT_SECTION
) {
3070 int (*cmpfn
)(const char *, const char *, size_t);
3072 if (cs
->var
.len
< 2 || cs
->var
.buf
[cs
->var
.len
- 1] != '.')
3073 return error(_("invalid section name '%s'"), cs
->var
.buf
);
3075 if (cs
->subsection_case_sensitive
)
3076 cmpfn
= strncasecmp
;
3080 /* Is this the section we were looking for? */
3081 store
->is_keys_section
=
3082 store
->parsed
[store
->parsed_nr
].is_keys_section
=
3083 cs
->var
.len
- 1 == store
->baselen
&&
3084 !cmpfn(cs
->var
.buf
, store
->key
, store
->baselen
);
3085 if (store
->is_keys_section
) {
3086 store
->section_seen
= 1;
3087 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
3089 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
3098 static int store_aux(const char *key
, const char *value
,
3099 const struct config_context
*ctx UNUSED
, void *cb
)
3101 struct config_store_data
*store
= cb
;
3103 if (store
->key_seen
) {
3104 if (matches(key
, value
, store
)) {
3105 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
3106 warning(_("%s has multiple values"), key
);
3109 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
3112 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
3115 } else if (store
->is_keys_section
) {
3117 * Do not increment matches yet: this may not be a match, but we
3118 * are in the desired section.
3120 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
3121 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
3122 store
->section_seen
= 1;
3124 if (matches(key
, value
, store
)) {
3126 store
->key_seen
= 1;
3133 static int write_error(const char *filename
)
3135 error(_("failed to write new configuration file %s"), filename
);
3137 /* Same error code as "failed to rename". */
3141 static struct strbuf
store_create_section(const char *key
,
3142 const struct config_store_data
*store
)
3146 struct strbuf sb
= STRBUF_INIT
;
3148 dot
= memchr(key
, '.', store
->baselen
);
3150 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
3151 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
3152 if (key
[i
] == '"' || key
[i
] == '\\')
3153 strbuf_addch(&sb
, '\\');
3154 strbuf_addch(&sb
, key
[i
]);
3156 strbuf_addstr(&sb
, "\"]\n");
3158 strbuf_addch(&sb
, '[');
3159 strbuf_add(&sb
, key
, store
->baselen
);
3160 strbuf_addstr(&sb
, "]\n");
3166 static ssize_t
write_section(int fd
, const char *key
,
3167 const struct config_store_data
*store
)
3169 struct strbuf sb
= store_create_section(key
, store
);
3172 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
3173 strbuf_release(&sb
);
3178 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
3179 const struct config_store_data
*store
)
3183 const char *quote
= "";
3184 struct strbuf sb
= STRBUF_INIT
;
3187 * Check to see if the value needs to be surrounded with a dq pair.
3188 * Note that problematic characters are always backslash-quoted; this
3189 * check is about not losing leading or trailing SP and strings that
3190 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3191 * configuration parser.
3193 if (value
[0] == ' ')
3195 for (i
= 0; value
[i
]; i
++)
3196 if (value
[i
] == ';' || value
[i
] == '#')
3198 if (i
&& value
[i
- 1] == ' ')
3201 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
3203 for (i
= 0; value
[i
]; i
++)
3206 strbuf_addstr(&sb
, "\\n");
3209 strbuf_addstr(&sb
, "\\t");
3213 strbuf_addch(&sb
, '\\');
3216 strbuf_addch(&sb
, value
[i
]);
3219 strbuf_addf(&sb
, "%s\n", quote
);
3221 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
3222 strbuf_release(&sb
);
3228 * If we are about to unset the last key(s) in a section, and if there are
3229 * no comments surrounding (or included in) the section, we will want to
3230 * extend begin/end to remove the entire section.
3232 * Note: the parameter `seen_ptr` points to the index into the store.seen
3233 * array. * This index may be incremented if a section has more than one
3234 * entry (which all are to be removed).
3236 static void maybe_remove_section(struct config_store_data
*store
,
3237 size_t *begin_offset
, size_t *end_offset
,
3241 int i
, seen
, section_seen
= 0;
3244 * First, ensure that this is the first key, and that there are no
3245 * comments before the entry nor before the section header.
3248 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
3249 enum config_event_t type
= store
->parsed
[i
- 1].type
;
3251 if (type
== CONFIG_EVENT_COMMENT
)
3252 /* There is a comment before this entry or section */
3254 if (type
== CONFIG_EVENT_ENTRY
) {
3256 /* This is not the section's first entry. */
3258 /* We encountered no comment before the section. */
3261 if (type
== CONFIG_EVENT_SECTION
) {
3262 if (!store
->parsed
[i
- 1].is_keys_section
)
3267 begin
= store
->parsed
[i
].begin
;
3270 * Next, make sure that we are removing the last key(s) in the section,
3271 * and that there are no comments that are possibly about the current
3274 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
3275 enum config_event_t type
= store
->parsed
[i
].type
;
3277 if (type
== CONFIG_EVENT_COMMENT
)
3279 if (type
== CONFIG_EVENT_SECTION
) {
3280 if (store
->parsed
[i
].is_keys_section
)
3284 if (type
== CONFIG_EVENT_ENTRY
) {
3285 if (++seen
< store
->seen_nr
&&
3286 i
== store
->seen
[seen
])
3287 /* We want to remove this entry, too */
3289 /* There is another entry in this section. */
3295 * We are really removing the last entry/entries from this section, and
3296 * there are no enclosed or surrounding comments. Remove the entire,
3297 * now-empty section.
3300 *begin_offset
= begin
;
3301 if (i
< store
->parsed_nr
)
3302 *end_offset
= store
->parsed
[i
].begin
;
3304 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
3307 int git_config_set_in_file_gently(const char *config_filename
,
3308 const char *key
, const char *value
)
3310 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, 0);
3313 void git_config_set_in_file(const char *config_filename
,
3314 const char *key
, const char *value
)
3316 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
3319 int git_config_set_gently(const char *key
, const char *value
)
3321 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
3324 int repo_config_set_worktree_gently(struct repository
*r
,
3325 const char *key
, const char *value
)
3327 /* Only use worktree-specific config if it is already enabled. */
3328 if (r
->repository_format_worktree_config
) {
3329 char *file
= repo_git_path(r
, "config.worktree");
3330 int ret
= git_config_set_multivar_in_file_gently(
3331 file
, key
, value
, NULL
, 0);
3335 return repo_config_set_multivar_gently(r
, key
, value
, NULL
, 0);
3338 void git_config_set(const char *key
, const char *value
)
3340 git_config_set_multivar(key
, value
, NULL
, 0);
3342 trace2_cmd_set_config(key
, value
);
3346 * If value==NULL, unset in (remove from) config,
3347 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3348 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3349 * (only add a new one)
3350 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3351 * key/values are removed before a single new pair is written. If the
3352 * flag is not present, then replace only the first match.
3354 * Returns 0 on success.
3356 * This function does this:
3358 * - it locks the config file by creating ".git/config.lock"
3360 * - it then parses the config using store_aux() as validator to find
3361 * the position on the key/value pair to replace. If it is to be unset,
3362 * it must be found exactly once.
3364 * - the config file is mmap()ed and the part before the match (if any) is
3365 * written to the lock file, then the changed part and the rest.
3367 * - the config file is removed and the lock file rename()d to it.
3370 int git_config_set_multivar_in_file_gently(const char *config_filename
,
3371 const char *key
, const char *value
,
3372 const char *value_pattern
,
3375 int fd
= -1, in_fd
= -1;
3377 struct lock_file lock
= LOCK_INIT
;
3378 char *filename_buf
= NULL
;
3379 char *contents
= NULL
;
3381 struct config_store_data store
= CONFIG_STORE_INIT
;
3383 store
.config_reader
= &the_reader
;
3385 /* parse-key returns negative; flip the sign to feed exit(3) */
3386 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
3390 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
3392 if (!config_filename
)
3393 config_filename
= filename_buf
= git_pathdup("config");
3396 * The lock serves a purpose in addition to locking: the new
3397 * contents of .git/config will be written into it.
3399 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3401 error_errno(_("could not lock config file %s"), config_filename
);
3402 ret
= CONFIG_NO_LOCK
;
3407 * If .git/config does not exist yet, write a minimal version.
3409 in_fd
= open(config_filename
, O_RDONLY
);
3411 if ( ENOENT
!= errno
) {
3412 error_errno(_("opening %s"), config_filename
);
3413 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
3416 /* if nothing to unset, error out */
3418 ret
= CONFIG_NOTHING_SET
;
3423 store
.key
= xstrdup(key
);
3424 if (write_section(fd
, key
, &store
) < 0 ||
3425 write_pair(fd
, key
, value
, &store
) < 0)
3429 size_t copy_begin
, copy_end
;
3430 int i
, new_line
= 0;
3431 struct config_options opts
;
3434 store
.value_pattern
= NULL
;
3435 else if (value_pattern
== CONFIG_REGEX_NONE
)
3436 store
.value_pattern
= CONFIG_REGEX_NONE
;
3437 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
3438 store
.fixed_value
= value_pattern
;
3440 if (value_pattern
[0] == '!') {
3441 store
.do_not_match
= 1;
3444 store
.do_not_match
= 0;
3446 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
3447 if (regcomp(store
.value_pattern
, value_pattern
,
3449 error(_("invalid pattern: %s"), value_pattern
);
3450 FREE_AND_NULL(store
.value_pattern
);
3451 ret
= CONFIG_INVALID_PATTERN
;
3456 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
3457 store
.parsed
[0].end
= 0;
3459 memset(&opts
, 0, sizeof(opts
));
3460 opts
.event_fn
= store_aux_event
;
3461 opts
.event_fn_data
= &store
;
3464 * After this, store.parsed will contain offsets of all the
3465 * parsed elements, and store.seen will contain a list of
3466 * matches, as indices into store.parsed.
3468 * As a side effect, we make sure to transform only a valid
3469 * existing config file.
3471 if (git_config_from_file_with_options(store_aux
,
3473 &store
, CONFIG_SCOPE_UNKNOWN
,
3475 error(_("invalid config file %s"), config_filename
);
3476 ret
= CONFIG_INVALID_FILE
;
3480 /* if nothing to unset, or too many matches, error out */
3481 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3482 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3483 ret
= CONFIG_NOTHING_SET
;
3487 if (fstat(in_fd
, &st
) == -1) {
3488 error_errno(_("fstat on %s failed"), config_filename
);
3489 ret
= CONFIG_INVALID_FILE
;
3493 contents_sz
= xsize_t(st
.st_size
);
3494 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3495 MAP_PRIVATE
, in_fd
, 0);
3496 if (contents
== MAP_FAILED
) {
3497 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3499 error_errno(_("unable to mmap '%s'%s"),
3500 config_filename
, mmap_os_err());
3501 ret
= CONFIG_INVALID_FILE
;
3508 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3509 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3510 ret
= CONFIG_NO_WRITE
;
3514 if (store
.seen_nr
== 0) {
3515 if (!store
.seen_alloc
) {
3516 /* Did not see key nor section */
3517 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3518 store
.seen
[0] = store
.parsed_nr
3519 - !!store
.parsed_nr
;
3524 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3526 int j
= store
.seen
[i
];
3529 if (!store
.key_seen
) {
3530 copy_end
= store
.parsed
[j
].end
;
3531 /* include '\n' when copying section header */
3532 if (copy_end
> 0 && copy_end
< contents_sz
&&
3533 contents
[copy_end
- 1] != '\n' &&
3534 contents
[copy_end
] == '\n')
3536 replace_end
= copy_end
;
3538 replace_end
= store
.parsed
[j
].end
;
3539 copy_end
= store
.parsed
[j
].begin
;
3541 maybe_remove_section(&store
,
3545 * Swallow preceding white-space on the same
3548 while (copy_end
> 0 ) {
3549 char c
= contents
[copy_end
- 1];
3551 if (isspace(c
) && c
!= '\n')
3558 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3561 /* write the first part of the config */
3562 if (copy_end
> copy_begin
) {
3563 if (write_in_full(fd
, contents
+ copy_begin
,
3564 copy_end
- copy_begin
) < 0)
3567 write_str_in_full(fd
, "\n") < 0)
3570 copy_begin
= replace_end
;
3573 /* write the pair (value == NULL means unset) */
3575 if (!store
.section_seen
) {
3576 if (write_section(fd
, key
, &store
) < 0)
3579 if (write_pair(fd
, key
, value
, &store
) < 0)
3583 /* write the rest of the config */
3584 if (copy_begin
< contents_sz
)
3585 if (write_in_full(fd
, contents
+ copy_begin
,
3586 contents_sz
- copy_begin
) < 0)
3589 munmap(contents
, contents_sz
);
3593 if (commit_lock_file(&lock
) < 0) {
3594 error_errno(_("could not write config file %s"), config_filename
);
3595 ret
= CONFIG_NO_WRITE
;
3601 /* Invalidate the config cache */
3605 rollback_lock_file(&lock
);
3608 munmap(contents
, contents_sz
);
3611 config_store_data_clear(&store
);
3615 ret
= write_error(get_lock_file_path(&lock
));
3620 void git_config_set_multivar_in_file(const char *config_filename
,
3621 const char *key
, const char *value
,
3622 const char *value_pattern
, unsigned flags
)
3624 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3625 value_pattern
, flags
))
3628 die(_("could not set '%s' to '%s'"), key
, value
);
3630 die(_("could not unset '%s'"), key
);
3633 int git_config_set_multivar_gently(const char *key
, const char *value
,
3634 const char *value_pattern
, unsigned flags
)
3636 return repo_config_set_multivar_gently(the_repository
, key
, value
,
3637 value_pattern
, flags
);
3640 int repo_config_set_multivar_gently(struct repository
*r
, const char *key
,
3642 const char *value_pattern
, unsigned flags
)
3644 char *file
= repo_git_path(r
, "config");
3645 int res
= git_config_set_multivar_in_file_gently(file
,
3653 void git_config_set_multivar(const char *key
, const char *value
,
3654 const char *value_pattern
, unsigned flags
)
3656 git_config_set_multivar_in_file(git_path("config"),
3657 key
, value
, value_pattern
,
3661 static size_t section_name_match (const char *buf
, const char *name
)
3663 size_t i
= 0, j
= 0;
3667 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3668 if (!dot
&& isspace(buf
[i
])) {
3670 if (name
[j
++] != '.')
3672 for (i
++; isspace(buf
[i
]); i
++)
3678 if (buf
[i
] == '\\' && dot
)
3680 else if (buf
[i
] == '"' && dot
) {
3681 for (i
++; isspace(buf
[i
]); i
++)
3685 if (buf
[i
] != name
[j
++])
3688 if (buf
[i
] == ']' && name
[j
] == 0) {
3690 * We match, now just find the right length offset by
3691 * gobbling up any whitespace after it, as well
3694 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3701 static int section_name_is_ok(const char *name
)
3703 /* Empty section names are bogus. */
3708 * Before a dot, we must be alphanumeric or dash. After the first dot,
3709 * anything goes, so we can stop checking.
3711 for (; *name
&& *name
!= '.'; name
++)
3712 if (*name
!= '-' && !isalnum(*name
))
3717 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3719 /* if new_name == NULL, the section is removed instead */
3720 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3721 const char *old_name
,
3722 const char *new_name
, int copy
)
3724 int ret
= 0, remove
= 0;
3725 char *filename_buf
= NULL
;
3726 struct lock_file lock
= LOCK_INIT
;
3728 struct strbuf buf
= STRBUF_INIT
;
3729 FILE *config_file
= NULL
;
3731 struct strbuf copystr
= STRBUF_INIT
;
3732 struct config_store_data store
;
3733 uint32_t line_nr
= 0;
3735 memset(&store
, 0, sizeof(store
));
3737 if (new_name
&& !section_name_is_ok(new_name
)) {
3738 ret
= error(_("invalid section name: %s"), new_name
);
3739 goto out_no_rollback
;
3742 if (!config_filename
)
3743 config_filename
= filename_buf
= git_pathdup("config");
3745 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3747 ret
= error(_("could not lock config file %s"), config_filename
);
3751 if (!(config_file
= fopen(config_filename
, "rb"))) {
3752 ret
= warn_on_fopen_errors(config_filename
);
3755 /* no config file means nothing to rename, no error */
3756 goto commit_and_out
;
3759 if (fstat(fileno(config_file
), &st
) == -1) {
3760 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3764 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3765 ret
= error_errno(_("chmod on %s failed"),
3766 get_lock_file_path(&lock
));
3770 while (!strbuf_getwholeline(&buf
, config_file
, '\n')) {
3773 char *output
= buf
.buf
;
3777 if (buf
.len
>= GIT_CONFIG_MAX_LINE_LEN
) {
3778 ret
= error(_("refusing to work with overly long line "
3779 "in '%s' on line %"PRIuMAX
),
3780 config_filename
, (uintmax_t)line_nr
);
3784 for (i
= 0; buf
.buf
[i
] && isspace(buf
.buf
[i
]); i
++)
3786 if (buf
.buf
[i
] == '[') {
3787 /* it's a section */
3792 * When encountering a new section under -c we
3793 * need to flush out any section we're already
3794 * coping and begin anew. There might be
3795 * multiple [branch "$name"] sections.
3797 if (copystr
.len
> 0) {
3798 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3799 ret
= write_error(get_lock_file_path(&lock
));
3802 strbuf_reset(©str
);
3805 offset
= section_name_match(&buf
.buf
[i
], old_name
);
3812 store
.baselen
= strlen(new_name
);
3814 if (write_section(out_fd
, new_name
, &store
) < 0) {
3815 ret
= write_error(get_lock_file_path(&lock
));
3819 * We wrote out the new section, with
3820 * a newline, now skip the old
3823 output
+= offset
+ i
;
3824 if (strlen(output
) > 0) {
3826 * More content means there's
3827 * a declaration to put on the
3828 * next line; indent with a
3835 strbuf_release(©str
);
3836 copystr
= store_create_section(new_name
, &store
);
3843 length
= strlen(output
);
3845 if (!is_section
&& copystr
.len
> 0) {
3846 strbuf_add(©str
, output
, length
);
3849 if (write_in_full(out_fd
, output
, length
) < 0) {
3850 ret
= write_error(get_lock_file_path(&lock
));
3856 * Copy a trailing section at the end of the config, won't be
3857 * flushed by the usual "flush because we have a new section
3858 * logic in the loop above.
3860 if (copystr
.len
> 0) {
3861 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3862 ret
= write_error(get_lock_file_path(&lock
));
3865 strbuf_reset(©str
);
3868 fclose(config_file
);
3871 if (commit_lock_file(&lock
) < 0)
3872 ret
= error_errno(_("could not write config file %s"),
3876 fclose(config_file
);
3877 rollback_lock_file(&lock
);
3880 config_store_data_clear(&store
);
3881 strbuf_release(&buf
);
3882 strbuf_release(©str
);
3886 int git_config_rename_section_in_file(const char *config_filename
,
3887 const char *old_name
, const char *new_name
)
3889 return git_config_copy_or_rename_section_in_file(config_filename
,
3890 old_name
, new_name
, 0);
3893 int git_config_rename_section(const char *old_name
, const char *new_name
)
3895 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
3898 int git_config_copy_section_in_file(const char *config_filename
,
3899 const char *old_name
, const char *new_name
)
3901 return git_config_copy_or_rename_section_in_file(config_filename
,
3902 old_name
, new_name
, 1);
3905 int git_config_copy_section(const char *old_name
, const char *new_name
)
3907 return git_config_copy_section_in_file(NULL
, old_name
, new_name
);
3911 * Call this to report error for your variable that should not
3912 * get a boolean value (i.e. "[my] var" means "true").
3914 #undef config_error_nonbool
3915 int config_error_nonbool(const char *var
)
3917 return error(_("missing value for '%s'"), var
);
3920 int parse_config_key(const char *var
,
3921 const char *section
,
3922 const char **subsection
, size_t *subsection_len
,
3927 /* Does it start with "section." ? */
3928 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
3932 * Find the key; we don't know yet if we have a subsection, but we must
3933 * parse backwards from the end, since the subsection may have dots in
3936 dot
= strrchr(var
, '.');
3939 /* Did we have a subsection at all? */
3943 *subsection_len
= 0;
3949 *subsection
= var
+ 1;
3950 *subsection_len
= dot
- *subsection
;
3956 const char *config_origin_type_name(enum config_origin_type type
)
3959 case CONFIG_ORIGIN_BLOB
:
3961 case CONFIG_ORIGIN_FILE
:
3963 case CONFIG_ORIGIN_STDIN
:
3964 return "standard input";
3965 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
3966 return "submodule-blob";
3967 case CONFIG_ORIGIN_CMDLINE
:
3968 return "command line";
3970 BUG("unknown config origin type");
3974 const char *config_scope_name(enum config_scope scope
)
3977 case CONFIG_SCOPE_SYSTEM
:
3979 case CONFIG_SCOPE_GLOBAL
:
3981 case CONFIG_SCOPE_LOCAL
:
3983 case CONFIG_SCOPE_WORKTREE
:
3985 case CONFIG_SCOPE_COMMAND
:
3987 case CONFIG_SCOPE_SUBMODULE
:
3994 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
)
3998 for (i
= 0; i
< nr_mapping
; i
++) {
3999 const char *name
= mapping
[i
];
4001 if (name
&& !strcasecmp(var
, name
))