From 14fb810c0feb63549941ad608312e098241a93b5 Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Fri, 5 Jan 2024 10:52:03 -0300 Subject: [PATCH] [DOCs] Updated - Fixed spelling - New command line option - New error level - KiDiff version needed --- docs/samples/generic_plot.kibot.yaml | 8 ++++---- docs/source/configuration/outputs/blender_export.rst | 2 +- docs/source/configuration/outputs/diff.rst | 4 ++-- docs/source/configuration/outputs/pcbdraw.rst | 2 +- docs/source/dependencies.rst | 2 +- docs/source/errors.rst | 1 + docs/source/usage.txt | 5 +++-- 7 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 6d05e979..e9ab5d70 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -238,7 +238,7 @@ outputs: texture_dpi: 1016.0 # [dict|list(dict)] How the object is viewed by the camera point_of_view: - # [string=''] String to diferentiate the name of this point of view. + # [string=''] String to differentiate the name of this point of view. # When empty we use the `default_file_id` or the `view` - file_id: '' # [number=0] Angle to rotate the board in the X axis, positive is clockwise [degrees] @@ -764,7 +764,7 @@ outputs: # symlink. Useful for some Windows setups copy_instead_of_link: false # [string='red_green'] [red_green,stats] In the `red_green` mode added stuff is green and red when removed. - # The `stats` mode is used to meassure the amount of difference. In this mode all + # The `stats` mode is used to measure the amount of difference. In this mode all # changes are red, but you can abort if the difference is bigger than certain threshold diff_mode: 'red_green' # [string|list(string)='_none'] Name of the filter to mark components as not fitted. @@ -803,7 +803,7 @@ outputs: # Use `multivar` to specify a reference file when `new_type` is also `multivar` old_type: 'git' # [boolean=false] Only include the pages with differences in the output PDF. - # Note that when no differeces are found we get a page saying *No diff* + # Note that when no differences are found we get a page saying *No diff* only_different: false # [boolean=false] Compare only the main schematic page (root page) only_first_sch_page: false @@ -2544,7 +2544,7 @@ outputs: # `reference` is an alias for `ref` # [string|list(string)=''] List of resistors to flip its bands resistor_flip: '' - # [list(dict)] List of resitors to be remapped. You can change the value of the resistors here + # [list(dict)] List of resistors to be remapped. You can change the value of the resistors here resistor_remap: # [string=''] Reference for the resistor to change - ref: '' diff --git a/docs/source/configuration/outputs/blender_export.rst b/docs/source/configuration/outputs/blender_export.rst index 56940ed2..5b9d1669 100644 --- a/docs/source/configuration/outputs/blender_export.rst +++ b/docs/source/configuration/outputs/blender_export.rst @@ -75,7 +75,7 @@ Parameters: - **view** :index:`: ` [string='top'] [top,bottom,front,rear,right,left,z,Z,y,Y,x,X] Point of view. Compatible with `render_3d`. - - ``file_id`` :index:`: ` [string=''] String to diferentiate the name of this point of view. + - ``file_id`` :index:`: ` [string=''] String to differentiate the name of this point of view. When empty we use the `default_file_id` or the `view`. - ``rotate_x`` :index:`: ` [number=0] Angle to rotate the board in the X axis, positive is clockwise [degrees]. - ``rotate_y`` :index:`: ` [number=0] Angle to rotate the board in the Y axis, positive is clockwise [degrees]. diff --git a/docs/source/configuration/outputs/diff.rst b/docs/source/configuration/outputs/diff.rst index 7762e86c..59bc07f0 100644 --- a/docs/source/configuration/outputs/diff.rst +++ b/docs/source/configuration/outputs/diff.rst @@ -47,7 +47,7 @@ Parameters: - ``copy_instead_of_link`` :index:`: ` [boolean=false] Modifies the behavior of `add_link_id` to create a copy of the file instead of a symlink. Useful for some Windows setups. - ``diff_mode`` :index:`: ` [string='red_green'] [red_green,stats] In the `red_green` mode added stuff is green and red when removed. - The `stats` mode is used to meassure the amount of difference. In this mode all + The `stats` mode is used to measure the amount of difference. In this mode all changes are red, but you can abort if the difference is bigger than certain threshold. - ``dnf_filter`` :index:`: ` [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. @@ -79,7 +79,7 @@ Parameters: Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output. Use `multivar` to specify a reference file when `new_type` is also `multivar`. - ``only_different`` :index:`: ` [boolean=false] Only include the pages with differences in the output PDF. - Note that when no differeces are found we get a page saying *No diff*. + Note that when no differences are found we get a page saying *No diff*. - ``only_first_sch_page`` :index:`: ` [boolean=false] Compare only the main schematic page (root page). - ``pcb`` :index:`: ` [boolean=true] Compare the PCB, otherwise compare the schematic. - ``pre_transform`` :index:`: ` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. diff --git a/docs/source/configuration/outputs/pcbdraw.rst b/docs/source/configuration/outputs/pcbdraw.rst index 91638dbe..e52d5e75 100644 --- a/docs/source/configuration/outputs/pcbdraw.rst +++ b/docs/source/configuration/outputs/pcbdraw.rst @@ -103,7 +103,7 @@ Parameters: - ``resistor_flip`` :index:`: ` [string|list(string)=''] List of resistors to flip its bands. - - ``resistor_remap`` :index:`: ` [list(dict)] List of resitors to be remapped. You can change the value of the resistors here. + - ``resistor_remap`` :index:`: ` [list(dict)] List of resistors to be remapped. You can change the value of the resistors here. - Valid keys: diff --git a/docs/source/dependencies.rst b/docs/source/dependencies.rst index 2e3863bd..cb6c8b06 100644 --- a/docs/source/dependencies.rst +++ b/docs/source/dependencies.rst @@ -28,7 +28,7 @@ - Optional to separate multiboard projects for general use - Note: Official 1.3.0 release does not work, use my fork if 1.3.0 is the latest -`KiCad PCB/SCH Diff `__ :index:`: ` v2.5.0 |image12| |Auto-download| +`KiCad PCB/SCH Diff `__ :index:`: ` v2.5.1 |image12| |Auto-download| - Mandatory for: `diff`, `kiri` diff --git a/docs/source/errors.rst b/docs/source/errors.rst index 192e660e..7d677b94 100644 --- a/docs/source/errors.rst +++ b/docs/source/errors.rst @@ -39,3 +39,4 @@ Supported error levels - 33: HPGL_SCH_PRINT - 34: CORRUPTED_PRO - 35: BLENDER_ERROR +- 36: WARN_AS_ERROR diff --git a/docs/source/usage.txt b/docs/source/usage.txt index 3ff2b1f3..bdbdcaff 100644 --- a/docs/source/usage.txt +++ b/docs/source/usage.txt @@ -1,9 +1,9 @@ KiBot: KiCad automation tool for documents generation Usage: - kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE] [-D] + kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE] [-q | -v...] [-L LOGFILE] [-C | -i | -n] [-m MKFILE] [-A] [-g DEF] ... - [-E DEF] ... [-w LIST] [--banner N] [TARGET...] + [-E DEF] ... [-w LIST] [-D | -W] [--banner N] [TARGET...] kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] [--banner N] [-E DEF] ... [--config-outs] [--only-pre|--only-groups] [--only-names] [--output-name-first] --list @@ -65,6 +65,7 @@ Options: -v, --verbose Show debugging information -V, --version Show program's version number and exit -w, --no-warn LIST Exclude the mentioned warnings (comma sep) + -W, --stop-on-warnings Stop on warnings -x, --example Create a template configuration file Quick start options: