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"
27 #include "string-list.h"
28 #include "object-name.h"
29 #include "object-store-ll.h"
38 #include "wildmatch.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 static int pack_compression_seen
;
70 static int zlib_compression_seen
;
73 * Config that comes from trusted scopes, namely:
74 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
75 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
76 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
78 * This is declared here for code cleanliness, but unlike the other
79 * static variables, this does not hold config parser state.
81 static struct config_set protected_config
;
83 static int config_file_fgetc(struct config_source
*conf
)
85 return getc_unlocked(conf
->u
.file
);
88 static int config_file_ungetc(int c
, struct config_source
*conf
)
90 return ungetc(c
, conf
->u
.file
);
93 static long config_file_ftell(struct config_source
*conf
)
95 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 struct config_include_data
{
127 const struct config_options
*opts
;
128 const struct git_config_source
*config_source
;
129 struct repository
*repo
;
132 * All remote URLs discovered when reading all config files.
134 struct string_list
*remote_urls
;
136 #define CONFIG_INCLUDE_INIT { 0 }
138 static int git_config_include(const char *var
, const char *value
,
139 const struct config_context
*ctx
, void *data
);
141 #define MAX_INCLUDE_DEPTH 10
142 static const char include_depth_advice
[] = N_(
143 "exceeded maximum include depth (%d) while including\n"
147 "This might be due to circular includes.");
148 static int handle_path_include(const struct key_value_info
*kvi
,
150 struct config_include_data
*inc
)
153 struct strbuf buf
= STRBUF_INIT
;
157 return config_error_nonbool("include.path");
159 expanded
= interpolate_path(path
, 0);
161 return error(_("could not expand include path '%s'"), path
);
165 * Use an absolute path as-is, but interpret relative paths
166 * based on the including config file.
168 if (!is_absolute_path(path
)) {
171 if (!kvi
|| !kvi
->path
) {
172 ret
= error(_("relative config includes must come from files"));
176 slash
= find_last_dir_sep(kvi
->path
);
178 strbuf_add(&buf
, kvi
->path
, slash
- kvi
->path
+ 1);
179 strbuf_addstr(&buf
, path
);
183 if (!access_or_die(path
, R_OK
, 0)) {
184 if (++inc
->depth
> MAX_INCLUDE_DEPTH
)
185 die(_(include_depth_advice
), MAX_INCLUDE_DEPTH
, path
,
187 kvi
->filename
? kvi
->filename
:
189 ret
= git_config_from_file_with_options(git_config_include
, path
, inc
,
194 strbuf_release(&buf
);
199 static void add_trailing_starstar_for_dir(struct strbuf
*pat
)
201 if (pat
->len
&& is_dir_sep(pat
->buf
[pat
->len
- 1]))
202 strbuf_addstr(pat
, "**");
205 static int prepare_include_condition_pattern(const struct key_value_info
*kvi
,
208 struct strbuf path
= STRBUF_INIT
;
212 expanded
= interpolate_path(pat
->buf
, 1);
215 strbuf_addstr(pat
, expanded
);
219 if (pat
->buf
[0] == '.' && is_dir_sep(pat
->buf
[1])) {
222 if (!kvi
|| !kvi
->path
)
223 return error(_("relative config include "
224 "conditionals must come from files"));
226 strbuf_realpath(&path
, kvi
->path
, 1);
227 slash
= find_last_dir_sep(path
.buf
);
229 BUG("how is this possible?");
230 strbuf_splice(pat
, 0, 1, path
.buf
, slash
- path
.buf
);
231 prefix
= slash
- path
.buf
+ 1 /* slash */;
232 } else if (!is_absolute_path(pat
->buf
))
233 strbuf_insertstr(pat
, 0, "**/");
235 add_trailing_starstar_for_dir(pat
);
237 strbuf_release(&path
);
241 static int include_by_gitdir(const struct key_value_info
*kvi
,
242 const struct config_options
*opts
,
243 const char *cond
, size_t cond_len
, int icase
)
245 struct strbuf text
= STRBUF_INIT
;
246 struct strbuf pattern
= STRBUF_INIT
;
249 int already_tried_absolute
= 0;
252 git_dir
= opts
->git_dir
;
256 strbuf_realpath(&text
, git_dir
, 1);
257 strbuf_add(&pattern
, cond
, cond_len
);
258 prefix
= prepare_include_condition_pattern(kvi
, &pattern
);
266 * perform literal matching on the prefix part so that
267 * any wildcard character in it can't create side effects.
269 if (text
.len
< prefix
)
271 if (!icase
&& strncmp(pattern
.buf
, text
.buf
, prefix
))
273 if (icase
&& strncasecmp(pattern
.buf
, text
.buf
, prefix
))
277 ret
= !wildmatch(pattern
.buf
+ prefix
, text
.buf
+ prefix
,
278 WM_PATHNAME
| (icase
? WM_CASEFOLD
: 0));
280 if (!ret
&& !already_tried_absolute
) {
282 * We've tried e.g. matching gitdir:~/work, but if
283 * ~/work is a symlink to /mnt/storage/work
284 * strbuf_realpath() will expand it, so the rule won't
285 * match. Let's match against a
286 * strbuf_add_absolute_path() version of the path,
287 * which'll do the right thing
290 strbuf_add_absolute_path(&text
, git_dir
);
291 already_tried_absolute
= 1;
295 strbuf_release(&pattern
);
296 strbuf_release(&text
);
300 static int include_by_branch(const char *cond
, size_t cond_len
)
304 struct strbuf pattern
= STRBUF_INIT
;
305 const char *refname
= !the_repository
->gitdir
?
306 NULL
: refs_resolve_ref_unsafe(get_main_ref_store(the_repository
),
307 "HEAD", 0, NULL
, &flags
);
308 const char *shortname
;
310 if (!refname
|| !(flags
& REF_ISSYMREF
) ||
311 !skip_prefix(refname
, "refs/heads/", &shortname
))
314 strbuf_add(&pattern
, cond
, cond_len
);
315 add_trailing_starstar_for_dir(&pattern
);
316 ret
= !wildmatch(pattern
.buf
, shortname
, WM_PATHNAME
);
317 strbuf_release(&pattern
);
321 static int add_remote_url(const char *var
, const char *value
,
322 const struct config_context
*ctx UNUSED
, void *data
)
324 struct string_list
*remote_urls
= data
;
325 const char *remote_name
;
326 size_t remote_name_len
;
329 if (!parse_config_key(var
, "remote", &remote_name
, &remote_name_len
,
333 string_list_append(remote_urls
, value
);
337 static void populate_remote_urls(struct config_include_data
*inc
)
339 struct config_options opts
;
342 opts
.unconditional_remote_url
= 1;
344 inc
->remote_urls
= xmalloc(sizeof(*inc
->remote_urls
));
345 string_list_init_dup(inc
->remote_urls
);
346 config_with_options(add_remote_url
, inc
->remote_urls
,
347 inc
->config_source
, inc
->repo
, &opts
);
350 static int forbid_remote_url(const char *var
, const char *value UNUSED
,
351 const struct config_context
*ctx UNUSED
,
354 const char *remote_name
;
355 size_t remote_name_len
;
358 if (!parse_config_key(var
, "remote", &remote_name
, &remote_name_len
,
362 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
366 static int at_least_one_url_matches_glob(const char *glob
, int glob_len
,
367 struct string_list
*remote_urls
)
369 struct strbuf pattern
= STRBUF_INIT
;
370 struct string_list_item
*url_item
;
373 strbuf_add(&pattern
, glob
, glob_len
);
374 for_each_string_list_item(url_item
, remote_urls
) {
375 if (!wildmatch(pattern
.buf
, url_item
->string
, WM_PATHNAME
)) {
380 strbuf_release(&pattern
);
384 static int include_by_remote_url(struct config_include_data
*inc
,
385 const char *cond
, size_t cond_len
)
387 if (inc
->opts
->unconditional_remote_url
)
389 if (!inc
->remote_urls
)
390 populate_remote_urls(inc
);
391 return at_least_one_url_matches_glob(cond
, cond_len
,
395 static int include_condition_is_true(const struct key_value_info
*kvi
,
396 struct config_include_data
*inc
,
397 const char *cond
, size_t cond_len
)
399 const struct config_options
*opts
= inc
->opts
;
401 if (skip_prefix_mem(cond
, cond_len
, "gitdir:", &cond
, &cond_len
))
402 return include_by_gitdir(kvi
, opts
, cond
, cond_len
, 0);
403 else if (skip_prefix_mem(cond
, cond_len
, "gitdir/i:", &cond
, &cond_len
))
404 return include_by_gitdir(kvi
, opts
, cond
, cond_len
, 1);
405 else if (skip_prefix_mem(cond
, cond_len
, "onbranch:", &cond
, &cond_len
))
406 return include_by_branch(cond
, cond_len
);
407 else if (skip_prefix_mem(cond
, cond_len
, "hasconfig:remote.*.url:", &cond
,
409 return include_by_remote_url(inc
, cond
, cond_len
);
411 /* unknown conditionals are always false */
415 static int git_config_include(const char *var
, const char *value
,
416 const struct config_context
*ctx
,
419 struct config_include_data
*inc
= data
;
420 const char *cond
, *key
;
425 * Pass along all values, including "include" directives; this makes it
426 * possible to query information on the includes themselves.
428 ret
= inc
->fn(var
, value
, ctx
, inc
->data
);
432 if (!strcmp(var
, "include.path"))
433 ret
= handle_path_include(ctx
->kvi
, value
, inc
);
435 if (!parse_config_key(var
, "includeif", &cond
, &cond_len
, &key
) &&
436 cond
&& include_condition_is_true(ctx
->kvi
, inc
, cond
, cond_len
) &&
437 !strcmp(key
, "path")) {
438 config_fn_t old_fn
= inc
->fn
;
440 if (inc
->opts
->unconditional_remote_url
)
441 inc
->fn
= forbid_remote_url
;
442 ret
= handle_path_include(ctx
->kvi
, value
, inc
);
449 static void git_config_push_split_parameter(const char *key
, const char *value
)
451 struct strbuf env
= STRBUF_INIT
;
452 const char *old
= getenv(CONFIG_DATA_ENVIRONMENT
);
454 strbuf_addstr(&env
, old
);
455 strbuf_addch(&env
, ' ');
457 sq_quote_buf(&env
, key
);
458 strbuf_addch(&env
, '=');
460 sq_quote_buf(&env
, value
);
461 setenv(CONFIG_DATA_ENVIRONMENT
, env
.buf
, 1);
462 strbuf_release(&env
);
465 void git_config_push_parameter(const char *text
)
472 * section.subsection=with=equals.key=value
474 * we cannot tell if it means:
476 * [section "subsection=with=equals"]
482 * subsection = with=equals.key=value
484 * We parse left-to-right for the first "=", meaning we'll prefer to
485 * keep the value intact over the subsection. This is historical, but
486 * also sensible since values are more likely to contain odd or
487 * untrusted input than a section name.
489 * A missing equals is explicitly allowed (as a bool-only entry).
491 value
= strchr(text
, '=');
493 char *key
= xmemdupz(text
, value
- text
);
494 git_config_push_split_parameter(key
, value
+ 1);
497 git_config_push_split_parameter(text
, NULL
);
501 void git_config_push_env(const char *spec
)
504 const char *env_name
;
505 const char *env_value
;
507 env_name
= strrchr(spec
, '=');
509 die(_("invalid config format: %s"), spec
);
510 key
= xmemdupz(spec
, env_name
- spec
);
513 die(_("missing environment variable name for configuration '%.*s'"),
514 (int)(env_name
- spec
- 1), spec
);
516 env_value
= getenv(env_name
);
518 die(_("missing environment variable '%s' for configuration '%.*s'"),
519 env_name
, (int)(env_name
- spec
- 1), spec
);
521 git_config_push_split_parameter(key
, env_value
);
525 static inline int iskeychar(int c
)
527 return isalnum(c
) || c
== '-';
531 * Auxiliary function to sanity-check and split the key into the section
532 * identifier and variable name.
534 * Returns 0 on success, -1 when there is an invalid character in the key and
535 * -2 if there is no section name in the key.
537 * store_key - pointer to char* which will hold a copy of the key with
538 * lowercase section and variable name
539 * baselen - pointer to size_t which will hold the length of the
540 * section + subsection part, can be NULL
542 int git_config_parse_key(const char *key
, char **store_key
, size_t *baselen_
)
546 const char *last_dot
= strrchr(key
, '.');
549 * Since "key" actually contains the section name and the real
550 * key name separated by a dot, we have to know where the dot is.
553 if (last_dot
== NULL
|| last_dot
== key
) {
554 error(_("key does not contain a section: %s"), key
);
555 return -CONFIG_NO_SECTION_OR_NAME
;
559 error(_("key does not contain variable name: %s"), key
);
560 return -CONFIG_NO_SECTION_OR_NAME
;
563 baselen
= last_dot
- key
;
568 * Validate the key and while at it, lower case it for matching.
570 *store_key
= xmallocz(strlen(key
));
573 for (i
= 0; key
[i
]; i
++) {
574 unsigned char c
= key
[i
];
577 /* Leave the extended basename untouched.. */
578 if (!dot
|| i
> baselen
) {
580 (i
== baselen
+ 1 && !isalpha(c
))) {
581 error(_("invalid key: %s"), key
);
585 } else if (c
== '\n') {
586 error(_("invalid key (newline): %s"), key
);
595 FREE_AND_NULL(*store_key
);
596 return -CONFIG_INVALID_KEY
;
599 static int config_parse_pair(const char *key
, const char *value
,
600 struct key_value_info
*kvi
,
601 config_fn_t fn
, void *data
)
603 char *canonical_name
;
605 struct config_context ctx
= {
610 return error(_("empty config key"));
611 if (git_config_parse_key(key
, &canonical_name
, NULL
))
614 ret
= (fn(canonical_name
, value
, &ctx
, data
) < 0) ? -1 : 0;
615 free(canonical_name
);
620 /* for values read from `git_config_from_parameters()` */
621 void kvi_from_param(struct key_value_info
*out
)
623 out
->filename
= NULL
;
625 out
->origin_type
= CONFIG_ORIGIN_CMDLINE
;
626 out
->scope
= CONFIG_SCOPE_COMMAND
;
630 int git_config_parse_parameter(const char *text
,
631 config_fn_t fn
, void *data
)
634 struct strbuf
**pair
;
636 struct key_value_info kvi
= KVI_INIT
;
638 kvi_from_param(&kvi
);
640 pair
= strbuf_split_str(text
, '=', 2);
642 return error(_("bogus config parameter: %s"), text
);
644 if (pair
[0]->len
&& pair
[0]->buf
[pair
[0]->len
- 1] == '=') {
645 strbuf_setlen(pair
[0], pair
[0]->len
- 1);
646 value
= pair
[1] ? pair
[1]->buf
: "";
651 strbuf_trim(pair
[0]);
653 strbuf_list_free(pair
);
654 return error(_("bogus config parameter: %s"), text
);
657 ret
= config_parse_pair(pair
[0]->buf
, value
, &kvi
, fn
, data
);
658 strbuf_list_free(pair
);
662 static int parse_config_env_list(char *env
, struct key_value_info
*kvi
,
663 config_fn_t fn
, void *data
)
666 while (cur
&& *cur
) {
667 const char *key
= sq_dequote_step(cur
, &cur
);
669 return error(_("bogus format in %s"),
670 CONFIG_DATA_ENVIRONMENT
);
672 if (!cur
|| isspace(*cur
)) {
673 /* old-style 'key=value' */
674 if (git_config_parse_parameter(key
, fn
, data
) < 0)
677 else if (*cur
== '=') {
678 /* new-style 'key'='value' */
684 value
= sq_dequote_step(cur
, &cur
);
685 if (!value
|| (cur
&& !isspace(*cur
))) {
686 return error(_("bogus format in %s"),
687 CONFIG_DATA_ENVIRONMENT
);
689 } else if (!*cur
|| isspace(*cur
)) {
690 /* implicit bool: 'key'= */
693 return error(_("bogus format in %s"),
694 CONFIG_DATA_ENVIRONMENT
);
697 if (config_parse_pair(key
, value
, kvi
, fn
, data
) < 0)
702 return error(_("bogus format in %s"),
703 CONFIG_DATA_ENVIRONMENT
);
707 while (isspace(*cur
))
714 int git_config_from_parameters(config_fn_t fn
, void *data
)
717 struct strbuf envvar
= STRBUF_INIT
;
718 struct strvec to_free
= STRVEC_INIT
;
721 struct key_value_info kvi
= KVI_INIT
;
723 kvi_from_param(&kvi
);
724 env
= getenv(CONFIG_COUNT_ENVIRONMENT
);
730 count
= strtoul(env
, &endp
, 10);
732 ret
= error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT
);
735 if (count
> INT_MAX
) {
736 ret
= error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT
);
740 for (i
= 0; i
< count
; i
++) {
741 const char *key
, *value
;
743 strbuf_addf(&envvar
, "GIT_CONFIG_KEY_%d", i
);
744 key
= getenv_safe(&to_free
, envvar
.buf
);
746 ret
= error(_("missing config key %s"), envvar
.buf
);
749 strbuf_reset(&envvar
);
751 strbuf_addf(&envvar
, "GIT_CONFIG_VALUE_%d", i
);
752 value
= getenv_safe(&to_free
, envvar
.buf
);
754 ret
= error(_("missing config value %s"), envvar
.buf
);
757 strbuf_reset(&envvar
);
759 if (config_parse_pair(key
, value
, &kvi
, fn
, data
) < 0) {
766 env
= getenv(CONFIG_DATA_ENVIRONMENT
);
768 /* sq_dequote will write over it */
770 if (parse_config_env_list(envw
, &kvi
, fn
, data
) < 0) {
777 strbuf_release(&envvar
);
778 strvec_clear(&to_free
);
783 static int get_next_char(struct config_source
*cs
)
785 int c
= cs
->do_fgetc(cs
);
788 /* DOS like systems */
789 c
= cs
->do_fgetc(cs
);
792 cs
->do_ungetc(c
, cs
);
797 if (c
!= EOF
&& ++cs
->total_len
> INT_MAX
) {
799 * This is an absurdly long config file; refuse to parse
800 * further in order to protect downstream code from integer
801 * overflows. Note that we can't return an error specifically,
802 * but we can mark EOF and put trash in the return value,
803 * which will trigger a parse error.
819 static char *parse_value(struct config_source
*cs
)
821 int quote
= 0, comment
= 0;
824 strbuf_reset(&cs
->value
);
826 int c
= get_next_char(cs
);
833 strbuf_setlen(&cs
->value
, trim_len
);
834 return cs
->value
.buf
;
838 if (isspace(c
) && !quote
) {
840 trim_len
= cs
->value
.len
;
842 strbuf_addch(&cs
->value
, c
);
846 if (c
== ';' || c
== '#') {
854 c
= get_next_char(cs
);
867 /* Some characters escape as themselves */
870 /* Reject unknown escape sequences */
874 strbuf_addch(&cs
->value
, c
);
881 strbuf_addch(&cs
->value
, c
);
885 static int get_value(struct config_source
*cs
, struct key_value_info
*kvi
,
886 config_fn_t fn
, void *data
, struct strbuf
*name
)
891 struct config_context ctx
= {
895 /* Get the full name */
897 c
= get_next_char(cs
);
902 strbuf_addch(name
, tolower(c
));
905 while (c
== ' ' || c
== '\t')
906 c
= get_next_char(cs
);
912 value
= parse_value(cs
);
917 * We already consumed the \n, but we need linenr to point to
918 * the line we just parsed during the call to fn to get
919 * accurate line number in error messages.
922 kvi
->linenr
= cs
->linenr
;
923 ret
= fn(name
->buf
, value
, &ctx
, data
);
929 static int get_extended_base_var(struct config_source
*cs
, struct strbuf
*name
,
932 cs
->subsection_case_sensitive
= 0;
935 goto error_incomplete_line
;
936 c
= get_next_char(cs
);
937 } while (isspace(c
));
939 /* We require the format to be '[base "extension"]' */
942 strbuf_addch(name
, '.');
945 int c
= get_next_char(cs
);
947 goto error_incomplete_line
;
951 c
= get_next_char(cs
);
953 goto error_incomplete_line
;
955 strbuf_addch(name
, c
);
959 if (get_next_char(cs
) != ']')
962 error_incomplete_line
:
967 static int get_base_var(struct config_source
*cs
, struct strbuf
*name
)
969 cs
->subsection_case_sensitive
= 1;
971 int c
= get_next_char(cs
);
977 return get_extended_base_var(cs
, name
, c
);
978 if (!iskeychar(c
) && c
!= '.')
980 strbuf_addch(name
, tolower(c
));
984 struct parse_event_data
{
985 enum config_event_t previous_type
;
986 size_t previous_offset
;
987 const struct config_options
*opts
;
990 static int do_event(struct config_source
*cs
, enum config_event_t type
,
991 struct parse_event_data
*data
)
995 if (!data
->opts
|| !data
->opts
->event_fn
)
998 if (type
== CONFIG_EVENT_WHITESPACE
&&
999 data
->previous_type
== type
)
1002 offset
= cs
->do_ftell(cs
);
1004 * At EOF, the parser always "inserts" an extra '\n', therefore
1005 * the end offset of the event is the current file position, otherwise
1006 * we will already have advanced to the next event.
1008 if (type
!= CONFIG_EVENT_EOF
)
1011 if (data
->previous_type
!= CONFIG_EVENT_EOF
&&
1012 data
->opts
->event_fn(data
->previous_type
, data
->previous_offset
,
1013 offset
, cs
, data
->opts
->event_fn_data
) < 0)
1016 data
->previous_type
= type
;
1017 data
->previous_offset
= offset
;
1022 static void kvi_from_source(struct config_source
*cs
,
1023 enum config_scope scope
,
1024 struct key_value_info
*out
)
1026 out
->filename
= strintern(cs
->name
);
1027 out
->origin_type
= cs
->origin_type
;
1028 out
->linenr
= cs
->linenr
;
1030 out
->path
= cs
->path
;
1033 static int git_parse_source(struct config_source
*cs
, config_fn_t fn
,
1034 struct key_value_info
*kvi
, void *data
,
1035 const struct config_options
*opts
)
1039 struct strbuf
*var
= &cs
->var
;
1040 int error_return
= 0;
1041 char *error_msg
= NULL
;
1043 /* U+FEFF Byte Order Mark in UTF8 */
1044 const char *bomptr
= utf8_bom
;
1046 /* For the parser event callback */
1047 struct parse_event_data event_data
= {
1048 CONFIG_EVENT_EOF
, 0, opts
1054 c
= get_next_char(cs
);
1055 if (bomptr
&& *bomptr
) {
1056 /* We are at the file beginning; skip UTF8-encoded BOM
1057 * if present. Sane editors won't put this in on their
1058 * own, but e.g. Windows Notepad will do it happily. */
1059 if (c
== (*bomptr
& 0377)) {
1063 /* Do not tolerate partial BOM. */
1064 if (bomptr
!= utf8_bom
)
1066 /* No BOM at file beginning. Cool. */
1072 if (do_event(cs
, CONFIG_EVENT_EOF
, &event_data
) < 0)
1076 if (do_event(cs
, CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
1084 if (do_event(cs
, CONFIG_EVENT_WHITESPACE
, &event_data
) < 0)
1088 if (c
== '#' || c
== ';') {
1089 if (do_event(cs
, CONFIG_EVENT_COMMENT
, &event_data
) < 0)
1095 if (do_event(cs
, CONFIG_EVENT_SECTION
, &event_data
) < 0)
1098 /* Reset prior to determining a new stem */
1100 if (get_base_var(cs
, var
) < 0 || var
->len
< 1)
1102 strbuf_addch(var
, '.');
1109 if (do_event(cs
, CONFIG_EVENT_ENTRY
, &event_data
) < 0)
1113 * Truncate the var name back to the section header
1114 * stem prior to grabbing the suffix part of the name
1117 strbuf_setlen(var
, baselen
);
1118 strbuf_addch(var
, tolower(c
));
1119 if (get_value(cs
, kvi
, fn
, data
, var
) < 0)
1123 if (do_event(cs
, CONFIG_EVENT_ERROR
, &event_data
) < 0)
1126 switch (cs
->origin_type
) {
1127 case CONFIG_ORIGIN_BLOB
:
1128 error_msg
= xstrfmt(_("bad config line %d in blob %s"),
1129 cs
->linenr
, cs
->name
);
1131 case CONFIG_ORIGIN_FILE
:
1132 error_msg
= xstrfmt(_("bad config line %d in file %s"),
1133 cs
->linenr
, cs
->name
);
1135 case CONFIG_ORIGIN_STDIN
:
1136 error_msg
= xstrfmt(_("bad config line %d in standard input"),
1139 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1140 error_msg
= xstrfmt(_("bad config line %d in submodule-blob %s"),
1141 cs
->linenr
, cs
->name
);
1143 case CONFIG_ORIGIN_CMDLINE
:
1144 error_msg
= xstrfmt(_("bad config line %d in command line %s"),
1145 cs
->linenr
, cs
->name
);
1148 error_msg
= xstrfmt(_("bad config line %d in %s"),
1149 cs
->linenr
, cs
->name
);
1152 switch (opts
&& opts
->error_action
?
1153 opts
->error_action
:
1154 cs
->default_error_action
) {
1155 case CONFIG_ERROR_DIE
:
1156 die("%s", error_msg
);
1158 case CONFIG_ERROR_ERROR
:
1159 error_return
= error("%s", error_msg
);
1161 case CONFIG_ERROR_SILENT
:
1164 case CONFIG_ERROR_UNSET
:
1165 BUG("config error action unset");
1169 return error_return
;
1173 static void die_bad_number(const char *name
, const char *value
,
1174 const struct key_value_info
*kvi
)
1176 const char *error_type
= (errno
== ERANGE
) ?
1177 N_("out of range") : N_("invalid unit");
1178 const char *bad_numeric
= N_("bad numeric config value '%s' for '%s': %s");
1181 BUG("kvi should not be NULL");
1187 die(_(bad_numeric
), value
, name
, _(error_type
));
1189 switch (kvi
->origin_type
) {
1190 case CONFIG_ORIGIN_BLOB
:
1191 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1192 value
, name
, kvi
->filename
, _(error_type
));
1193 case CONFIG_ORIGIN_FILE
:
1194 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1195 value
, name
, kvi
->filename
, _(error_type
));
1196 case CONFIG_ORIGIN_STDIN
:
1197 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1198 value
, name
, _(error_type
));
1199 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
1200 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1201 value
, name
, kvi
->filename
, _(error_type
));
1202 case CONFIG_ORIGIN_CMDLINE
:
1203 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1204 value
, name
, kvi
->filename
, _(error_type
));
1206 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1207 value
, name
, kvi
->filename
, _(error_type
));
1211 int git_config_int(const char *name
, const char *value
,
1212 const struct key_value_info
*kvi
)
1215 if (!git_parse_int(value
, &ret
))
1216 die_bad_number(name
, value
, kvi
);
1220 int64_t git_config_int64(const char *name
, const char *value
,
1221 const struct key_value_info
*kvi
)
1224 if (!git_parse_int64(value
, &ret
))
1225 die_bad_number(name
, value
, kvi
);
1229 unsigned long git_config_ulong(const char *name
, const char *value
,
1230 const struct key_value_info
*kvi
)
1233 if (!git_parse_ulong(value
, &ret
))
1234 die_bad_number(name
, value
, kvi
);
1238 ssize_t
git_config_ssize_t(const char *name
, const char *value
,
1239 const struct key_value_info
*kvi
)
1242 if (!git_parse_ssize_t(value
, &ret
))
1243 die_bad_number(name
, value
, kvi
);
1247 static const struct fsync_component_name
{
1249 enum fsync_component component_bits
;
1250 } fsync_component_names
[] = {
1251 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT
},
1252 { "pack", FSYNC_COMPONENT_PACK
},
1253 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA
},
1254 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH
},
1255 { "index", FSYNC_COMPONENT_INDEX
},
1256 { "objects", FSYNC_COMPONENTS_OBJECTS
},
1257 { "reference", FSYNC_COMPONENT_REFERENCE
},
1258 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA
},
1259 { "committed", FSYNC_COMPONENTS_COMMITTED
},
1260 { "added", FSYNC_COMPONENTS_ADDED
},
1261 { "all", FSYNC_COMPONENTS_ALL
},
1264 static enum fsync_component
parse_fsync_components(const char *var
, const char *string
)
1266 enum fsync_component current
= FSYNC_COMPONENTS_PLATFORM_DEFAULT
;
1267 enum fsync_component positive
= 0, negative
= 0;
1276 string
= string
+ strspn(string
, ", \t\n\r");
1277 ep
= strchrnul(string
, ',');
1279 if (!strcmp(string
, "none")) {
1280 current
= FSYNC_COMPONENT_NONE
;
1284 if (*string
== '-') {
1289 warning(_("invalid value for variable %s"), var
);
1295 for (i
= 0; i
< ARRAY_SIZE(fsync_component_names
); ++i
) {
1296 const struct fsync_component_name
*n
= &fsync_component_names
[i
];
1298 if (strncmp(n
->name
, string
, len
))
1303 negative
|= n
->component_bits
;
1305 positive
|= n
->component_bits
;
1309 char *component
= xstrndup(string
, len
);
1310 warning(_("ignoring unknown core.fsync component '%s'"), component
);
1318 return (current
& ~negative
) | positive
;
1321 int git_config_bool_or_int(const char *name
, const char *value
,
1322 const struct key_value_info
*kvi
, int *is_bool
)
1324 int v
= git_parse_maybe_bool_text(value
);
1330 return git_config_int(name
, value
, kvi
);
1333 int git_config_bool(const char *name
, const char *value
)
1335 int v
= git_parse_maybe_bool(value
);
1337 die(_("bad boolean config value '%s' for '%s'"), value
, name
);
1341 int git_config_string(char **dest
, const char *var
, const char *value
)
1344 return config_error_nonbool(var
);
1345 *dest
= xstrdup(value
);
1349 int git_config_pathname(char **dest
, const char *var
, const char *value
)
1352 return config_error_nonbool(var
);
1353 *dest
= interpolate_path(value
, 0);
1355 die(_("failed to expand user dir in: '%s'"), value
);
1359 int git_config_expiry_date(timestamp_t
*timestamp
, const char *var
, const char *value
)
1362 return config_error_nonbool(var
);
1363 if (parse_expiry_date(value
, timestamp
))
1364 return error(_("'%s' for '%s' is not a valid timestamp"),
1369 int git_config_color(char *dest
, const char *var
, const char *value
)
1372 return config_error_nonbool(var
);
1373 if (color_parse(value
, dest
) < 0)
1378 static int git_default_core_config(const char *var
, const char *value
,
1379 const struct config_context
*ctx
, void *cb
)
1381 /* This needs a better name */
1382 if (!strcmp(var
, "core.filemode")) {
1383 trust_executable_bit
= git_config_bool(var
, value
);
1386 if (!strcmp(var
, "core.trustctime")) {
1387 trust_ctime
= git_config_bool(var
, value
);
1390 if (!strcmp(var
, "core.checkstat")) {
1392 return config_error_nonbool(var
);
1393 if (!strcasecmp(value
, "default"))
1395 else if (!strcasecmp(value
, "minimal"))
1398 return error(_("invalid value for '%s': '%s'"),
1402 if (!strcmp(var
, "core.quotepath")) {
1403 quote_path_fully
= git_config_bool(var
, value
);
1407 if (!strcmp(var
, "core.symlinks")) {
1408 has_symlinks
= git_config_bool(var
, value
);
1412 if (!strcmp(var
, "core.ignorecase")) {
1413 ignore_case
= git_config_bool(var
, value
);
1417 if (!strcmp(var
, "core.attributesfile")) {
1418 FREE_AND_NULL(git_attributes_file
);
1419 return git_config_pathname(&git_attributes_file
, var
, value
);
1422 if (!strcmp(var
, "core.hookspath")) {
1423 FREE_AND_NULL(git_hooks_path
);
1424 return git_config_pathname(&git_hooks_path
, var
, value
);
1427 if (!strcmp(var
, "core.bare")) {
1428 is_bare_repository_cfg
= git_config_bool(var
, value
);
1432 if (!strcmp(var
, "core.ignorestat")) {
1433 assume_unchanged
= git_config_bool(var
, value
);
1437 if (!strcmp(var
, "core.prefersymlinkrefs")) {
1438 prefer_symlink_refs
= git_config_bool(var
, value
);
1442 if (!strcmp(var
, "core.logallrefupdates")) {
1443 if (value
&& !strcasecmp(value
, "always"))
1444 log_all_ref_updates
= LOG_REFS_ALWAYS
;
1445 else if (git_config_bool(var
, value
))
1446 log_all_ref_updates
= LOG_REFS_NORMAL
;
1448 log_all_ref_updates
= LOG_REFS_NONE
;
1452 if (!strcmp(var
, "core.warnambiguousrefs")) {
1453 warn_ambiguous_refs
= git_config_bool(var
, value
);
1457 if (!strcmp(var
, "core.abbrev")) {
1459 return config_error_nonbool(var
);
1460 if (!strcasecmp(value
, "auto"))
1461 default_abbrev
= -1;
1462 else if (!git_parse_maybe_bool_text(value
))
1463 default_abbrev
= the_hash_algo
->hexsz
;
1465 int abbrev
= git_config_int(var
, value
, ctx
->kvi
);
1466 if (abbrev
< minimum_abbrev
|| abbrev
> the_hash_algo
->hexsz
)
1467 return error(_("abbrev length out of range: %d"), abbrev
);
1468 default_abbrev
= abbrev
;
1473 if (!strcmp(var
, "core.disambiguate"))
1474 return set_disambiguate_hint_config(var
, value
);
1476 if (!strcmp(var
, "core.loosecompression")) {
1477 int level
= git_config_int(var
, value
, ctx
->kvi
);
1479 level
= Z_DEFAULT_COMPRESSION
;
1480 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1481 die(_("bad zlib compression level %d"), level
);
1482 zlib_compression_level
= level
;
1483 zlib_compression_seen
= 1;
1487 if (!strcmp(var
, "core.compression")) {
1488 int level
= git_config_int(var
, value
, ctx
->kvi
);
1490 level
= Z_DEFAULT_COMPRESSION
;
1491 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1492 die(_("bad zlib compression level %d"), level
);
1493 if (!zlib_compression_seen
)
1494 zlib_compression_level
= level
;
1495 if (!pack_compression_seen
)
1496 pack_compression_level
= level
;
1500 if (!strcmp(var
, "core.packedgitwindowsize")) {
1501 int pgsz_x2
= getpagesize() * 2;
1502 packed_git_window_size
= git_config_ulong(var
, value
, ctx
->kvi
);
1504 /* This value must be multiple of (pagesize * 2) */
1505 packed_git_window_size
/= pgsz_x2
;
1506 if (packed_git_window_size
< 1)
1507 packed_git_window_size
= 1;
1508 packed_git_window_size
*= pgsz_x2
;
1512 if (!strcmp(var
, "core.bigfilethreshold")) {
1513 big_file_threshold
= git_config_ulong(var
, value
, ctx
->kvi
);
1517 if (!strcmp(var
, "core.packedgitlimit")) {
1518 packed_git_limit
= git_config_ulong(var
, value
, ctx
->kvi
);
1522 if (!strcmp(var
, "core.deltabasecachelimit")) {
1523 delta_base_cache_limit
= git_config_ulong(var
, value
, ctx
->kvi
);
1527 if (!strcmp(var
, "core.autocrlf")) {
1528 if (value
&& !strcasecmp(value
, "input")) {
1529 auto_crlf
= AUTO_CRLF_INPUT
;
1532 auto_crlf
= git_config_bool(var
, value
);
1536 if (!strcmp(var
, "core.safecrlf")) {
1538 if (value
&& !strcasecmp(value
, "warn")) {
1539 global_conv_flags_eol
= CONV_EOL_RNDTRP_WARN
;
1542 eol_rndtrp_die
= git_config_bool(var
, value
);
1543 global_conv_flags_eol
= eol_rndtrp_die
?
1544 CONV_EOL_RNDTRP_DIE
: 0;
1548 if (!strcmp(var
, "core.eol")) {
1549 if (value
&& !strcasecmp(value
, "lf"))
1551 else if (value
&& !strcasecmp(value
, "crlf"))
1552 core_eol
= EOL_CRLF
;
1553 else if (value
&& !strcasecmp(value
, "native"))
1554 core_eol
= EOL_NATIVE
;
1556 core_eol
= EOL_UNSET
;
1560 if (!strcmp(var
, "core.checkroundtripencoding")) {
1561 FREE_AND_NULL(check_roundtrip_encoding
);
1562 return git_config_string(&check_roundtrip_encoding
, var
, value
);
1565 if (!strcmp(var
, "core.notesref")) {
1567 return config_error_nonbool(var
);
1568 notes_ref_name
= xstrdup(value
);
1572 if (!strcmp(var
, "core.editor")) {
1573 FREE_AND_NULL(editor_program
);
1574 return git_config_string(&editor_program
, var
, value
);
1577 if (!strcmp(var
, "core.commentchar") ||
1578 !strcmp(var
, "core.commentstring")) {
1580 return config_error_nonbool(var
);
1581 else if (!strcasecmp(value
, "auto"))
1582 auto_comment_line_char
= 1;
1583 else if (value
[0]) {
1584 if (strchr(value
, '\n'))
1585 return error(_("%s cannot contain newline"), var
);
1586 comment_line_str
= xstrdup(value
);
1587 auto_comment_line_char
= 0;
1589 return error(_("%s must have at least one character"), var
);
1593 if (!strcmp(var
, "core.askpass")) {
1594 FREE_AND_NULL(askpass_program
);
1595 return git_config_string(&askpass_program
, var
, value
);
1598 if (!strcmp(var
, "core.excludesfile")) {
1599 FREE_AND_NULL(excludes_file
);
1600 return git_config_pathname(&excludes_file
, var
, value
);
1603 if (!strcmp(var
, "core.whitespace")) {
1605 return config_error_nonbool(var
);
1606 whitespace_rule_cfg
= parse_whitespace_rule(value
);
1610 if (!strcmp(var
, "core.fsync")) {
1612 return config_error_nonbool(var
);
1613 fsync_components
= parse_fsync_components(var
, value
);
1617 if (!strcmp(var
, "core.fsyncmethod")) {
1619 return config_error_nonbool(var
);
1620 if (!strcmp(value
, "fsync"))
1621 fsync_method
= FSYNC_METHOD_FSYNC
;
1622 else if (!strcmp(value
, "writeout-only"))
1623 fsync_method
= FSYNC_METHOD_WRITEOUT_ONLY
;
1624 else if (!strcmp(value
, "batch"))
1625 fsync_method
= FSYNC_METHOD_BATCH
;
1627 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value
);
1631 if (!strcmp(var
, "core.fsyncobjectfiles")) {
1632 if (fsync_object_files
< 0)
1633 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1634 fsync_object_files
= git_config_bool(var
, value
);
1638 if (!strcmp(var
, "core.preloadindex")) {
1639 core_preload_index
= git_config_bool(var
, value
);
1643 if (!strcmp(var
, "core.createobject")) {
1645 return config_error_nonbool(var
);
1646 if (!strcmp(value
, "rename"))
1647 object_creation_mode
= OBJECT_CREATION_USES_RENAMES
;
1648 else if (!strcmp(value
, "link"))
1649 object_creation_mode
= OBJECT_CREATION_USES_HARDLINKS
;
1651 die(_("invalid mode for object creation: %s"), value
);
1655 if (!strcmp(var
, "core.sparsecheckout")) {
1656 core_apply_sparse_checkout
= git_config_bool(var
, value
);
1660 if (!strcmp(var
, "core.sparsecheckoutcone")) {
1661 core_sparse_checkout_cone
= git_config_bool(var
, value
);
1665 if (!strcmp(var
, "core.precomposeunicode")) {
1666 precomposed_unicode
= git_config_bool(var
, value
);
1670 if (!strcmp(var
, "core.protecthfs")) {
1671 protect_hfs
= git_config_bool(var
, value
);
1675 if (!strcmp(var
, "core.protectntfs")) {
1676 protect_ntfs
= git_config_bool(var
, value
);
1680 if (!strcmp(var
, "core.maxtreedepth")) {
1681 max_allowed_tree_depth
= git_config_int(var
, value
, ctx
->kvi
);
1685 /* Add other config variables here and to Documentation/config.txt. */
1686 return platform_core_config(var
, value
, ctx
, cb
);
1689 static int git_default_sparse_config(const char *var
, const char *value
)
1691 if (!strcmp(var
, "sparse.expectfilesoutsideofpatterns")) {
1692 sparse_expect_files_outside_of_patterns
= git_config_bool(var
, value
);
1696 /* Add other config variables here and to Documentation/config/sparse.txt. */
1700 static int git_default_i18n_config(const char *var
, const char *value
)
1702 if (!strcmp(var
, "i18n.commitencoding")) {
1703 FREE_AND_NULL(git_commit_encoding
);
1704 return git_config_string(&git_commit_encoding
, var
, value
);
1707 if (!strcmp(var
, "i18n.logoutputencoding")) {
1708 FREE_AND_NULL(git_log_output_encoding
);
1709 return git_config_string(&git_log_output_encoding
, var
, value
);
1712 /* Add other config variables here and to Documentation/config.txt. */
1716 static int git_default_branch_config(const char *var
, const char *value
)
1718 if (!strcmp(var
, "branch.autosetupmerge")) {
1719 if (value
&& !strcmp(value
, "always")) {
1720 git_branch_track
= BRANCH_TRACK_ALWAYS
;
1722 } else if (value
&& !strcmp(value
, "inherit")) {
1723 git_branch_track
= BRANCH_TRACK_INHERIT
;
1725 } else if (value
&& !strcmp(value
, "simple")) {
1726 git_branch_track
= BRANCH_TRACK_SIMPLE
;
1729 git_branch_track
= git_config_bool(var
, value
);
1732 if (!strcmp(var
, "branch.autosetuprebase")) {
1734 return config_error_nonbool(var
);
1735 else if (!strcmp(value
, "never"))
1736 autorebase
= AUTOREBASE_NEVER
;
1737 else if (!strcmp(value
, "local"))
1738 autorebase
= AUTOREBASE_LOCAL
;
1739 else if (!strcmp(value
, "remote"))
1740 autorebase
= AUTOREBASE_REMOTE
;
1741 else if (!strcmp(value
, "always"))
1742 autorebase
= AUTOREBASE_ALWAYS
;
1744 return error(_("malformed value for %s"), var
);
1748 /* Add other config variables here and to Documentation/config.txt. */
1752 static int git_default_push_config(const char *var
, const char *value
)
1754 if (!strcmp(var
, "push.default")) {
1756 return config_error_nonbool(var
);
1757 else if (!strcmp(value
, "nothing"))
1758 push_default
= PUSH_DEFAULT_NOTHING
;
1759 else if (!strcmp(value
, "matching"))
1760 push_default
= PUSH_DEFAULT_MATCHING
;
1761 else if (!strcmp(value
, "simple"))
1762 push_default
= PUSH_DEFAULT_SIMPLE
;
1763 else if (!strcmp(value
, "upstream"))
1764 push_default
= PUSH_DEFAULT_UPSTREAM
;
1765 else if (!strcmp(value
, "tracking")) /* deprecated */
1766 push_default
= PUSH_DEFAULT_UPSTREAM
;
1767 else if (!strcmp(value
, "current"))
1768 push_default
= PUSH_DEFAULT_CURRENT
;
1770 error(_("malformed value for %s: %s"), var
, value
);
1771 return error(_("must be one of nothing, matching, simple, "
1772 "upstream or current"));
1777 /* Add other config variables here and to Documentation/config.txt. */
1781 static int git_default_mailmap_config(const char *var
, const char *value
)
1783 if (!strcmp(var
, "mailmap.file")) {
1784 FREE_AND_NULL(git_mailmap_file
);
1785 return git_config_pathname(&git_mailmap_file
, var
, value
);
1788 if (!strcmp(var
, "mailmap.blob")) {
1789 FREE_AND_NULL(git_mailmap_blob
);
1790 return git_config_string(&git_mailmap_blob
, var
, value
);
1793 /* Add other config variables here and to Documentation/config.txt. */
1797 static int git_default_attr_config(const char *var
, const char *value
)
1799 if (!strcmp(var
, "attr.tree")) {
1800 FREE_AND_NULL(git_attr_tree
);
1801 return git_config_string(&git_attr_tree
, var
, value
);
1805 * Add other attribute related config variables here and to
1806 * Documentation/config/attr.txt.
1811 int git_default_config(const char *var
, const char *value
,
1812 const struct config_context
*ctx
, void *cb
)
1814 if (starts_with(var
, "core."))
1815 return git_default_core_config(var
, value
, ctx
, cb
);
1817 if (starts_with(var
, "user.") ||
1818 starts_with(var
, "author.") ||
1819 starts_with(var
, "committer."))
1820 return git_ident_config(var
, value
, ctx
, cb
);
1822 if (starts_with(var
, "i18n."))
1823 return git_default_i18n_config(var
, value
);
1825 if (starts_with(var
, "branch."))
1826 return git_default_branch_config(var
, value
);
1828 if (starts_with(var
, "push."))
1829 return git_default_push_config(var
, value
);
1831 if (starts_with(var
, "mailmap."))
1832 return git_default_mailmap_config(var
, value
);
1834 if (starts_with(var
, "attr."))
1835 return git_default_attr_config(var
, value
);
1837 if (starts_with(var
, "advice.") || starts_with(var
, "color.advice"))
1838 return git_default_advice_config(var
, value
);
1840 if (!strcmp(var
, "pager.color") || !strcmp(var
, "color.pager")) {
1841 pager_use_color
= git_config_bool(var
,value
);
1845 if (!strcmp(var
, "pack.packsizelimit")) {
1846 pack_size_limit_cfg
= git_config_ulong(var
, value
, ctx
->kvi
);
1850 if (!strcmp(var
, "pack.compression")) {
1851 int level
= git_config_int(var
, value
, ctx
->kvi
);
1853 level
= Z_DEFAULT_COMPRESSION
;
1854 else if (level
< 0 || level
> Z_BEST_COMPRESSION
)
1855 die(_("bad pack compression level %d"), level
);
1856 pack_compression_level
= level
;
1857 pack_compression_seen
= 1;
1861 if (starts_with(var
, "sparse."))
1862 return git_default_sparse_config(var
, value
);
1864 /* Add other config variables here and to Documentation/config.txt. */
1869 * All source specific fields in the union, die_on_error, name and the callbacks
1870 * fgetc, ungetc, ftell of top need to be initialized before calling
1873 static int do_config_from(struct config_source
*top
, config_fn_t fn
,
1874 void *data
, enum config_scope scope
,
1875 const struct config_options
*opts
)
1877 struct key_value_info kvi
= KVI_INIT
;
1880 /* push config-file parsing state stack */
1884 strbuf_init(&top
->value
, 1024);
1885 strbuf_init(&top
->var
, 1024);
1886 kvi_from_source(top
, scope
, &kvi
);
1888 ret
= git_parse_source(top
, fn
, &kvi
, data
, opts
);
1890 strbuf_release(&top
->value
);
1891 strbuf_release(&top
->var
);
1896 static int do_config_from_file(config_fn_t fn
,
1897 const enum config_origin_type origin_type
,
1898 const char *name
, const char *path
, FILE *f
,
1899 void *data
, enum config_scope scope
,
1900 const struct config_options
*opts
)
1902 struct config_source top
= CONFIG_SOURCE_INIT
;
1906 top
.origin_type
= origin_type
;
1909 top
.default_error_action
= CONFIG_ERROR_DIE
;
1910 top
.do_fgetc
= config_file_fgetc
;
1911 top
.do_ungetc
= config_file_ungetc
;
1912 top
.do_ftell
= config_file_ftell
;
1915 ret
= do_config_from(&top
, fn
, data
, scope
, opts
);
1920 static int git_config_from_stdin(config_fn_t fn
, void *data
,
1921 enum config_scope scope
)
1923 return do_config_from_file(fn
, CONFIG_ORIGIN_STDIN
, "", NULL
, stdin
,
1927 int git_config_from_file_with_options(config_fn_t fn
, const char *filename
,
1928 void *data
, enum config_scope scope
,
1929 const struct config_options
*opts
)
1935 BUG("filename cannot be NULL");
1936 f
= fopen_or_warn(filename
, "r");
1938 ret
= do_config_from_file(fn
, CONFIG_ORIGIN_FILE
, filename
,
1939 filename
, f
, data
, scope
, opts
);
1945 int git_config_from_file(config_fn_t fn
, const char *filename
, void *data
)
1947 return git_config_from_file_with_options(fn
, filename
, data
,
1948 CONFIG_SCOPE_UNKNOWN
, NULL
);
1951 int git_config_from_mem(config_fn_t fn
,
1952 const enum config_origin_type origin_type
,
1953 const char *name
, const char *buf
, size_t len
,
1954 void *data
, enum config_scope scope
,
1955 const struct config_options
*opts
)
1957 struct config_source top
= CONFIG_SOURCE_INIT
;
1959 top
.u
.buf
.buf
= buf
;
1960 top
.u
.buf
.len
= len
;
1962 top
.origin_type
= origin_type
;
1965 top
.default_error_action
= CONFIG_ERROR_ERROR
;
1966 top
.do_fgetc
= config_buf_fgetc
;
1967 top
.do_ungetc
= config_buf_ungetc
;
1968 top
.do_ftell
= config_buf_ftell
;
1970 return do_config_from(&top
, fn
, data
, scope
, opts
);
1973 int git_config_from_blob_oid(config_fn_t fn
,
1975 struct repository
*repo
,
1976 const struct object_id
*oid
,
1978 enum config_scope scope
)
1980 enum object_type type
;
1985 buf
= repo_read_object_file(repo
, oid
, &type
, &size
);
1987 return error(_("unable to load config blob object '%s'"), name
);
1988 if (type
!= OBJ_BLOB
) {
1990 return error(_("reference '%s' does not point to a blob"), name
);
1993 ret
= git_config_from_mem(fn
, CONFIG_ORIGIN_BLOB
, name
, buf
, size
,
2000 static int git_config_from_blob_ref(config_fn_t fn
,
2001 struct repository
*repo
,
2004 enum config_scope scope
)
2006 struct object_id oid
;
2008 if (repo_get_oid(repo
, name
, &oid
) < 0)
2009 return error(_("unable to resolve config blob '%s'"), name
);
2010 return git_config_from_blob_oid(fn
, name
, repo
, &oid
, data
, scope
);
2013 char *git_system_config(void)
2015 char *system_config
= xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2017 system_config
= system_path(ETC_GITCONFIG
);
2018 normalize_path_copy(system_config
, system_config
);
2019 return system_config
;
2022 char *git_global_config(void)
2024 char *user_config
, *xdg_config
;
2026 git_global_config_paths(&user_config
, &xdg_config
);
2032 if (access_or_warn(user_config
, R_OK
, 0) && xdg_config
&&
2033 !access_or_warn(xdg_config
, R_OK
, 0)) {
2042 void git_global_config_paths(char **user_out
, char **xdg_out
)
2044 char *user_config
= xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2045 char *xdg_config
= NULL
;
2048 user_config
= interpolate_path("~/.gitconfig", 0);
2049 xdg_config
= xdg_config_home("config");
2052 *user_out
= user_config
;
2053 *xdg_out
= xdg_config
;
2056 int git_config_system(void)
2058 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2061 static int do_git_config_sequence(const struct config_options
*opts
,
2062 const struct repository
*repo
,
2063 config_fn_t fn
, void *data
)
2066 char *system_config
= git_system_config();
2067 char *xdg_config
= NULL
;
2068 char *user_config
= NULL
;
2070 char *worktree_config
;
2073 * Ensure that either:
2074 * - the git_dir and commondir are both set, or
2075 * - the git_dir and commondir are both NULL
2077 if (!opts
->git_dir
!= !opts
->commondir
)
2078 BUG("only one of commondir and git_dir is non-NULL");
2080 if (opts
->commondir
) {
2081 repo_config
= mkpathdup("%s/config", opts
->commondir
);
2082 worktree_config
= mkpathdup("%s/config.worktree", opts
->git_dir
);
2085 worktree_config
= NULL
;
2088 if (git_config_system() && system_config
&&
2089 !access_or_die(system_config
, R_OK
,
2090 opts
->system_gently
? ACCESS_EACCES_OK
: 0))
2091 ret
+= git_config_from_file_with_options(fn
, system_config
,
2092 data
, CONFIG_SCOPE_SYSTEM
,
2095 git_global_config_paths(&user_config
, &xdg_config
);
2097 if (xdg_config
&& !access_or_die(xdg_config
, R_OK
, ACCESS_EACCES_OK
))
2098 ret
+= git_config_from_file_with_options(fn
, xdg_config
, data
,
2099 CONFIG_SCOPE_GLOBAL
, NULL
);
2101 if (user_config
&& !access_or_die(user_config
, R_OK
, ACCESS_EACCES_OK
))
2102 ret
+= git_config_from_file_with_options(fn
, user_config
, data
,
2103 CONFIG_SCOPE_GLOBAL
, NULL
);
2105 if (!opts
->ignore_repo
&& repo_config
&&
2106 !access_or_die(repo_config
, R_OK
, 0))
2107 ret
+= git_config_from_file_with_options(fn
, repo_config
, data
,
2108 CONFIG_SCOPE_LOCAL
, NULL
);
2110 if (!opts
->ignore_worktree
&& worktree_config
&&
2111 repo
&& repo
->repository_format_worktree_config
&&
2112 !access_or_die(worktree_config
, R_OK
, 0)) {
2113 ret
+= git_config_from_file_with_options(fn
, worktree_config
, data
,
2114 CONFIG_SCOPE_WORKTREE
,
2118 if (!opts
->ignore_cmdline
&& git_config_from_parameters(fn
, data
) < 0)
2119 die(_("unable to parse command-line config"));
2121 free(system_config
);
2125 free(worktree_config
);
2129 int config_with_options(config_fn_t fn
, void *data
,
2130 const struct git_config_source
*config_source
,
2131 struct repository
*repo
,
2132 const struct config_options
*opts
)
2134 struct config_include_data inc
= CONFIG_INCLUDE_INIT
;
2137 if (opts
->respect_includes
) {
2142 inc
.config_source
= config_source
;
2143 fn
= git_config_include
;
2148 * If we have a specific filename, use it. Otherwise, follow the
2149 * regular lookup sequence.
2151 if (config_source
&& config_source
->use_stdin
) {
2152 ret
= git_config_from_stdin(fn
, data
, config_source
->scope
);
2153 } else if (config_source
&& config_source
->file
) {
2154 ret
= git_config_from_file_with_options(fn
, config_source
->file
,
2155 data
, config_source
->scope
,
2157 } else if (config_source
&& config_source
->blob
) {
2158 ret
= git_config_from_blob_ref(fn
, repo
, config_source
->blob
,
2159 data
, config_source
->scope
);
2161 ret
= do_git_config_sequence(opts
, repo
, fn
, data
);
2164 if (inc
.remote_urls
) {
2165 string_list_clear(inc
.remote_urls
, 0);
2166 FREE_AND_NULL(inc
.remote_urls
);
2171 static void configset_iter(struct config_set
*set
, config_fn_t fn
, void *data
)
2174 struct string_list
*values
;
2175 struct config_set_element
*entry
;
2176 struct configset_list
*list
= &set
->list
;
2177 struct config_context ctx
= CONFIG_CONTEXT_INIT
;
2179 for (i
= 0; i
< list
->nr
; i
++) {
2180 entry
= list
->items
[i
].e
;
2181 value_index
= list
->items
[i
].value_index
;
2182 values
= &entry
->value_list
;
2184 ctx
.kvi
= values
->items
[value_index
].util
;
2185 if (fn(entry
->key
, values
->items
[value_index
].string
, &ctx
, data
) < 0)
2186 git_die_config_linenr(entry
->key
,
2192 void read_early_config(config_fn_t cb
, void *data
)
2194 struct config_options opts
= {0};
2195 struct strbuf commondir
= STRBUF_INIT
;
2196 struct strbuf gitdir
= STRBUF_INIT
;
2198 opts
.respect_includes
= 1;
2200 if (have_git_dir()) {
2201 opts
.commondir
= get_git_common_dir();
2202 opts
.git_dir
= get_git_dir();
2204 * When setup_git_directory() was not yet asked to discover the
2205 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2206 * is any repository config we should use (but unlike
2207 * setup_git_directory_gently(), no global state is changed, most
2208 * notably, the current working directory is still the same after the
2211 } else if (!discover_git_directory(&commondir
, &gitdir
)) {
2212 opts
.commondir
= commondir
.buf
;
2213 opts
.git_dir
= gitdir
.buf
;
2216 config_with_options(cb
, data
, NULL
, NULL
, &opts
);
2218 strbuf_release(&commondir
);
2219 strbuf_release(&gitdir
);
2223 * Read config but only enumerate system and global settings.
2224 * Omit any repo-local, worktree-local, or command-line settings.
2226 void read_very_early_config(config_fn_t cb
, void *data
)
2228 struct config_options opts
= { 0 };
2230 opts
.respect_includes
= 1;
2231 opts
.ignore_repo
= 1;
2232 opts
.ignore_worktree
= 1;
2233 opts
.ignore_cmdline
= 1;
2234 opts
.system_gently
= 1;
2236 config_with_options(cb
, data
, NULL
, NULL
, &opts
);
2240 static int configset_find_element(struct config_set
*set
, const char *key
,
2241 struct config_set_element
**dest
)
2243 struct config_set_element k
;
2244 struct config_set_element
*found_entry
;
2245 char *normalized_key
;
2249 * `key` may come from the user, so normalize it before using it
2250 * for querying entries from the hashmap.
2252 ret
= git_config_parse_key(key
, &normalized_key
, NULL
);
2256 hashmap_entry_init(&k
.ent
, strhash(normalized_key
));
2257 k
.key
= normalized_key
;
2258 found_entry
= hashmap_get_entry(&set
->config_hash
, &k
, ent
, NULL
);
2259 free(normalized_key
);
2260 *dest
= found_entry
;
2264 static int configset_add_value(const struct key_value_info
*kvi_p
,
2265 struct config_set
*set
, const char *key
,
2268 struct config_set_element
*e
;
2269 struct string_list_item
*si
;
2270 struct configset_list_item
*l_item
;
2271 struct key_value_info
*kv_info
= xmalloc(sizeof(*kv_info
));
2274 ret
= configset_find_element(set
, key
, &e
);
2278 * Since the keys are being fed by git_config*() callback mechanism, they
2279 * are already normalized. So simply add them without any further munging.
2282 e
= xmalloc(sizeof(*e
));
2283 hashmap_entry_init(&e
->ent
, strhash(key
));
2284 e
->key
= xstrdup(key
);
2285 string_list_init_dup(&e
->value_list
);
2286 hashmap_add(&set
->config_hash
, &e
->ent
);
2288 si
= string_list_append_nodup(&e
->value_list
, xstrdup_or_null(value
));
2290 ALLOC_GROW(set
->list
.items
, set
->list
.nr
+ 1, set
->list
.alloc
);
2291 l_item
= &set
->list
.items
[set
->list
.nr
++];
2293 l_item
->value_index
= e
->value_list
.nr
- 1;
2301 static int config_set_element_cmp(const void *cmp_data UNUSED
,
2302 const struct hashmap_entry
*eptr
,
2303 const struct hashmap_entry
*entry_or_key
,
2304 const void *keydata UNUSED
)
2306 const struct config_set_element
*e1
, *e2
;
2308 e1
= container_of(eptr
, const struct config_set_element
, ent
);
2309 e2
= container_of(entry_or_key
, const struct config_set_element
, ent
);
2311 return strcmp(e1
->key
, e2
->key
);
2314 void git_configset_init(struct config_set
*set
)
2316 hashmap_init(&set
->config_hash
, config_set_element_cmp
, NULL
, 0);
2317 set
->hash_initialized
= 1;
2319 set
->list
.alloc
= 0;
2320 set
->list
.items
= NULL
;
2323 void git_configset_clear(struct config_set
*set
)
2325 struct config_set_element
*entry
;
2326 struct hashmap_iter iter
;
2327 if (!set
->hash_initialized
)
2330 hashmap_for_each_entry(&set
->config_hash
, &iter
, entry
,
2331 ent
/* member name */) {
2333 string_list_clear(&entry
->value_list
, 1);
2335 hashmap_clear_and_free(&set
->config_hash
, struct config_set_element
, ent
);
2336 set
->hash_initialized
= 0;
2337 free(set
->list
.items
);
2339 set
->list
.alloc
= 0;
2340 set
->list
.items
= NULL
;
2343 static int config_set_callback(const char *key
, const char *value
,
2344 const struct config_context
*ctx
,
2347 struct config_set
*set
= cb
;
2348 configset_add_value(ctx
->kvi
, set
, key
, value
);
2352 int git_configset_add_file(struct config_set
*set
, const char *filename
)
2354 return git_config_from_file(config_set_callback
, filename
, set
);
2357 int git_configset_get_value(struct config_set
*set
, const char *key
,
2358 const char **value
, struct key_value_info
*kvi
)
2360 const struct string_list
*values
= NULL
;
2362 struct string_list_item item
;
2364 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2365 * queried key in the files of the configset, the value returned will be the last
2366 * value in the value list for that key.
2368 if ((ret
= git_configset_get_value_multi(set
, key
, &values
)))
2371 assert(values
->nr
> 0);
2372 item
= values
->items
[values
->nr
- 1];
2373 *value
= item
.string
;
2375 *kvi
= *((struct key_value_info
*)item
.util
);
2379 int git_configset_get_value_multi(struct config_set
*set
, const char *key
,
2380 const struct string_list
**dest
)
2382 struct config_set_element
*e
;
2385 if ((ret
= configset_find_element(set
, key
, &e
)))
2389 *dest
= &e
->value_list
;
2394 static int check_multi_string(struct string_list_item
*item
, void *util
)
2396 return item
->string
? 0 : config_error_nonbool(util
);
2399 int git_configset_get_string_multi(struct config_set
*cs
, const char *key
,
2400 const struct string_list
**dest
)
2404 if ((ret
= git_configset_get_value_multi(cs
, key
, dest
)))
2406 if ((ret
= for_each_string_list((struct string_list
*)*dest
,
2407 check_multi_string
, (void *)key
)))
2413 int git_configset_get(struct config_set
*set
, const char *key
)
2415 struct config_set_element
*e
;
2418 if ((ret
= configset_find_element(set
, key
, &e
)))
2425 int git_configset_get_string(struct config_set
*set
, const char *key
, char **dest
)
2428 if (!git_configset_get_value(set
, key
, &value
, NULL
))
2429 return git_config_string(dest
, key
, value
);
2434 static int git_configset_get_string_tmp(struct config_set
*set
, const char *key
,
2438 if (!git_configset_get_value(set
, key
, &value
, NULL
)) {
2440 return config_error_nonbool(key
);
2448 int git_configset_get_int(struct config_set
*set
, const char *key
, int *dest
)
2451 struct key_value_info kvi
;
2453 if (!git_configset_get_value(set
, key
, &value
, &kvi
)) {
2454 *dest
= git_config_int(key
, value
, &kvi
);
2460 int git_configset_get_ulong(struct config_set
*set
, const char *key
, unsigned long *dest
)
2463 struct key_value_info kvi
;
2465 if (!git_configset_get_value(set
, key
, &value
, &kvi
)) {
2466 *dest
= git_config_ulong(key
, value
, &kvi
);
2472 int git_configset_get_bool(struct config_set
*set
, const char *key
, int *dest
)
2475 if (!git_configset_get_value(set
, key
, &value
, NULL
)) {
2476 *dest
= git_config_bool(key
, value
);
2482 int git_configset_get_bool_or_int(struct config_set
*set
, const char *key
,
2483 int *is_bool
, int *dest
)
2486 struct key_value_info kvi
;
2488 if (!git_configset_get_value(set
, key
, &value
, &kvi
)) {
2489 *dest
= git_config_bool_or_int(key
, value
, &kvi
, is_bool
);
2495 int git_configset_get_maybe_bool(struct config_set
*set
, const char *key
, int *dest
)
2498 if (!git_configset_get_value(set
, key
, &value
, NULL
)) {
2499 *dest
= git_parse_maybe_bool(value
);
2507 int git_configset_get_pathname(struct config_set
*set
, const char *key
, char **dest
)
2510 if (!git_configset_get_value(set
, key
, &value
, NULL
))
2511 return git_config_pathname(dest
, key
, value
);
2516 /* Functions use to read configuration from a repository */
2517 static void repo_read_config(struct repository
*repo
)
2519 struct config_options opts
= { 0 };
2521 opts
.respect_includes
= 1;
2522 opts
.commondir
= repo
->commondir
;
2523 opts
.git_dir
= repo
->gitdir
;
2526 CALLOC_ARRAY(repo
->config
, 1);
2528 git_configset_clear(repo
->config
);
2530 git_configset_init(repo
->config
);
2531 if (config_with_options(config_set_callback
, repo
->config
, NULL
,
2534 * config_with_options() normally returns only
2535 * zero, as most errors are fatal, and
2536 * non-fatal potential errors are guarded by "if"
2537 * statements that are entered only when no error is
2540 * If we ever encounter a non-fatal error, it means
2541 * something went really wrong and we should stop
2544 die(_("unknown error occurred while reading the configuration files"));
2547 static void git_config_check_init(struct repository
*repo
)
2549 if (repo
->config
&& repo
->config
->hash_initialized
)
2551 repo_read_config(repo
);
2554 static void repo_config_clear(struct repository
*repo
)
2556 if (!repo
->config
|| !repo
->config
->hash_initialized
)
2558 git_configset_clear(repo
->config
);
2561 void repo_config(struct repository
*repo
, config_fn_t fn
, void *data
)
2563 git_config_check_init(repo
);
2564 configset_iter(repo
->config
, fn
, data
);
2567 int repo_config_get(struct repository
*repo
, const char *key
)
2569 git_config_check_init(repo
);
2570 return git_configset_get(repo
->config
, key
);
2573 int repo_config_get_value(struct repository
*repo
,
2574 const char *key
, const char **value
)
2576 git_config_check_init(repo
);
2577 return git_configset_get_value(repo
->config
, key
, value
, NULL
);
2580 int repo_config_get_value_multi(struct repository
*repo
, const char *key
,
2581 const struct string_list
**dest
)
2583 git_config_check_init(repo
);
2584 return git_configset_get_value_multi(repo
->config
, key
, dest
);
2587 int repo_config_get_string_multi(struct repository
*repo
, const char *key
,
2588 const struct string_list
**dest
)
2590 git_config_check_init(repo
);
2591 return git_configset_get_string_multi(repo
->config
, key
, dest
);
2594 int repo_config_get_string(struct repository
*repo
,
2595 const char *key
, char **dest
)
2598 git_config_check_init(repo
);
2599 ret
= git_configset_get_string(repo
->config
, key
, dest
);
2601 git_die_config(key
, NULL
);
2605 int repo_config_get_string_tmp(struct repository
*repo
,
2606 const char *key
, const char **dest
)
2609 git_config_check_init(repo
);
2610 ret
= git_configset_get_string_tmp(repo
->config
, key
, dest
);
2612 git_die_config(key
, NULL
);
2616 int repo_config_get_int(struct repository
*repo
,
2617 const char *key
, int *dest
)
2619 git_config_check_init(repo
);
2620 return git_configset_get_int(repo
->config
, key
, dest
);
2623 int repo_config_get_ulong(struct repository
*repo
,
2624 const char *key
, unsigned long *dest
)
2626 git_config_check_init(repo
);
2627 return git_configset_get_ulong(repo
->config
, key
, dest
);
2630 int repo_config_get_bool(struct repository
*repo
,
2631 const char *key
, int *dest
)
2633 git_config_check_init(repo
);
2634 return git_configset_get_bool(repo
->config
, key
, dest
);
2637 int repo_config_get_bool_or_int(struct repository
*repo
,
2638 const char *key
, int *is_bool
, int *dest
)
2640 git_config_check_init(repo
);
2641 return git_configset_get_bool_or_int(repo
->config
, key
, is_bool
, dest
);
2644 int repo_config_get_maybe_bool(struct repository
*repo
,
2645 const char *key
, int *dest
)
2647 git_config_check_init(repo
);
2648 return git_configset_get_maybe_bool(repo
->config
, key
, dest
);
2651 int repo_config_get_pathname(struct repository
*repo
,
2652 const char *key
, char **dest
)
2655 git_config_check_init(repo
);
2656 ret
= git_configset_get_pathname(repo
->config
, key
, dest
);
2658 git_die_config(key
, NULL
);
2662 /* Read values into protected_config. */
2663 static void read_protected_config(void)
2665 struct config_options opts
= {
2666 .respect_includes
= 1,
2668 .ignore_worktree
= 1,
2672 git_configset_init(&protected_config
);
2673 config_with_options(config_set_callback
, &protected_config
, NULL
,
2677 void git_protected_config(config_fn_t fn
, void *data
)
2679 if (!protected_config
.hash_initialized
)
2680 read_protected_config();
2681 configset_iter(&protected_config
, fn
, data
);
2684 /* Functions used historically to read configuration from 'the_repository' */
2685 void git_config(config_fn_t fn
, void *data
)
2687 repo_config(the_repository
, fn
, data
);
2690 void git_config_clear(void)
2692 repo_config_clear(the_repository
);
2695 int git_config_get(const char *key
)
2697 return repo_config_get(the_repository
, key
);
2700 int git_config_get_value(const char *key
, const char **value
)
2702 return repo_config_get_value(the_repository
, key
, value
);
2705 int git_config_get_value_multi(const char *key
, const struct string_list
**dest
)
2707 return repo_config_get_value_multi(the_repository
, key
, dest
);
2710 int git_config_get_string_multi(const char *key
,
2711 const struct string_list
**dest
)
2713 return repo_config_get_string_multi(the_repository
, key
, dest
);
2716 int git_config_get_string(const char *key
, char **dest
)
2718 return repo_config_get_string(the_repository
, key
, dest
);
2721 int git_config_get_string_tmp(const char *key
, const char **dest
)
2723 return repo_config_get_string_tmp(the_repository
, key
, dest
);
2726 int git_config_get_int(const char *key
, int *dest
)
2728 return repo_config_get_int(the_repository
, key
, dest
);
2731 int git_config_get_ulong(const char *key
, unsigned long *dest
)
2733 return repo_config_get_ulong(the_repository
, key
, dest
);
2736 int git_config_get_bool(const char *key
, int *dest
)
2738 return repo_config_get_bool(the_repository
, key
, dest
);
2741 int git_config_get_bool_or_int(const char *key
, int *is_bool
, int *dest
)
2743 return repo_config_get_bool_or_int(the_repository
, key
, is_bool
, dest
);
2746 int git_config_get_maybe_bool(const char *key
, int *dest
)
2748 return repo_config_get_maybe_bool(the_repository
, key
, dest
);
2751 int git_config_get_pathname(const char *key
, char **dest
)
2753 return repo_config_get_pathname(the_repository
, key
, dest
);
2756 int git_config_get_expiry(const char *key
, const char **output
)
2758 int ret
= git_config_get_string(key
, (char **)output
);
2761 if (strcmp(*output
, "now")) {
2762 timestamp_t now
= approxidate("now");
2763 if (approxidate(*output
) >= now
)
2764 git_die_config(key
, _("Invalid %s: '%s'"), key
, *output
);
2769 int git_config_get_expiry_in_days(const char *key
, timestamp_t
*expiry
, timestamp_t now
)
2771 const char *expiry_string
;
2775 if (git_config_get_string_tmp(key
, &expiry_string
))
2776 return 1; /* no such thing */
2778 if (git_parse_signed(expiry_string
, &days
, maximum_signed_value_of_type(int))) {
2779 const int scale
= 86400;
2780 *expiry
= now
- days
* scale
;
2784 if (!parse_expiry_date(expiry_string
, &when
)) {
2788 return -1; /* thing exists but cannot be parsed */
2791 int git_config_get_split_index(void)
2795 if (!git_config_get_maybe_bool("core.splitindex", &val
))
2798 return -1; /* default value */
2801 int git_config_get_max_percent_split_change(void)
2805 if (!git_config_get_int("splitindex.maxpercentchange", &val
)) {
2806 if (0 <= val
&& val
<= 100)
2809 return error(_("splitIndex.maxPercentChange value '%d' "
2810 "should be between 0 and 100"), val
);
2813 return -1; /* default value */
2816 int git_config_get_index_threads(int *dest
)
2820 val
= git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2826 if (!git_config_get_bool_or_int("index.threads", &is_bool
, &val
)) {
2828 *dest
= val
? 0 : 1;
2838 void git_die_config_linenr(const char *key
, const char *filename
, int linenr
)
2841 die(_("unable to parse '%s' from command-line config"), key
);
2843 die(_("bad config variable '%s' in file '%s' at line %d"),
2844 key
, filename
, linenr
);
2847 NORETURN
__attribute__((format(printf
, 2, 3)))
2848 void git_die_config(const char *key
, const char *err
, ...)
2850 const struct string_list
*values
;
2851 struct key_value_info
*kv_info
;
2852 report_fn error_fn
= get_error_routine();
2856 va_start(params
, err
);
2857 error_fn(err
, params
);
2860 if (git_config_get_value_multi(key
, &values
))
2861 BUG("for key '%s' we must have a value to report on", key
);
2862 kv_info
= values
->items
[values
->nr
- 1].util
;
2863 git_die_config_linenr(key
, kv_info
->filename
, kv_info
->linenr
);
2867 * Find all the stuff for git_config_set() below.
2870 struct config_store_data
{
2874 const char *fixed_value
;
2875 regex_t
*value_pattern
;
2879 enum config_event_t type
;
2880 int is_keys_section
;
2882 unsigned int parsed_nr
, parsed_alloc
, *seen
, seen_nr
, seen_alloc
;
2883 unsigned int key_seen
:1, section_seen
:1, is_keys_section
:1;
2885 #define CONFIG_STORE_INIT { 0 }
2887 static void config_store_data_clear(struct config_store_data
*store
)
2890 if (store
->value_pattern
!= NULL
&&
2891 store
->value_pattern
!= CONFIG_REGEX_NONE
) {
2892 regfree(store
->value_pattern
);
2893 free(store
->value_pattern
);
2895 free(store
->parsed
);
2897 memset(store
, 0, sizeof(*store
));
2900 static int matches(const char *key
, const char *value
,
2901 const struct config_store_data
*store
)
2903 if (strcmp(key
, store
->key
))
2904 return 0; /* not ours */
2905 if (store
->fixed_value
)
2906 return !strcmp(store
->fixed_value
, value
);
2907 if (!store
->value_pattern
)
2908 return 1; /* always matches */
2909 if (store
->value_pattern
== CONFIG_REGEX_NONE
)
2910 return 0; /* never matches */
2912 return store
->do_not_match
^
2913 (value
&& !regexec(store
->value_pattern
, value
, 0, NULL
, 0));
2916 static int store_aux_event(enum config_event_t type
, size_t begin
, size_t end
,
2917 struct config_source
*cs
, void *data
)
2919 struct config_store_data
*store
= data
;
2921 ALLOC_GROW(store
->parsed
, store
->parsed_nr
+ 1, store
->parsed_alloc
);
2922 store
->parsed
[store
->parsed_nr
].begin
= begin
;
2923 store
->parsed
[store
->parsed_nr
].end
= end
;
2924 store
->parsed
[store
->parsed_nr
].type
= type
;
2926 if (type
== CONFIG_EVENT_SECTION
) {
2927 int (*cmpfn
)(const char *, const char *, size_t);
2929 if (cs
->var
.len
< 2 || cs
->var
.buf
[cs
->var
.len
- 1] != '.')
2930 return error(_("invalid section name '%s'"), cs
->var
.buf
);
2932 if (cs
->subsection_case_sensitive
)
2933 cmpfn
= strncasecmp
;
2937 /* Is this the section we were looking for? */
2938 store
->is_keys_section
=
2939 store
->parsed
[store
->parsed_nr
].is_keys_section
=
2940 cs
->var
.len
- 1 == store
->baselen
&&
2941 !cmpfn(cs
->var
.buf
, store
->key
, store
->baselen
);
2942 if (store
->is_keys_section
) {
2943 store
->section_seen
= 1;
2944 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2946 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2955 static int store_aux(const char *key
, const char *value
,
2956 const struct config_context
*ctx UNUSED
, void *cb
)
2958 struct config_store_data
*store
= cb
;
2960 if (store
->key_seen
) {
2961 if (matches(key
, value
, store
)) {
2962 if (store
->seen_nr
== 1 && store
->multi_replace
== 0) {
2963 warning(_("%s has multiple values"), key
);
2966 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1,
2969 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2972 } else if (store
->is_keys_section
) {
2974 * Do not increment matches yet: this may not be a match, but we
2975 * are in the desired section.
2977 ALLOC_GROW(store
->seen
, store
->seen_nr
+ 1, store
->seen_alloc
);
2978 store
->seen
[store
->seen_nr
] = store
->parsed_nr
;
2979 store
->section_seen
= 1;
2981 if (matches(key
, value
, store
)) {
2983 store
->key_seen
= 1;
2990 static int write_error(const char *filename
)
2992 error(_("failed to write new configuration file %s"), filename
);
2994 /* Same error code as "failed to rename". */
2998 static struct strbuf
store_create_section(const char *key
,
2999 const struct config_store_data
*store
)
3003 struct strbuf sb
= STRBUF_INIT
;
3005 dot
= memchr(key
, '.', store
->baselen
);
3007 strbuf_addf(&sb
, "[%.*s \"", (int)(dot
- key
), key
);
3008 for (i
= dot
- key
+ 1; i
< store
->baselen
; i
++) {
3009 if (key
[i
] == '"' || key
[i
] == '\\')
3010 strbuf_addch(&sb
, '\\');
3011 strbuf_addch(&sb
, key
[i
]);
3013 strbuf_addstr(&sb
, "\"]\n");
3015 strbuf_addch(&sb
, '[');
3016 strbuf_add(&sb
, key
, store
->baselen
);
3017 strbuf_addstr(&sb
, "]\n");
3023 static ssize_t
write_section(int fd
, const char *key
,
3024 const struct config_store_data
*store
)
3026 struct strbuf sb
= store_create_section(key
, store
);
3029 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
3030 strbuf_release(&sb
);
3035 static ssize_t
write_pair(int fd
, const char *key
, const char *value
,
3036 const char *comment
,
3037 const struct config_store_data
*store
)
3041 const char *quote
= "";
3042 struct strbuf sb
= STRBUF_INIT
;
3045 * Check to see if the value needs to be surrounded with a dq pair.
3046 * Note that problematic characters are always backslash-quoted; this
3047 * check is about not losing leading or trailing SP and strings that
3048 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3049 * configuration parser.
3051 if (value
[0] == ' ')
3053 for (i
= 0; value
[i
]; i
++)
3054 if (value
[i
] == ';' || value
[i
] == '#')
3056 if (i
&& value
[i
- 1] == ' ')
3059 strbuf_addf(&sb
, "\t%s = %s", key
+ store
->baselen
+ 1, quote
);
3061 for (i
= 0; value
[i
]; i
++)
3064 strbuf_addstr(&sb
, "\\n");
3067 strbuf_addstr(&sb
, "\\t");
3071 strbuf_addch(&sb
, '\\');
3074 strbuf_addch(&sb
, value
[i
]);
3079 strbuf_addf(&sb
, "%s%s\n", quote
, comment
);
3081 strbuf_addf(&sb
, "%s\n", quote
);
3083 ret
= write_in_full(fd
, sb
.buf
, sb
.len
);
3084 strbuf_release(&sb
);
3090 * If we are about to unset the last key(s) in a section, and if there are
3091 * no comments surrounding (or included in) the section, we will want to
3092 * extend begin/end to remove the entire section.
3094 * Note: the parameter `seen_ptr` points to the index into the store.seen
3095 * array. * This index may be incremented if a section has more than one
3096 * entry (which all are to be removed).
3098 static void maybe_remove_section(struct config_store_data
*store
,
3099 size_t *begin_offset
, size_t *end_offset
,
3103 int i
, seen
, section_seen
= 0;
3106 * First, ensure that this is the first key, and that there are no
3107 * comments before the entry nor before the section header.
3110 for (i
= store
->seen
[seen
]; i
> 0; i
--) {
3111 enum config_event_t type
= store
->parsed
[i
- 1].type
;
3113 if (type
== CONFIG_EVENT_COMMENT
)
3114 /* There is a comment before this entry or section */
3116 if (type
== CONFIG_EVENT_ENTRY
) {
3118 /* This is not the section's first entry. */
3120 /* We encountered no comment before the section. */
3123 if (type
== CONFIG_EVENT_SECTION
) {
3124 if (!store
->parsed
[i
- 1].is_keys_section
)
3129 begin
= store
->parsed
[i
].begin
;
3132 * Next, make sure that we are removing the last key(s) in the section,
3133 * and that there are no comments that are possibly about the current
3136 for (i
= store
->seen
[seen
] + 1; i
< store
->parsed_nr
; i
++) {
3137 enum config_event_t type
= store
->parsed
[i
].type
;
3139 if (type
== CONFIG_EVENT_COMMENT
)
3141 if (type
== CONFIG_EVENT_SECTION
) {
3142 if (store
->parsed
[i
].is_keys_section
)
3146 if (type
== CONFIG_EVENT_ENTRY
) {
3147 if (++seen
< store
->seen_nr
&&
3148 i
== store
->seen
[seen
])
3149 /* We want to remove this entry, too */
3151 /* There is another entry in this section. */
3157 * We are really removing the last entry/entries from this section, and
3158 * there are no enclosed or surrounding comments. Remove the entire,
3159 * now-empty section.
3162 *begin_offset
= begin
;
3163 if (i
< store
->parsed_nr
)
3164 *end_offset
= store
->parsed
[i
].begin
;
3166 *end_offset
= store
->parsed
[store
->parsed_nr
- 1].end
;
3169 int git_config_set_in_file_gently(const char *config_filename
,
3170 const char *key
, const char *comment
, const char *value
)
3172 return git_config_set_multivar_in_file_gently(config_filename
, key
, value
, NULL
, comment
, 0);
3175 void git_config_set_in_file(const char *config_filename
,
3176 const char *key
, const char *value
)
3178 git_config_set_multivar_in_file(config_filename
, key
, value
, NULL
, 0);
3181 int git_config_set_gently(const char *key
, const char *value
)
3183 return git_config_set_multivar_gently(key
, value
, NULL
, 0);
3186 int repo_config_set_worktree_gently(struct repository
*r
,
3187 const char *key
, const char *value
)
3189 /* Only use worktree-specific config if it is already enabled. */
3190 if (r
->repository_format_worktree_config
) {
3191 char *file
= repo_git_path(r
, "config.worktree");
3192 int ret
= git_config_set_multivar_in_file_gently(
3193 file
, key
, value
, NULL
, NULL
, 0);
3197 return repo_config_set_multivar_gently(r
, key
, value
, NULL
, 0);
3200 void git_config_set(const char *key
, const char *value
)
3202 git_config_set_multivar(key
, value
, NULL
, 0);
3204 trace2_cmd_set_config(key
, value
);
3207 char *git_config_prepare_comment_string(const char *comment
)
3209 size_t leading_blanks
;
3215 if (strchr(comment
, '\n'))
3216 die(_("no multi-line comment allowed: '%s'"), comment
);
3219 * If it begins with one or more leading whitespace characters
3220 * followed by '#", the comment string is used as-is.
3222 * If it begins with '#', a SP is inserted between the comment
3223 * and the value the comment is about.
3225 * Otherwise, the value is followed by a SP followed by '#'
3226 * followed by SP and then the comment string comes.
3229 leading_blanks
= strspn(comment
, " \t");
3230 if (leading_blanks
&& comment
[leading_blanks
] == '#')
3231 prepared
= xstrdup(comment
); /* use it as-is */
3232 else if (comment
[0] == '#')
3233 prepared
= xstrfmt(" %s", comment
);
3235 prepared
= xstrfmt(" # %s", comment
);
3240 static void validate_comment_string(const char *comment
)
3242 size_t leading_blanks
;
3247 * The front-end must have massaged the comment string
3248 * properly before calling us.
3250 if (strchr(comment
, '\n'))
3251 BUG("multi-line comments are not permitted: '%s'", comment
);
3253 leading_blanks
= strspn(comment
, " \t");
3254 if (!leading_blanks
|| comment
[leading_blanks
] != '#')
3255 BUG("comment must begin with one or more SP followed by '#': '%s'",
3260 * If value==NULL, unset in (remove from) config,
3261 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3262 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3263 * (only add a new one)
3264 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3265 * key/values are removed before a single new pair is written. If the
3266 * flag is not present, then replace only the first match.
3268 * Returns 0 on success.
3270 * This function does this:
3272 * - it locks the config file by creating ".git/config.lock"
3274 * - it then parses the config using store_aux() as validator to find
3275 * the position on the key/value pair to replace. If it is to be unset,
3276 * it must be found exactly once.
3278 * - the config file is mmap()ed and the part before the match (if any) is
3279 * written to the lock file, then the changed part and the rest.
3281 * - the config file is removed and the lock file rename()d to it.
3284 int git_config_set_multivar_in_file_gently(const char *config_filename
,
3285 const char *key
, const char *value
,
3286 const char *value_pattern
,
3287 const char *comment
,
3290 int fd
= -1, in_fd
= -1;
3292 struct lock_file lock
= LOCK_INIT
;
3293 char *filename_buf
= NULL
;
3294 char *contents
= NULL
;
3296 struct config_store_data store
= CONFIG_STORE_INIT
;
3298 validate_comment_string(comment
);
3300 /* parse-key returns negative; flip the sign to feed exit(3) */
3301 ret
= 0 - git_config_parse_key(key
, &store
.key
, &store
.baselen
);
3305 store
.multi_replace
= (flags
& CONFIG_FLAGS_MULTI_REPLACE
) != 0;
3307 if (!config_filename
)
3308 config_filename
= filename_buf
= git_pathdup("config");
3311 * The lock serves a purpose in addition to locking: the new
3312 * contents of .git/config will be written into it.
3314 fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3316 error_errno(_("could not lock config file %s"), config_filename
);
3317 ret
= CONFIG_NO_LOCK
;
3322 * If .git/config does not exist yet, write a minimal version.
3324 in_fd
= open(config_filename
, O_RDONLY
);
3326 if ( ENOENT
!= errno
) {
3327 error_errno(_("opening %s"), config_filename
);
3328 ret
= CONFIG_INVALID_FILE
; /* same as "invalid config file" */
3331 /* if nothing to unset, error out */
3333 ret
= CONFIG_NOTHING_SET
;
3338 store
.key
= xstrdup(key
);
3339 if (write_section(fd
, key
, &store
) < 0 ||
3340 write_pair(fd
, key
, value
, comment
, &store
) < 0)
3344 size_t copy_begin
, copy_end
;
3345 int i
, new_line
= 0;
3346 struct config_options opts
;
3349 store
.value_pattern
= NULL
;
3350 else if (value_pattern
== CONFIG_REGEX_NONE
)
3351 store
.value_pattern
= CONFIG_REGEX_NONE
;
3352 else if (flags
& CONFIG_FLAGS_FIXED_VALUE
)
3353 store
.fixed_value
= value_pattern
;
3355 if (value_pattern
[0] == '!') {
3356 store
.do_not_match
= 1;
3359 store
.do_not_match
= 0;
3361 store
.value_pattern
= (regex_t
*)xmalloc(sizeof(regex_t
));
3362 if (regcomp(store
.value_pattern
, value_pattern
,
3364 error(_("invalid pattern: %s"), value_pattern
);
3365 FREE_AND_NULL(store
.value_pattern
);
3366 ret
= CONFIG_INVALID_PATTERN
;
3371 ALLOC_GROW(store
.parsed
, 1, store
.parsed_alloc
);
3372 store
.parsed
[0].end
= 0;
3374 memset(&opts
, 0, sizeof(opts
));
3375 opts
.event_fn
= store_aux_event
;
3376 opts
.event_fn_data
= &store
;
3379 * After this, store.parsed will contain offsets of all the
3380 * parsed elements, and store.seen will contain a list of
3381 * matches, as indices into store.parsed.
3383 * As a side effect, we make sure to transform only a valid
3384 * existing config file.
3386 if (git_config_from_file_with_options(store_aux
,
3388 &store
, CONFIG_SCOPE_UNKNOWN
,
3390 error(_("invalid config file %s"), config_filename
);
3391 ret
= CONFIG_INVALID_FILE
;
3395 /* if nothing to unset, or too many matches, error out */
3396 if ((store
.seen_nr
== 0 && value
== NULL
) ||
3397 (store
.seen_nr
> 1 && !store
.multi_replace
)) {
3398 ret
= CONFIG_NOTHING_SET
;
3402 if (fstat(in_fd
, &st
) == -1) {
3403 error_errno(_("fstat on %s failed"), config_filename
);
3404 ret
= CONFIG_INVALID_FILE
;
3408 contents_sz
= xsize_t(st
.st_size
);
3409 contents
= xmmap_gently(NULL
, contents_sz
, PROT_READ
,
3410 MAP_PRIVATE
, in_fd
, 0);
3411 if (contents
== MAP_FAILED
) {
3412 if (errno
== ENODEV
&& S_ISDIR(st
.st_mode
))
3414 error_errno(_("unable to mmap '%s'%s"),
3415 config_filename
, mmap_os_err());
3416 ret
= CONFIG_INVALID_FILE
;
3423 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3424 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock
));
3425 ret
= CONFIG_NO_WRITE
;
3429 if (store
.seen_nr
== 0) {
3430 if (!store
.seen_alloc
) {
3431 /* Did not see key nor section */
3432 ALLOC_GROW(store
.seen
, 1, store
.seen_alloc
);
3433 store
.seen
[0] = store
.parsed_nr
3434 - !!store
.parsed_nr
;
3439 for (i
= 0, copy_begin
= 0; i
< store
.seen_nr
; i
++) {
3441 int j
= store
.seen
[i
];
3444 if (!store
.key_seen
) {
3445 copy_end
= store
.parsed
[j
].end
;
3446 /* include '\n' when copying section header */
3447 if (copy_end
> 0 && copy_end
< contents_sz
&&
3448 contents
[copy_end
- 1] != '\n' &&
3449 contents
[copy_end
] == '\n')
3451 replace_end
= copy_end
;
3453 replace_end
= store
.parsed
[j
].end
;
3454 copy_end
= store
.parsed
[j
].begin
;
3456 maybe_remove_section(&store
,
3460 * Swallow preceding white-space on the same
3463 while (copy_end
> 0 ) {
3464 char c
= contents
[copy_end
- 1];
3466 if (isspace(c
) && c
!= '\n')
3473 if (copy_end
> 0 && contents
[copy_end
-1] != '\n')
3476 /* write the first part of the config */
3477 if (copy_end
> copy_begin
) {
3478 if (write_in_full(fd
, contents
+ copy_begin
,
3479 copy_end
- copy_begin
) < 0)
3482 write_str_in_full(fd
, "\n") < 0)
3485 copy_begin
= replace_end
;
3488 /* write the pair (value == NULL means unset) */
3490 if (!store
.section_seen
) {
3491 if (write_section(fd
, key
, &store
) < 0)
3494 if (write_pair(fd
, key
, value
, comment
, &store
) < 0)
3498 /* write the rest of the config */
3499 if (copy_begin
< contents_sz
)
3500 if (write_in_full(fd
, contents
+ copy_begin
,
3501 contents_sz
- copy_begin
) < 0)
3504 munmap(contents
, contents_sz
);
3508 if (commit_lock_file(&lock
) < 0) {
3509 error_errno(_("could not write config file %s"), config_filename
);
3510 ret
= CONFIG_NO_WRITE
;
3516 /* Invalidate the config cache */
3520 rollback_lock_file(&lock
);
3523 munmap(contents
, contents_sz
);
3526 config_store_data_clear(&store
);
3530 ret
= write_error(get_lock_file_path(&lock
));
3534 void git_config_set_multivar_in_file(const char *config_filename
,
3535 const char *key
, const char *value
,
3536 const char *value_pattern
, unsigned flags
)
3538 if (!git_config_set_multivar_in_file_gently(config_filename
, key
, value
,
3539 value_pattern
, NULL
, flags
))
3542 die(_("could not set '%s' to '%s'"), key
, value
);
3544 die(_("could not unset '%s'"), key
);
3547 int git_config_set_multivar_gently(const char *key
, const char *value
,
3548 const char *value_pattern
, unsigned flags
)
3550 return repo_config_set_multivar_gently(the_repository
, key
, value
,
3551 value_pattern
, flags
);
3554 int repo_config_set_multivar_gently(struct repository
*r
, const char *key
,
3556 const char *value_pattern
, unsigned flags
)
3558 char *file
= repo_git_path(r
, "config");
3559 int res
= git_config_set_multivar_in_file_gently(file
,
3567 void git_config_set_multivar(const char *key
, const char *value
,
3568 const char *value_pattern
, unsigned flags
)
3570 git_config_set_multivar_in_file(git_path("config"),
3571 key
, value
, value_pattern
,
3575 static size_t section_name_match (const char *buf
, const char *name
)
3577 size_t i
= 0, j
= 0;
3581 for (i
= 1; buf
[i
] && buf
[i
] != ']'; i
++) {
3582 if (!dot
&& isspace(buf
[i
])) {
3584 if (name
[j
++] != '.')
3586 for (i
++; isspace(buf
[i
]); i
++)
3592 if (buf
[i
] == '\\' && dot
)
3594 else if (buf
[i
] == '"' && dot
) {
3595 for (i
++; isspace(buf
[i
]); i
++)
3599 if (buf
[i
] != name
[j
++])
3602 if (buf
[i
] == ']' && name
[j
] == 0) {
3604 * We match, now just find the right length offset by
3605 * gobbling up any whitespace after it, as well
3608 for (; buf
[i
] && isspace(buf
[i
]); i
++)
3615 static int section_name_is_ok(const char *name
)
3617 /* Empty section names are bogus. */
3622 * Before a dot, we must be alphanumeric or dash. After the first dot,
3623 * anything goes, so we can stop checking.
3625 for (; *name
&& *name
!= '.'; name
++)
3626 if (*name
!= '-' && !isalnum(*name
))
3631 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3633 /* if new_name == NULL, the section is removed instead */
3634 static int git_config_copy_or_rename_section_in_file(const char *config_filename
,
3635 const char *old_name
,
3636 const char *new_name
, int copy
)
3638 int ret
= 0, remove
= 0;
3639 char *filename_buf
= NULL
;
3640 struct lock_file lock
= LOCK_INIT
;
3642 struct strbuf buf
= STRBUF_INIT
;
3643 FILE *config_file
= NULL
;
3645 struct strbuf copystr
= STRBUF_INIT
;
3646 struct config_store_data store
;
3647 uint32_t line_nr
= 0;
3649 memset(&store
, 0, sizeof(store
));
3651 if (new_name
&& !section_name_is_ok(new_name
)) {
3652 ret
= error(_("invalid section name: %s"), new_name
);
3653 goto out_no_rollback
;
3656 if (!config_filename
)
3657 config_filename
= filename_buf
= git_pathdup("config");
3659 out_fd
= hold_lock_file_for_update(&lock
, config_filename
, 0);
3661 ret
= error(_("could not lock config file %s"), config_filename
);
3665 if (!(config_file
= fopen(config_filename
, "rb"))) {
3666 ret
= warn_on_fopen_errors(config_filename
);
3669 /* no config file means nothing to rename, no error */
3670 goto commit_and_out
;
3673 if (fstat(fileno(config_file
), &st
) == -1) {
3674 ret
= error_errno(_("fstat on %s failed"), config_filename
);
3678 if (chmod(get_lock_file_path(&lock
), st
.st_mode
& 07777) < 0) {
3679 ret
= error_errno(_("chmod on %s failed"),
3680 get_lock_file_path(&lock
));
3684 while (!strbuf_getwholeline(&buf
, config_file
, '\n')) {
3687 char *output
= buf
.buf
;
3691 if (buf
.len
>= GIT_CONFIG_MAX_LINE_LEN
) {
3692 ret
= error(_("refusing to work with overly long line "
3693 "in '%s' on line %"PRIuMAX
),
3694 config_filename
, (uintmax_t)line_nr
);
3698 for (i
= 0; buf
.buf
[i
] && isspace(buf
.buf
[i
]); i
++)
3700 if (buf
.buf
[i
] == '[') {
3701 /* it's a section */
3706 * When encountering a new section under -c we
3707 * need to flush out any section we're already
3708 * coping and begin anew. There might be
3709 * multiple [branch "$name"] sections.
3711 if (copystr
.len
> 0) {
3712 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3713 ret
= write_error(get_lock_file_path(&lock
));
3716 strbuf_reset(©str
);
3719 offset
= section_name_match(&buf
.buf
[i
], old_name
);
3726 store
.baselen
= strlen(new_name
);
3728 if (write_section(out_fd
, new_name
, &store
) < 0) {
3729 ret
= write_error(get_lock_file_path(&lock
));
3733 * We wrote out the new section, with
3734 * a newline, now skip the old
3737 output
+= offset
+ i
;
3738 if (strlen(output
) > 0) {
3740 * More content means there's
3741 * a declaration to put on the
3742 * next line; indent with a
3749 strbuf_release(©str
);
3750 copystr
= store_create_section(new_name
, &store
);
3757 length
= strlen(output
);
3759 if (!is_section
&& copystr
.len
> 0) {
3760 strbuf_add(©str
, output
, length
);
3763 if (write_in_full(out_fd
, output
, length
) < 0) {
3764 ret
= write_error(get_lock_file_path(&lock
));
3770 * Copy a trailing section at the end of the config, won't be
3771 * flushed by the usual "flush because we have a new section
3772 * logic in the loop above.
3774 if (copystr
.len
> 0) {
3775 if (write_in_full(out_fd
, copystr
.buf
, copystr
.len
) < 0) {
3776 ret
= write_error(get_lock_file_path(&lock
));
3779 strbuf_reset(©str
);
3782 fclose(config_file
);
3785 if (commit_lock_file(&lock
) < 0)
3786 ret
= error_errno(_("could not write config file %s"),
3790 fclose(config_file
);
3791 rollback_lock_file(&lock
);
3794 config_store_data_clear(&store
);
3795 strbuf_release(&buf
);
3796 strbuf_release(©str
);
3800 int git_config_rename_section_in_file(const char *config_filename
,
3801 const char *old_name
, const char *new_name
)
3803 return git_config_copy_or_rename_section_in_file(config_filename
,
3804 old_name
, new_name
, 0);
3807 int git_config_rename_section(const char *old_name
, const char *new_name
)
3809 return git_config_rename_section_in_file(NULL
, old_name
, new_name
);
3812 int git_config_copy_section_in_file(const char *config_filename
,
3813 const char *old_name
, const char *new_name
)
3815 return git_config_copy_or_rename_section_in_file(config_filename
,
3816 old_name
, new_name
, 1);
3819 int git_config_copy_section(const char *old_name
, const char *new_name
)
3821 return git_config_copy_section_in_file(NULL
, old_name
, new_name
);
3825 * Call this to report error for your variable that should not
3826 * get a boolean value (i.e. "[my] var" means "true").
3828 #undef config_error_nonbool
3829 int config_error_nonbool(const char *var
)
3831 return error(_("missing value for '%s'"), var
);
3834 int parse_config_key(const char *var
,
3835 const char *section
,
3836 const char **subsection
, size_t *subsection_len
,
3841 /* Does it start with "section." ? */
3842 if (!skip_prefix(var
, section
, &var
) || *var
!= '.')
3846 * Find the key; we don't know yet if we have a subsection, but we must
3847 * parse backwards from the end, since the subsection may have dots in
3850 dot
= strrchr(var
, '.');
3853 /* Did we have a subsection at all? */
3857 *subsection_len
= 0;
3863 *subsection
= var
+ 1;
3864 *subsection_len
= dot
- *subsection
;
3870 const char *config_origin_type_name(enum config_origin_type type
)
3873 case CONFIG_ORIGIN_BLOB
:
3875 case CONFIG_ORIGIN_FILE
:
3877 case CONFIG_ORIGIN_STDIN
:
3878 return "standard input";
3879 case CONFIG_ORIGIN_SUBMODULE_BLOB
:
3880 return "submodule-blob";
3881 case CONFIG_ORIGIN_CMDLINE
:
3882 return "command line";
3884 BUG("unknown config origin type");
3888 const char *config_scope_name(enum config_scope scope
)
3891 case CONFIG_SCOPE_SYSTEM
:
3893 case CONFIG_SCOPE_GLOBAL
:
3895 case CONFIG_SCOPE_LOCAL
:
3897 case CONFIG_SCOPE_WORKTREE
:
3899 case CONFIG_SCOPE_COMMAND
:
3901 case CONFIG_SCOPE_SUBMODULE
:
3908 int lookup_config(const char **mapping
, int nr_mapping
, const char *var
)
3912 for (i
= 0; i
< nr_mapping
; i
++) {
3913 const char *name
= mapping
[i
];
3915 if (name
&& !strcasecmp(var
, name
))