mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Derrick Stolee via GitGitGadget" <>
	Junio C Hamano <>,
	Derrick Stolee <>
Subject: [PATCH 1/1] trace2: Add variable description to git.txt
Date: Fri, 10 May 2019 12:44:26 -0700 (PDT)	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

From: Derrick Stolee <>

Documentation/technical/api-trace2.txt contains the full details
of the trace2 API and the GIT_TR2* environment variables. However,
most environment variables are included in Documentation/git.txt,
including the GIT_TRACE* variables.

Add a brief description of the GIT_TR2* variables with links to
the full technical details. The biggest difference from the
original variables is that we can specify a Unix Domain Socket.
Mention this difference, but leave the details to the technical

Reported-by: Szeder Gábor <>
Signed-off-by: Derrick Stolee <>
 Documentation/git.txt | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 00156d64aa..e802886999 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -661,6 +661,27 @@ 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).
+	Enables more detailed trace messages from the "trace2" library.
+	Output from `GIT_TR2` 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`
+variables can also specify a Unix Domain Socket. See
+link:technical/api-trace2.html[Trace2 documentation] for full details.
+	This setting writes a JSON-based format that is suited for machine
+	interpretation. See link:technical/api-trace2.html[Trace2 documentation]
+	for full details.
+	In addition to the text-based messages available in `GIT_TR2`, this
+	setting writes a column-based format for understanding nesting
+	regions. See link:technical/api-trace2.html[Trace2 documentation]
+	for full details.
 	This can be set to a comma-separated list of strings. When a curl trace
 	is enabled (see `GIT_TRACE_CURL` above), whenever a "Cookies:" header

  reply	other threads:[~2019-05-10 19:44 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 ` Derrick Stolee via GitGitGadget [this message]
2019-05-10 21:15   ` [PATCH 1/1] " 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
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:

  List information:

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

  git send-email \ \ \ \ \ \ \ \

* 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

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