From: "Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Jeff Hostetler" <jeffhost@microsoft.com>,
"Jeff Hostetler" <git@jeffhostetler.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Johannes Schindelin" <johannes.schindelin@gmx.de>,
"Johannes Schindelin" <johannes.schindelin@gmx.de>
Subject: [PATCH v2 3/6] trace2 docs: surround more terms in backticks
Date: Tue, 03 May 2022 10:26:44 +0000 [thread overview]
Message-ID: <2ddd9ff4506475c44f68e14a4e0a9abce2806e3b.1651573607.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1172.v2.git.1651573607.gitgitgadget@gmail.com>
From: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
Documentation/technical/api-trace2.txt | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
index 1f1a06eabc6..e8a5d7c78d0 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 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
config setting.
@@ -69,8 +69,8 @@ $ cat ~/log.normal
=== The Performance Format Target
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
+replace `GIT_TRACE_PERFORMANCE` and is suitable for development and
+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.
@@ -1214,11 +1214,11 @@ as each thread starts and allocates TLS storage.
There are a few issues to resolve before we can completely
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).
** Do we want to maintain that ability or simply write to the existing
--
gitgitgadget
next prev parent reply other threads:[~2022-05-03 10:27 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-10 13:35 [PATCH 0/4] A couple of fixes for the Trace2 documentation Johannes Schindelin via GitGitGadget
2022-03-10 13:35 ` [PATCH 1/4] trace2 docs: a couple of grammar fixes Johannes Schindelin via GitGitGadget
2022-03-10 14:35 ` Ævar Arnfjörð Bjarmason
2022-03-10 18:55 ` Junio C Hamano
2022-03-10 19:00 ` Junio C Hamano
2022-03-10 13:35 ` [PATCH 2/4] trace2 docs: surround more terms in backticks Johannes Schindelin via GitGitGadget
2022-03-10 18:56 ` Junio C Hamano
2022-03-10 13:35 ` [PATCH 3/4] trace2 docs: fix a JSON formatted example Johannes Schindelin via GitGitGadget
2022-03-10 13:35 ` [PATCH 4/4] trace2 docs: clarify what `varargs` is all about Johannes Schindelin via GitGitGadget
2022-03-10 14:37 ` Ævar Arnfjörð Bjarmason
2022-03-10 13:50 ` [PATCH 0/4] A couple of fixes for the Trace2 documentation Jeff Hostetler
2022-05-03 10:26 ` [PATCH v2 0/6] " Johannes Schindelin via GitGitGadget
2022-05-03 10:26 ` [PATCH v2 1/6] trace2 docs: a couple of grammar fixes Johannes Schindelin via GitGitGadget
2022-05-03 10:26 ` [PATCH v2 2/6] trace2 docs: "printf" is not an English word Johannes Schindelin via GitGitGadget
2022-05-03 10:26 ` Johannes Schindelin via GitGitGadget [this message]
2022-05-03 10:26 ` [PATCH v2 4/6] trace2 docs: fix a JSON formatted example Johannes Schindelin via GitGitGadget
2022-05-03 10:26 ` [PATCH v2 5/6] trace2 docs: clarify what `varargs` is all about Johannes Schindelin via GitGitGadget
2022-05-03 10:26 ` [PATCH v2 6/6] trace2 docs: add missing full stop Johannes Schindelin via GitGitGadget
2022-05-03 15:40 ` [PATCH v2 0/6] A couple of fixes for the Trace2 documentation Jeff Hostetler
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2ddd9ff4506475c44f68e14a4e0a9abce2806e3b.1651573607.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=avarab@gmail.com \
--cc=git@jeffhostetler.com \
--cc=git@vger.kernel.org \
--cc=jeffhost@microsoft.com \
--cc=johannes.schindelin@gmx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).