git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: "SZEDER Gábor" <szeder.dev@gmail.com>
Cc: Junio C Hamano <gitster@pobox.com>,
	Derrick Stolee <dstolee@microsoft.com>,
	git@jeffhostetler.com, git@vger.kernel.org
Subject: Re: [PATCH 1/2] trace2: rename environment variables to GIT_TRACE2*
Date: Wed, 29 May 2019 01:02:12 +0200	[thread overview]
Message-ID: <87blzmmbd7.fsf@evledraar.gmail.com> (raw)
In-Reply-To: <20190519144309.9597-1-szeder.dev@gmail.com>


On Sun, May 19 2019, SZEDER Gábor wrote:

> 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.

Good to see this land in 2.22.0. I wonder if we shouldn't take this
further and rename trace2.* config to trace.*, and just re-use
GIT_TRACE=1 instead of having GIT_TRACE2 as well, and have a
GIT_TRACE_VERSION to switch between them.

Then we could just switch in a future version. We've never promised what
the trace format was going to look like, and the existing one isn't
configurable (and we won't be making the v1 one...), so starting from
the outset with "2" in config is unfortunate.

We'd still have special snowflakes like e.g. GIT_TRACE_PACKET.

OTOH we can just do this after the release if it's deemed a good idea,
and just support trace2.* as aliases for trace.* for some amount of
time, same for the env vars.

  parent reply	other threads:[~2019-05-28 23:02 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-10 19:44 [PATCH 0/1] trace2: Add variable description to git.txt Derrick Stolee via GitGitGadget
2019-05-10 19:44 ` [PATCH 1/1] " Derrick Stolee via GitGitGadget
2019-05-10 21:15   ` SZEDER Gábor
2019-05-19 14:43     ` [PATCH 1/2] trace2: rename environment variables to GIT_TRACE2* SZEDER Gábor
2019-05-19 14:43       ` [PATCH 2/2] trace2: document the supported values of GIT_TRACE2* env variables SZEDER Gábor
2019-05-28 16:25       ` [PATCH 1/2] trace2: rename environment variables to GIT_TRACE2* Junio C Hamano
2019-05-28 16:46         ` Derrick Stolee
2019-05-29 19:52           ` Jeff Hostetler
2019-05-28 23:02       ` Ævar Arnfjörð Bjarmason [this message]
2019-05-29 19:58         ` Jeff Hostetler
2019-05-29 21:45           ` Junio C Hamano
2019-06-12 14:29       ` [PATCH] Revert "test-lib: whitelist GIT_TR2_* in the environment" Ævar Arnfjörð Bjarmason
2019-06-12 17:49         ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87blzmmbd7.fsf@evledraar.gmail.com \
    --to=avarab@gmail.com \
    --cc=dstolee@microsoft.com \
    --cc=git@jeffhostetler.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=szeder.dev@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).