diff mbox series

[2/4] trace2 docs: surround more terms in backticks

Message ID 284c6a3df84bed669790fe2f44905328269d1f4f.1646919331.git.gitgitgadget@gmail.com (mailing list archive)
State New, archived
Headers show
Series A couple of fixes for the Trace2 documentation | expand

Commit Message

Johannes Schindelin March 10, 2022, 1:35 p.m. UTC
From: Johannes Schindelin <johannes.schindelin@gmx.de>

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 Documentation/technical/api-trace2.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Junio C Hamano March 10, 2022, 6:56 p.m. UTC | #1
"Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
writes:

> From: Johannes Schindelin <johannes.schindelin@gmx.de>
>
> Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> ---
>  Documentation/technical/api-trace2.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
> index 77216eff622..8ef921a4e4d 100644
> --- a/Documentation/technical/api-trace2.txt
> +++ b/Documentation/technical/api-trace2.txt
> @@ -70,7 +70,7 @@ $ cat ~/log.normal
>  
>  The performance format target (PERF) is a column-based format to
>  replace GIT_TRACE_PERFORMANCE and is suitable for development and

`GIT_TRACE_PERFORMANCE` to match `GIT_TRACE2_PERF` we see below.

> -testing, possibly to complement tools like gprof.  This format is
> +testing, possibly to complement tools like `gprof`.  This format is
>  enabled with the `GIT_TRACE2_PERF` environment variable or the
>  `trace2.perfTarget` system or global config setting.
>  
> @@ -172,7 +172,7 @@ take a `va_list` argument.
>  Some functions have a `_printf_fl()` suffix to indicate that they also
>  take a varargs argument.
>  
> -There are CPP wrapper macros and ifdefs to hide most of these details.
> +There are CPP wrapper macros and `#ifdef`s to hide most of these details.
>  See `trace2.h` for more details.  The following discussion will only
>  describe the simplified forms.
diff mbox series

Patch

diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
index 77216eff622..8ef921a4e4d 100644
--- a/Documentation/technical/api-trace2.txt
+++ b/Documentation/technical/api-trace2.txt
@@ -70,7 +70,7 @@  $ cat ~/log.normal
 
 The performance format target (PERF) is a column-based format to
 replace GIT_TRACE_PERFORMANCE and is suitable for development and
-testing, possibly to complement tools like gprof.  This format is
+testing, possibly to complement tools like `gprof`.  This format is
 enabled with the `GIT_TRACE2_PERF` environment variable or the
 `trace2.perfTarget` system or global config setting.
 
@@ -172,7 +172,7 @@  take a `va_list` argument.
 Some functions have a `_printf_fl()` suffix to indicate that they also
 take a varargs argument.
 
-There are CPP wrapper macros and ifdefs to hide most of these details.
+There are CPP wrapper macros and `#ifdef`s to hide most of these details.
 See `trace2.h` for more details.  The following discussion will only
 describe the simplified forms.