diff options
| author |  SZEDER Gábor <szeder.dev@gmail.com> | 2019-05-19 16:43:08 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2019-05-28 10:20:34 -0700 |
| commit | e4b75d6a1d3105958c307e526ae6759e86f7f837 (patch) | |
| tree | 99d0e0963cce62b29fafbe5795ce187b211d25d3 /Documentation/git.txt | |
| parent | Git 2.22-rc1 (diff) | |
| download | tgif-e4b75d6a1d3105958c307e526ae6759e86f7f837.tar.xz | |
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 'Documentation/git.txt')
| -rw-r--r-- | Documentation/git.txt | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt index 72adfcc5e2..fcf81e3acf 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -660,23 +660,23 @@ of clones and fetches. When a curl trace is enabled (see `GIT_TRACE_CURL` above), do not dump data (that is, only dump info lines and headers). -`GIT_TR2`:: +`GIT_TRACE2`:: Enables more detailed trace messages from the "trace2" library. - Output from `GIT_TR2` is a simple text-based format for human + Output from `GIT_TRACE2` is a simple text-based format for human readability. + -The `GIT_TR2` variables can take many values. Any value available to -the `GIT_TRACE` variables is also available to `GIT_TR2`. The `GIT_TR2` +The `GIT_TRACE2` variables can take many values. Any value available to +the `GIT_TRACE` variables is also available to `GIT_TRACE2`. The `GIT_TRACE2` variables can also specify a Unix Domain Socket. See link:technical/api-trace2.html[Trace2 documentation] for full details. -`GIT_TR2_EVENT`:: +`GIT_TRACE2_EVENT`:: This setting writes a JSON-based format that is suited for machine interpretation. See link:technical/api-trace2.html[Trace2 documentation] for full details. -`GIT_TR2_PERF`:: - In addition to the text-based messages available in `GIT_TR2`, this +`GIT_TRACE2_PERF`:: + In addition to the text-based messages available in `GIT_TRACE2`, this setting writes a column-based format for understanding nesting regions. See link:technical/api-trace2.html[Trace2 documentation] for full details. |