* [PATCH] docs: fix api-trace2 doc for "too_many_files" event
@ 2021-06-04 2:41 Josh Steadmon
2021-06-04 3:16 ` Junio C Hamano
0 siblings, 1 reply; 2+ messages in thread
From: Josh Steadmon @ 2021-06-04 2:41 UTC (permalink / raw)
To: git
In 87db61a (trace2: write discard message to sentinel files,
2019-10-04), we added a new "too_many_files" event for when trace2
logging would create too many files in an output directory.
Unfortunately, the api-trace2 doc described a "discard" event instead.
Fix the doc to use the correct event name.
Signed-off-by: Josh Steadmon <steadmon@google.com>
---
Documentation/technical/api-trace2.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
index 3f52f981a2..037a91cbca 100644
--- a/Documentation/technical/api-trace2.txt
+++ b/Documentation/technical/api-trace2.txt
@@ -396,14 +396,14 @@ only present on the "start" and "atexit" events.
}
------------
-`"discard"`::
+`"too_many_files"`::
This event is written to the git-trace2-discard sentinel file if there
are too many files in the target trace directory (see the
trace2.maxFiles config option).
+
------------
{
- "event":"discard",
+ "event":"too_many_files",
...
}
------------
--
2.32.0.rc1.229.g3e70b5a671-goog
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: fix api-trace2 doc for "too_many_files" event
2021-06-04 2:41 [PATCH] docs: fix api-trace2 doc for "too_many_files" event Josh Steadmon
@ 2021-06-04 3:16 ` Junio C Hamano
0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2021-06-04 3:16 UTC (permalink / raw)
To: Josh Steadmon; +Cc: git
Josh Steadmon <steadmon@google.com> writes:
> In 87db61a (trace2: write discard message to sentinel files,
> 2019-10-04), we added a new "too_many_files" event for when trace2
> logging would create too many files in an output directory.
> Unfortunately, the api-trace2 doc described a "discard" event instead.
> Fix the doc to use the correct event name.
When we look at that commit again, it is immediately obvious that
this fix is correct.
Even the test added to t/t0212 with the commit uses the right event
name (naturally---otherwise the test wouldn't have passed).
Will queue. This makes me wonder if it is useful to have some sort
of "executable" documentation, though ;-)
>
> Signed-off-by: Josh Steadmon <steadmon@google.com>
> ---
> Documentation/technical/api-trace2.txt | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
> index 3f52f981a2..037a91cbca 100644
> --- a/Documentation/technical/api-trace2.txt
> +++ b/Documentation/technical/api-trace2.txt
> @@ -396,14 +396,14 @@ only present on the "start" and "atexit" events.
> }
> ------------
>
> -`"discard"`::
> +`"too_many_files"`::
> This event is written to the git-trace2-discard sentinel file if there
> are too many files in the target trace directory (see the
> trace2.maxFiles config option).
> +
> ------------
> {
> - "event":"discard",
> + "event":"too_many_files",
> ...
> }
> ------------
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-06-04 3:16 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-04 2:41 [PATCH] docs: fix api-trace2 doc for "too_many_files" event Josh Steadmon
2021-06-04 3:16 ` Junio C Hamano
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).