trace2: rename environment variables to GIT_TRACE2*
authorSZEDER Gábor <szeder.dev@gmail.com>
Sun, 19 May 2019 14:43:08 +0000 (16:43 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 28 May 2019 17:20:34 +0000 (10:20 -0700)
commite4b75d6a1d3105958c307e526ae6759e86f7f837
tree99d0e0963cce62b29fafbe5795ce187b211d25d3
parentaa25c82427ae70aebf3b8f970f2afd54e9a2a8c6
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>
13 files changed:
Documentation/config/trace2.txt
Documentation/git.txt
Documentation/technical/api-trace2.txt
t/t0001-init.sh
t/t0210-trace2-normal.sh
t/t0211-trace2-perf.sh
t/t0212-trace2-event.sh
t/t0212/parse_events.perl
trace2.h
trace2/tr2_cmd_name.c
trace2/tr2_sid.c
trace2/tr2_sysenv.c
trace2/tr2_sysenv.h