{"thread":{"id":"55836","subject":"[PATCH] docs: fix api-trace2 doc for \"too_many_files\" event","startedAt":"2021-06-04T02:41:47Z","lastAt":"2021-06-04T03:16:12Z","messageCount":2,"participants":["Josh Steadmon","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"426381","messageId":"07a3f409730fb7d725042ee24b7556d17efe4676.1622774341.git.steadmon@google.com","threadId":"55836","inReplyTo":null,"subject":"[PATCH] docs: fix api-trace2 doc for \"too_many_files\" event","fromName":"Josh Steadmon","fromEmail":"steadmon@google.com","sentAt":"2021-06-04T02:41:30Z","receivedAt":"2021-06-04T02:41:47Z","isPatch":true,"sender":{"key":"steadmon@google.com","avatar":"https://avatars.githubusercontent.com/u/2654920?v=4"},"body":"In 87db61a (trace2: write discard message to sentinel files,\n2019-10-04), we added a new \"too_many_files\" event for when trace2\nlogging would create too many files in an output directory.\nUnfortunately, the api-trace2 doc described a \"discard\" event instead.\nFix the doc to use the correct event name.\n\nSigned-off-by: Josh Steadmon <steadmon@google.com>\n---\n Documentation/technical/api-trace2.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt\nindex 3f52f981a2..037a91cbca 100644\n--- a/Documentation/technical/api-trace2.txt\n+++ b/Documentation/technical/api-trace2.txt\n@@ -396,14 +396,14 @@ only present on the \"start\" and \"atexit\" events.\n }\n ------------\n \n-`\"discard\"`::\n+`\"too_many_files\"`::\n \tThis event is written to the git-trace2-discard sentinel file if there\n \tare too many files in the target trace directory (see the\n \ttrace2.maxFiles config option).\n +\n ------------\n {\n-\t\"event\":\"discard\",\n+\t\"event\":\"too_many_files\",\n \t...\n }\n ------------\n-- \n2.32.0.rc1.229.g3e70b5a671-goog\n\n"},{"id":"426382","messageId":"xmqqfsxy2ubp.fsf@gitster.g","threadId":"55836","inReplyTo":"07a3f409730fb7d725042ee24b7556d17efe4676.1622774341.git.steadmon@google.com","subject":"Re: [PATCH] docs: fix api-trace2 doc for \"too_many_files\" event","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-06-04T03:16:10Z","receivedAt":"2021-06-04T03:16:12Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Josh Steadmon <steadmon@google.com> writes:\n\n> In 87db61a (trace2: write discard message to sentinel files,\n> 2019-10-04), we added a new \"too_many_files\" event for when trace2\n> logging would create too many files in an output directory.\n> Unfortunately, the api-trace2 doc described a \"discard\" event instead.\n> Fix the doc to use the correct event name.\n\nWhen we look at that commit again, it is immediately obvious that\nthis fix is correct.\n\nEven the test added to t/t0212 with the commit uses the right event\nname (naturally---otherwise the test wouldn't have passed).\n\nWill queue.  This makes me wonder if it is useful to have some sort\nof \"executable\" documentation, though ;-)\n\n>\n> Signed-off-by: Josh Steadmon <steadmon@google.com>\n> ---\n>  Documentation/technical/api-trace2.txt | 4 ++--\n>  1 file changed, 2 insertions(+), 2 deletions(-)\n>\n> diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt\n> index 3f52f981a2..037a91cbca 100644\n> --- a/Documentation/technical/api-trace2.txt\n> +++ b/Documentation/technical/api-trace2.txt\n> @@ -396,14 +396,14 @@ only present on the \"start\" and \"atexit\" events.\n>  }\n>  ------------\n>  \n> -`\"discard\"`::\n> +`\"too_many_files\"`::\n>  \tThis event is written to the git-trace2-discard sentinel file if there\n>  \tare too many files in the target trace directory (see the\n>  \ttrace2.maxFiles config option).\n>  +\n>  ------------\n>  {\n> -\t\"event\":\"discard\",\n> +\t\"event\":\"too_many_files\",\n>  \t...\n>  }\n>  ------------\n"}]}