mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
e4b75d6a1d
For an environment variable that is supposed to be set by users, the GIT_TR2* env vars are just too unclear, inconsistent, and ugly. Most of the established GIT_* environment variables don't use abbreviations, and in case of the few that do (GIT_DIR, GIT_COMMON_DIR, GIT_DIFF_OPTS) it's quite obvious what the abbreviations (DIR and OPTS) stand for. But what does TR stand for? Track, traditional, trailer, transaction, transfer, transformation, transition, translation, transplant, transport, traversal, tree, trigger, truncate, trust, or ...?! The trace2 facility, as the '2' suffix in its name suggests, is supposed to eventually supercede Git's original trace facility. It's reasonable to expect that the corresponding environment variables follow suit, and after the original GIT_TRACE variables they are called GIT_TRACE2; there is no such thing is 'GIT_TR'. All trace2-specific config variables are, very sensibly, in the 'trace2' section, not in 'tr2'. OTOH, we don't gain anything at all by omitting the last three characters of "trace" from the names of these environment variables. So let's rename all GIT_TR2* environment variables to GIT_TRACE2*, before they make their way into a stable release. Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
37 lines
810 B
C
37 lines
810 B
C
#ifndef TR2_SYSENV_H
|
|
#define TR2_SYSENV_H
|
|
|
|
/*
|
|
* The Trace2 settings that can be loaded from /etc/gitconfig
|
|
* and/or user environment variables.
|
|
*
|
|
* Note that this set does not contain any of the transient
|
|
* environment variables used to pass information from parent
|
|
* to child git processes, such "GIT_TRACE2_PARENT_SID".
|
|
*/
|
|
enum tr2_sysenv_variable {
|
|
TR2_SYSENV_CFG_PARAM = 0,
|
|
|
|
TR2_SYSENV_DST_DEBUG,
|
|
|
|
TR2_SYSENV_NORMAL,
|
|
TR2_SYSENV_NORMAL_BRIEF,
|
|
|
|
TR2_SYSENV_EVENT,
|
|
TR2_SYSENV_EVENT_BRIEF,
|
|
TR2_SYSENV_EVENT_NESTING,
|
|
|
|
TR2_SYSENV_PERF,
|
|
TR2_SYSENV_PERF_BRIEF,
|
|
|
|
TR2_SYSENV_MUST_BE_LAST
|
|
};
|
|
|
|
void tr2_sysenv_load(void);
|
|
|
|
const char *tr2_sysenv_get(enum tr2_sysenv_variable);
|
|
const char *tr2_sysenv_display_name(enum tr2_sysenv_variable var);
|
|
void tr2_sysenv_release(void);
|
|
|
|
#endif /* TR2_SYSENV_H */
|