trace2 docs: surround more terms in backticks
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Johannes Schindelin committed
May 3, 2022 at 10:26 UTC
1c538b951fce8743a8f81cb35d3a9901b11df624
1 file changed
+7
-7
Documentation/technical/api-trace2.txt
+7
-7
@@ -35,7 +35,7 @@ Format details are given in a later section.
35
=== The Normal Format Target
36
37
The normal format target is a traditional `printf()` format and similar
38
-to the GIT_TRACE format. This format is enabled with the `GIT_TRACE2`
38
+to the `GIT_TRACE` format. This format is enabled with the `GIT_TRACE2`
39
environment variable or the `trace2.normalTarget` system or global
40
config setting.
41
@@ -69,8 +69,8 @@ $ cat ~/log.normal
69
=== The Performance Format Target
70
71
The performance format target (PERF) is a column-based format to
72
-replace GIT_TRACE_PERFORMANCE and is suitable for development and
73
-testing, possibly to complement tools like gprof. This format is
72
+replace `GIT_TRACE_PERFORMANCE` and is suitable for development and
73
+testing, possibly to complement tools like `gprof`. This format is
74
enabled with the `GIT_TRACE2_PERF` environment variable or the
75
`trace2.perfTarget` system or global config setting.
76
@@ -172,7 +172,7 @@ take a `va_list` argument.
172
Some functions have a `_printf_fl()` suffix to indicate that they also
173
take a varargs argument.
174
175
-There are CPP wrapper macros and ifdefs to hide most of these details.
175
+There are CPP wrapper macros and `#ifdef`s to hide most of these details.
176
See `trace2.h` for more details. The following discussion will only
177
describe the simplified forms.
178
@@ -1214,11 +1214,11 @@ as each thread starts and allocates TLS storage.
1214
There are a few issues to resolve before we can completely
1215
switch to Trace2.
1216
1217
-* Updating existing tests that assume GIT_TRACE format messages.
1217
+* Updating existing tests that assume `GIT_TRACE` format messages.
1218
1219
-* How to best handle custom GIT_TRACE_<key> messages?
1219
+* How to best handle custom `GIT_TRACE_<key>` messages?
1220
1221
-** The GIT_TRACE_<key> mechanism allows each <key> to write to a
1221
+** The `GIT_TRACE_<key>` mechanism allows each <key> to write to a
1222
different file (in addition to just stderr).
1223
1224
** Do we want to maintain that ability or simply write to the existing