Document the existence of the manual :regression_tests fuzzer rule.

hzeller · copybara-github · commit e630038c7df4 · 2024-11-08T13:58:00.000-08:00
The documentation is hidden away in the build_defs, but just looking
at the opaque target it is not clear how to get the functionality.

PiperOrigin-RevId: 694630176
diff --git a/xls/fuzzer/BUILD b/xls/fuzzer/BUILD
@@ -373,6 +373,9 @@ cc_test(
     ],
 )
 
+# Create tests of all the known non-failing crashers.
+# Calling the generated manual target :regression_tests includes the failures
+# and :failing_regression_tests only runs the failures.
 generate_crasher_regression_tests(
     name = "regression_tests",
     srcs = glob(["crashers/*"]),

Original file line number	Diff line number	Diff line change
`@@ -373,6 +373,9 @@ cc_test(`
`373`	`373`	`],`
`374`	`374`	`)`
`375`	`375`
	`376`	`+# Create tests of all the known non-failing crashers.`
	`377`	`+# Calling the generated manual target :regression_tests includes the failures`
	`378`	`+# and :failing_regression_tests only runs the failures.`
`376`	`379`	`generate_crasher_regression_tests(`
`377`	`380`	`name = "regression_tests",`
`378`	`381`	`srcs = glob(["crashers/*"]),`