undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

trace2 docs: surround more terms in backticks

Browse Source 
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Johannes Schindelin 2022-05-03 10:26:44 +00:00 committed by Junio C Hamano
parent c191b9188b
commit 1c538b951f
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/technical/api-trace2.txt
View File

@ -35,7 +35,7 @@ Format details are given in a later section.
=== The Normal Format Target === The Normal Format Target
The normal format target is a traditional `printf()` format and similar The normal format target is a traditional `printf()` format and similar
to the GIT_TRACE format. This format is enabled with the `GIT_TRACE2` to the `GIT_TRACE` format. This format is enabled with the `GIT_TRACE2`
environment variable or the `trace2.normalTarget` system or global environment variable or the `trace2.normalTarget` system or global
config setting. config setting.
@ -69,8 +69,8 @@ $ cat ~/log.normal
=== The Performance Format Target === The Performance Format Target
The performance format target (PERF) is a column-based format to The performance format target (PERF) is a column-based format to
replace GIT_TRACE_PERFORMANCE and is suitable for development and 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 enabled with the `GIT_TRACE2_PERF` environment variable or the
`trace2.perfTarget` system or global config setting. `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 Some functions have a `_printf_fl()` suffix to indicate that they also
take a varargs argument. 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 See `trace2.h` for more details. The following discussion will only
describe the simplified forms. describe the simplified forms.
@ -1214,11 +1214,11 @@ as each thread starts and allocates TLS storage.
There are a few issues to resolve before we can completely There are a few issues to resolve before we can completely
switch to Trace2. switch to Trace2.
* Updating existing tests that assume GIT_TRACE format messages. * Updating existing tests that assume `GIT_TRACE` format messages.
* How to best handle custom GIT_TRACE_<key> messages? * How to best handle custom `GIT_TRACE_<key>` messages?
** The GIT_TRACE_<key> mechanism allows each <key> to write to a ** The `GIT_TRACE_<key>` mechanism allows each <key> to write to a
different file (in addition to just stderr). different file (in addition to just stderr).
** Do we want to maintain that ability or simply write to the existing ** Do we want to maintain that ability or simply write to the existing