# [PATCH] docs: fix api-trace2 doc for "too_many_files" event 2 messages from 2021-06-04 to 2021-06-04. Participants: Josh Steadmon, Junio C Hamano. Thread: https://gitlist.dev/t/55836 ## Josh Steadmon, 2021-06-04 02:41 Subject: [PATCH] docs: fix api-trace2 doc for "too_many_files" event Message-ID: <07a3f409730fb7d725042ee24b7556d17efe4676.1622774341.git.steadmon@google.com> URL: https://gitlist.dev/e/07a3f409730fb7d725042ee24b7556d17efe4676.1622774341.git.steadmon%40google.com ``` 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 --- 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 ``` ## Junio C Hamano, 2021-06-04 03:16 Subject: Re: [PATCH] docs: fix api-trace2 doc for "too_many_files" event Message-ID: URL: https://gitlist.dev/e/xmqqfsxy2ubp.fsf%40gitster.g In-Reply-To: <07a3f409730fb7d725042ee24b7556d17efe4676.1622774341.git.steadmon@google.com> ``` Josh Steadmon 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 > --- > 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", > ... > } > ------------ ```