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

steadmon · gitster · commit 7ba68e0cf1df · 2021-06-04T12:11:16.000+09:00
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
@@ -621,14 +621,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",
 	...
 }
 ------------

Original file line number	Diff line number	Diff line change
`@@ -621,14 +621,14 @@ only present on the "start" and "atexit" events.`
`621`	`621`	`}`
`622`	`622`	`------------`
`623`	`623`
`624`		-`"discard"`::
	`624`	+`"too_many_files"`::
`625`	`625`	`This event is written to the git-trace2-discard sentinel file if there`
`626`	`626`	`are too many files in the target trace directory (see the`
`627`	`627`	`trace2.maxFiles config option).`
`628`	`628`	`+`
`629`	`629`	`------------`
`630`	`630`	`{`
`631`		`- "event":"discard",`
	`631`	`+ "event":"too_many_files",`
`632`	`632`	`...`
`633`	`633`	`}`
`634`	`634`	`------------`