trace2: correct typo in technical documentation
diff mbox series

Message ID 20190626200303.9834-1-carenas@gmail.com
State New
Headers show
Series
  • trace2: correct typo in technical documentation
Related show

Commit Message

Carlo Arenas June 26, 2019, 8:03 p.m. UTC
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)

Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com>
---
 Documentation/technical/api-trace2.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jeff Hostetler June 26, 2019, 8:14 p.m. UTC | #1
On 6/26/2019 4:03 PM, Carlo Marcelo Arenas Belón wrote:
> 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)
> 
> Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com>
> ---
>   Documentation/technical/api-trace2.txt | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
> index 23c3cc7a37..f7ffe7d599 100644
> --- a/Documentation/technical/api-trace2.txt
> +++ b/Documentation/technical/api-trace2.txt
> @@ -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
SZEDER Gábor June 27, 2019, 10:49 a.m. UTC | #2
On Wed, Jun 26, 2019 at 01:03:03PM -0700, Carlo Marcelo Arenas Belón wrote:
> 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)
> 
> Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com>
> ---
>  Documentation/technical/api-trace2.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
> index 23c3cc7a37..f7ffe7d599 100644
> --- a/Documentation/technical/api-trace2.txt
> +++ b/Documentation/technical/api-trace2.txt
> @@ -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.

Patch
diff mbox series

diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
index 23c3cc7a37..f7ffe7d599 100644
--- a/Documentation/technical/api-trace2.txt
+++ b/Documentation/technical/api-trace2.txt
@@ -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.