summaryrefslogtreecommitdiff
path: root/trace2.h
diff options
context:
space:
mode:
authorSZEDER Gábor <szeder.dev@gmail.com>2019-05-19 14:43:08 (GMT)
committerJunio C Hamano <gitster@pobox.com>2019-05-28 17:20:34 (GMT)
commite4b75d6a1d3105958c307e526ae6759e86f7f837 (patch)
tree99d0e0963cce62b29fafbe5795ce187b211d25d3 /trace2.h
parentaa25c82427ae70aebf3b8f970f2afd54e9a2a8c6 (diff)
downloadgit-e4b75d6a1d3105958c307e526ae6759e86f7f837.zip
git-e4b75d6a1d3105958c307e526ae6759e86f7f837.tar.gz
git-e4b75d6a1d3105958c307e526ae6759e86f7f837.tar.bz2
trace2: rename environment variables to GIT_TRACE2*
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>
Diffstat (limited to 'trace2.h')
-rw-r--r--trace2.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/trace2.h b/trace2.h
index f189ef5..050bf3c 100644
--- a/trace2.h
+++ b/trace2.h
@@ -130,7 +130,7 @@ void trace2_cmd_alias_fl(const char *file, int line, const char *alias,
* list of patterns configured important. For example:
* git config --system trace2.configParams 'core.*,remote.*.url'
* or:
- * GIT_TR2_CONFIG_PARAMS=core.*,remote.*.url"
+ * GIT_TRACE2_CONFIG_PARAMS=core.*,remote.*.url"
*
* Note: this routine does a read-only iteration on the config data
* (using read_early_config()), so it must not be called until enough