mirror of
https://github.com/git/git
synced 2024-11-05 18:59:29 +00:00
a4e7e317f8
Add a new "const struct config_context *ctx" arg to config_fn_t to hold additional information about the config iteration operation. config_context has a "struct key_value_info kvi" member that holds metadata about the config source being read (e.g. what kind of config source it is, the filename, etc). In this series, we're only interested in .kvi, so we could have just used "struct key_value_info" as an arg, but config_context makes it possible to add/adjust members in the future without changing the config_fn_t signature. We could also consider other ways of organizing the args (e.g. moving the config name and value into config_context or key_value_info), but in my experiments, the incremental benefit doesn't justify the added complexity (e.g. a config_fn_t will sometimes invoke another config_fn_t but with a different config value). In subsequent commits, the .kvi member will replace the global "struct config_reader" in config.c, making config iteration a global-free operation. It requires much more work for the machinery to provide meaningful values of .kvi, so for now, merely change the signature and call sites, pass NULL as a placeholder value, and don't rely on the arg in any meaningful way. Most of the changes are performed by contrib/coccinelle/config_fn_ctx.pending.cocci, which, for every config_fn_t: - Modifies the signature to accept "const struct config_context *ctx" - Passes "ctx" to any inner config_fn_t, if needed - Adds UNUSED attributes to "ctx", if needed Most config_fn_t instances are easily identified by seeing if they are called by the various config functions. Most of the remaining ones are manually named in the .cocci patch. Manual cleanups are still needed, but the majority of it is trivial; it's either adjusting config_fn_t that the .cocci patch didn't catch, or adding forward declarations of "struct config_context ctx" to make the signatures make sense. The non-trivial changes are in cases where we are invoking a config_fn_t outside of config machinery, and we now need to decide what value of "ctx" to pass. These cases are: - trace2/tr2_cfg.c:tr2_cfg_set_fl() This is indirectly called by git_config_set() so that the trace2 machinery can notice the new config values and update its settings using the tr2 config parsing function, i.e. tr2_cfg_cb(). - builtin/checkout.c:checkout_main() This calls git_xmerge_config() as a shorthand for parsing a CLI arg. This might be worth refactoring away in the future, since git_xmerge_config() can call git_default_config(), which can do much more than just parsing. Handle them by creating a KVI_INIT macro that initializes "struct key_value_info" to a reasonable default, and use that to construct the "ctx" arg. Signed-off-by: Glen Choo <chooglen@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
69 lines
1.9 KiB
C
69 lines
1.9 KiB
C
#ifndef IDENT_H
|
|
#define IDENT_H
|
|
|
|
#include "string-list.h"
|
|
|
|
struct ident_split {
|
|
const char *name_begin;
|
|
const char *name_end;
|
|
const char *mail_begin;
|
|
const char *mail_end;
|
|
const char *date_begin;
|
|
const char *date_end;
|
|
const char *tz_begin;
|
|
const char *tz_end;
|
|
};
|
|
|
|
#define IDENT_STRICT 1
|
|
#define IDENT_NO_DATE 2
|
|
#define IDENT_NO_NAME 4
|
|
|
|
enum want_ident {
|
|
WANT_BLANK_IDENT,
|
|
WANT_AUTHOR_IDENT,
|
|
WANT_COMMITTER_IDENT
|
|
};
|
|
|
|
const char *ident_default_name(void);
|
|
const char *ident_default_email(void);
|
|
/*
|
|
* Prepare an ident to fall back on if the user didn't configure it.
|
|
*/
|
|
void prepare_fallback_ident(const char *name, const char *email);
|
|
void reset_ident_date(void);
|
|
/*
|
|
* Signals an success with 0, but time part of the result may be NULL
|
|
* if the input lacks timestamp and zone
|
|
*/
|
|
int split_ident_line(struct ident_split *, const char *, int);
|
|
|
|
/*
|
|
* Given a commit or tag object buffer and the commit or tag headers, replaces
|
|
* the idents in the headers with their canonical versions using the mailmap mechanism.
|
|
*/
|
|
void apply_mailmap_to_header(struct strbuf *, const char **, struct string_list *);
|
|
|
|
/*
|
|
* Compare split idents for equality or strict ordering. Note that we
|
|
* compare only the ident part of the line, ignoring any timestamp.
|
|
*
|
|
* Because there are two fields, we must choose one as the primary key; we
|
|
* currently arbitrarily pick the email.
|
|
*/
|
|
int ident_cmp(const struct ident_split *, const struct ident_split *);
|
|
|
|
const char *git_author_info(int);
|
|
const char *git_committer_info(int);
|
|
const char *fmt_ident(const char *name, const char *email,
|
|
enum want_ident whose_ident,
|
|
const char *date_str, int);
|
|
const char *fmt_name(enum want_ident);
|
|
|
|
int committer_ident_sufficiently_given(void);
|
|
int author_ident_sufficiently_given(void);
|
|
|
|
struct config_context;
|
|
int git_ident_config(const char *, const char *, const struct config_context *,
|
|
void *);
|
|
|
|
#endif
|