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 2/6] trace2 docs: "printf" is not an English word
Date: Tue, 03 May 2022 10:26:43 +0000 [thread overview]
Message-ID: <3c1ca34927a6634bcfaf444cf0712f74ac48311e.1651573607.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1172.v2.git.1651573607.gitgitgadget@gmail.com>
From: Johannes Schindelin <johannes.schindelin@gmx.de>
We append an ellipsis and enclose it in backticks to indicate that it is
a function elsewhere, let's also use that here.
While at it, ensure the same for `waitpid()`.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
Documentation/technical/api-trace2.txt | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
index adf867e1013..1f1a06eabc6 100644
--- a/Documentation/technical/api-trace2.txt
+++ b/Documentation/technical/api-trace2.txt
@@ -5,7 +5,7 @@ information to stderr or a file. The Trace2 feature is inactive unless
explicitly enabled by enabling one or more Trace2 Targets.
The Trace2 API is intended to replace the existing (Trace1)
-printf-style tracing provided by the existing `GIT_TRACE` and
+`printf()`-style tracing provided by the existing `GIT_TRACE` and
`GIT_TRACE_PERFORMANCE` facilities. During initial implementation,
Trace2 and Trace1 may operate in parallel.
@@ -34,7 +34,7 @@ Format details are given in a later section.
=== 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`
environment variable or the `trace2.normalTarget` system or global
config setting.
@@ -234,7 +234,7 @@ Events are written as lines of the form:
is the event name.
`<event-message>`::
- is a free-form printf message intended for human consumption.
+ is a free-form `printf()` message intended for human consumption.
+
Note that this may contain embedded LF or CRLF characters that are
not escaped, so the event may spill across multiple lines.
@@ -300,7 +300,7 @@ This field is in anticipation of in-proc submodules in the future.
indicate a broad category, such as "index" or "status".
`<perf-event-message>`::
- is a free-form printf message intended for human consumption.
+ is a free-form `printf()` message intended for human consumption.
------------
15:33:33.532712 wt-status.c:2310 | d0 | main | region_enter | r1 | 0.126064 | | status | label:print
@@ -588,7 +588,7 @@ with "?".
`"child_exit"`::
This event is generated after the current process has returned
- from the waitpid() and collected the exit information from the
+ from the `waitpid()` and collected the exit information from the
child.
+
------------
@@ -609,7 +609,7 @@ process may be a shell script which doesn't have a session-id.)
+
Note that the `t_rel` field contains the observed run time in seconds
for the child process (starting before the fork/exec/spawn and
-stopping after the waitpid() and includes OS process creation overhead).
+stopping after the `waitpid()` and includes OS process creation overhead).
So this time will be slightly larger than the atexit time reported by
the child process itself.
--
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 ` Johannes Schindelin via GitGitGadget [this message]
2022-05-03 10:26 ` [PATCH v2 3/6] trace2 docs: surround more terms in backticks Johannes Schindelin via GitGitGadget
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=3c1ca34927a6634bcfaf444cf0712f74ac48311e.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).