From 20dd4f25d55b8d7decf56288f2889bac044150dc Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Mon, 4 Dec 2023 07:34:09 -0300 Subject: [PATCH] [DOCs][Added] drc_exclusions_workaround mention in DRC help See #525 --- docs/samples/generic_plot.kibot.yaml | 1 + docs/source/configuration/sup_preflights.rst | 3 ++- kibot/pre_run_drc.py | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 578b2c80..d3af46f2 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -59,6 +59,7 @@ preflight: # If you need to check the parity use the `update_xml` preflight. # KiCad 6 introduced `warnings` they are currently counted be the `unconnected` counter of KiBot. # This will change in the future. + # If you use DRC exclusions please consult the `drc_exclusions_workaround` global option. run_drc: true # [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct. # The report file name is controlled by the global output pattern (%i=erc %x=txt). diff --git a/docs/source/configuration/sup_preflights.rst b/docs/source/configuration/sup_preflights.rst index 434ae7dd..e02b35f3 100644 --- a/docs/source/configuration/sup_preflights.rst +++ b/docs/source/configuration/sup_preflights.rst @@ -84,7 +84,8 @@ Supported preflights Note that the KiCad 6+ *Test for parity between PCB and schematic* option is not supported. |br| If you need to check the parity use the `update_xml` preflight. |br| KiCad 6 introduced `warnings` they are currently counted be the `unconnected` counter of KiBot. |br| - This will change in the future. + This will change in the future. |br| + If you use DRC exclusions please consult the `drc_exclusions_workaround` global option. - **run_erc**: :index:`: ` [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct. The report file name is controlled by the global output pattern (%i=erc %x=txt). - **sch_replace**: :index:`: ` [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. diff --git a/kibot/pre_run_drc.py b/kibot/pre_run_drc.py index c95cd26b..98247ce0 100644 --- a/kibot/pre_run_drc.py +++ b/kibot/pre_run_drc.py @@ -30,7 +30,8 @@ class Run_DRC(BasePreFlight): # noqa: F821 Note that the KiCad 6+ *Test for parity between PCB and schematic* option is not supported. If you need to check the parity use the `update_xml` preflight. KiCad 6 introduced `warnings` they are currently counted be the `unconnected` counter of KiBot. - This will change in the future """ + This will change in the future. + If you use DRC exclusions please consult the `drc_exclusions_workaround` global option """ def __init__(self, name, value): super().__init__(name, value) if not isinstance(value, bool):