trace2 docs: "printf" is not an English word
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Johannes Schindelin committed
May 3, 2022 at 10:26 UTC
c191b9188b371ca4850386e44122ecfa6ee74a01
1 file changed
+6
-6
Documentation/technical/api-trace2.txt
+6
-6
@@ -5,7 +5,7 @@ information to stderr or a file. The Trace2 feature is inactive unless
5
explicitly enabled by enabling one or more Trace2 Targets.
6
7
The Trace2 API is intended to replace the existing (Trace1)
8
-printf-style tracing provided by the existing `GIT_TRACE` and
8
+`printf()`-style tracing provided by the existing `GIT_TRACE` and
9
`GIT_TRACE_PERFORMANCE` facilities. During initial implementation,
10
Trace2 and Trace1 may operate in parallel.
11
@@ -34,7 +34,7 @@ Format details are given in a later section.
34
35
=== The Normal Format Target
36
37
-The normal format target is a traditional printf format and similar
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`
39
environment variable or the `trace2.normalTarget` system or global
40
config setting.
@@ -234,7 +234,7 @@ Events are written as lines of the form:
234
is the event name.
235
236
`<event-message>`::
237
- is a free-form printf message intended for human consumption.
237
+ is a free-form `printf()` message intended for human consumption.
238
+
239
Note that this may contain embedded LF or CRLF characters that are
240
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.
300
indicate a broad category, such as "index" or "status".
301
302
`<perf-event-message>`::
303
- is a free-form printf message intended for human consumption.
303
+ is a free-form `printf()` message intended for human consumption.
304
305
------------
306
15:33:33.532712 wt-status.c:2310 | d0 | main | region_enter | r1 | 0.126064 | | status | label:print
@@ -588,7 +588,7 @@ with "?".
588
589
`"child_exit"`::
590
This event is generated after the current process has returned
591
- from the waitpid() and collected the exit information from the
591
+ from the `waitpid()` and collected the exit information from the
592
child.
593
+
594
------------
@@ -609,7 +609,7 @@ process may be a shell script which doesn't have a session-id.)
609
+
610
Note that the `t_rel` field contains the observed run time in seconds
611
for the child process (starting before the fork/exec/spawn and
612
-stopping after the waitpid() and includes OS process creation overhead).
612
+stopping after the `waitpid()` and includes OS process creation overhead).
613
So this time will be slightly larger than the atexit time reported by
614
the child process itself.
615