templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documented the global `out_dir` option.

This commit is contained in:
Salvador E. Tropea 2021-12-01 14:18:56 -03:00
parent 95135c8c56
commit 779399c4db
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -23,7 +23,9 @@
* [Filtering DRC and ERC errors](#filtering-drc-and-erc-errors)
* [Default global options](#default-global-options)
* [Default *output* option](#default-output-option)
* [Default *dir* option](#default-dir-option)
* [Default *variant* option](#default-variant-option)
* [Output directory option](#output-directory-option)
* [Filtering KiBot warnings](#filtering-kibot-warnings)
* [Filters and variants](#filters-and-variants)
* [Supported filters](#supported-filters)
@ -246,6 +248,14 @@ global:
variant: 'production'
```
#### Output directory option
The `out_dir` option can define the base outut directory. This is the same as the `-d`/`--out-dir` command line option.
Note that the command line option has precedence over it.
Expansion patterns are applied to this value, but you should avoid using patterns that expand according to the context, i.e. **%c**, **%d**, **%f**, **%F**, **%p** and **%r**.
The behavior of these patterns isn't fully defined in this case and the results may change in the future.
#### Filtering KiBot warnings
KiBot warnings are marked with `(Wn)` where *n* is the warning id.

10
docs/README.in
View File

@ -23,7 +23,9 @@
* [Filtering DRC and ERC errors](#filtering-drc-and-erc-errors)
* [Default global options](#default-global-options)
* [Default *output* option](#default-output-option)
* [Default *dir* option](#default-dir-option)
* [Default *variant* option](#default-variant-option)
* [Output directory option](#output-directory-option)
* [Filtering KiBot warnings](#filtering-kibot-warnings)
* [Filters and variants](#filters-and-variants)
* [Supported filters](#supported-filters)
@ -225,6 +227,14 @@ global:
variant: 'production'
```
#### Output directory option
The `out_dir` option can define the base outut directory. This is the same as the `-d`/`--out-dir` command line option.
Note that the command line option has precedence over it.
Expansion patterns are applied to this value, but you should avoid using patterns that expand according to the context, i.e. **%c**, **%d**, **%f**, **%F**, **%p** and **%r**.
The behavior of these patterns isn't fully defined in this case and the results may change in the future.
#### Filtering KiBot warnings
KiBot warnings are marked with `(Wn)` where *n* is the warning id.