From 0425310f8edb2d0f36de5d74314001d223407d81 Mon Sep 17 00:00:00 2001 From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com> Date: Sat, 14 Jun 2025 15:01:40 +1200 Subject: [PATCH] bugpoint.rst: Expand note on checking errors --- docs/source/using_yosys/bugpoint.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/source/using_yosys/bugpoint.rst b/docs/source/using_yosys/bugpoint.rst index 41fc60cdb..ce84fd285 100644 --- a/docs/source/using_yosys/bugpoint.rst +++ b/docs/source/using_yosys/bugpoint.rst @@ -171,9 +171,12 @@ error code returned. .. note:: - Checking the error message or return status with is optional, but helps to - ensure that the minimized design is reproducing the right error, especially - when ```` contains more than one command. + Checking the error message or return status is optional, but highly + recommended. `bugpoint` can quite easily introduce bugs by creating + malformed designs that commands were not intended to handle. By having some + way to check the error, `bugpoint` can ensure that it is the *right* error + being reproduced. This is even more important when ```` contains + more than one command. By default, `bugpoint` is able to remove any part of the design. In order to keep certain parts, for instance because you already know they are related to