[PATCH] docs: fix api-trace2 doc for "too_many_files" event

Josh Steadmon· Jun 4, 2021, 02:41 UTC · lore

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(-)

Show changes to Documentation/technical/api-trace2.txt +2 −2

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

Junio C Hamano· Jun 4, 2021, 03:16 UTC · re: Josh Steadmon · lore

Re: [PATCH] docs: fix api-trace2 doc for "too_many_files" event

Josh Steadmon <steadmon@google.com> writes:

Show 5 quoted lines

> 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 ;-)

Show 27 quoted lines

>
> 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",
>  	...
>  }
>  ------------

patchdocs: fix api-trace2 doc for "too_many_files" event