Skip to contentSkip to conversation

trace2: correct typo in technical documentation

PATCH In review Carlo Marcelo Arenas Belón 3 participants 3 messages Jun 26, 2019 – Jun 27, 2019 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 trace2: correct typo in technical documentation

an apparent typo for the environment variable was included with 81567caf87 ("trace2: update docs to describe system/global config settings", 2019-04-15), and was missed when renamed variables by e4b75d6a1d ("trace2: rename environment variables to GIT_TRACE2*", 2019-05-19)

---
 Documentation/technical/api-trace2.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/technical/api-trace2.txt +1 -1
index 23c3cc7a37..f7ffe7d599 100644
@@ -35,7 +35,7 @@ Format details are given in a later section.
 === The Normal Format Target
 
 The normal format target is a tradition printf format and similar
-to GIT_TRACE format.  This format is enabled with the `GIT_TR`
+to GIT_TRACE format.  This format is enabled with the `GIT_TRACE2`
 environment variable or the `trace2.normalTarget` system or global
 config setting.
 
Signature · 1 line
2.22.0
#1 lore raw
Quoted 16 lines · Carlo Marcelo Arenas Belón

an apparent typo for the environment variable was included with 81567caf87 ("trace2: update docs to describe system/global config settings", 2019-04-15), and was missed when renamed variables by e4b75d6a1d ("trace2: rename environment variables to GIT_TRACE2*", 2019-05-19)

---
  Documentation/technical/api-trace2.txt | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/technical/api-trace2.txt +0 -0
index 23c3cc7a37..f7ffe7d599 100644

Documentation/technical/api-trace2.txt Format details are given in a later section. · line 41

Quoted 8 lines
Documentation/technical/api-trace2.txt +1 -1
@@ -35,7 +35,7 @@ Format details are given in a later section.
  === The Normal Format Target
 
  The normal format target is a tradition printf format and similar
-to GIT_TRACE format.  This format is enabled with the `GIT_TR`
+to GIT_TRACE format.  This format is enabled with the `GIT_TRACE2`
  environment variable or the `trace2.normalTarget` system or global
  config setting.
 

Good catch!

Thanks,
Jeff

#2 lore raw
In reply to Carlo Marcelo Arenas Belón
Quoted 15 lines · Carlo Marcelo Arenas Belón

an apparent typo for the environment variable was included with 81567caf87 ("trace2: update docs to describe system/global config settings", 2019-04-15), and was missed when renamed variables by e4b75d6a1d ("trace2: rename environment variables to GIT_TRACE2*", 2019-05-19)

---
 Documentation/technical/api-trace2.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/technical/api-trace2.txt +0 -0
index 23c3cc7a37..f7ffe7d599 100644

Documentation/technical/api-trace2.txt Format details are given in a later section. · line 38

Quoted 5 lines
Documentation/technical/api-trace2.txt +1 -1
@@ -35,7 +35,7 @@ Format details are given in a later section.
 === The Normal Format Target
 
 The normal format target is a tradition printf format and similar
-to GIT_TRACE format.  This format is enabled with the `GIT_TR`
+to GIT_TRACE format.  This format is enabled with the `GIT_TRACE2`

Carlo, thanks for catching this.

Junio, this patch should be applied on top of 'sg/trace2-rename' which contains e4b75d6a1d. In current 'pu' it's applied on top of 'jh/trace2-sid-fix', which doesn't contain that commit and therefore the rest of the codebase doesn't know about GIT_TRACE2 yet.