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

[DOCs] Clarified what `multivar` needs in the `diff` output 

Related to #353
This commit is contained in:
Salvador E. Tropea 2022-12-22 07:10:46 -03:00
parent 3ef1e84fd5
commit 648bf49834
3 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -1793,7 +1793,8 @@ Notes:
- `new_type`: [string='current'] [git,file,output,multivar,current] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
Use `current` for the currently loaded PCB/Schematic.
Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output.
Use `multivar` to compare a set of variants, in this mode `new` is the list of variants.
Use `multivar` to compare a set of variants, in this mode `new` is the list of outputs for the variants.
This is an extension of the `output` mode.
If `old` is also `multivar` then it becomes the reference, otherwise we compare using pairs of variants.
- `old`: [string='HEAD'] Reference file. When using git use `HEAD` to refer to the last commit.
Use `HEAD~` to refer the previous to the last commit.

3
docs/samples/generic_plot.kibot.yaml
View File

@ -540,7 +540,8 @@ outputs:
# [string='current'] [git,file,output,multivar,current] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
# Use `current` for the currently loaded PCB/Schematic.
# Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output.
# Use `multivar` to compare a set of variants, in this mode `new` is the list of variants.
# Use `multivar` to compare a set of variants, in this mode `new` is the list of outputs for the variants.
# This is an extension of the `output` mode.
# If `old` is also `multivar` then it becomes the reference, otherwise we compare using pairs of variants
new_type: 'current'
# [string='HEAD'] Reference file. When using git use `HEAD` to refer to the last commit.

3
kibot/out_diff.py
View File

@ -69,7 +69,8 @@ class DiffOptions(BaseOptions):
""" [git,file,output,multivar,current] How to interpret the `new` name. Use `git` for a git hash, branch, etc.
Use `current` for the currently loaded PCB/Schematic.
Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output.
Use `multivar` to compare a set of variants, in this mode `new` is the list of variants.
Use `multivar` to compare a set of variants, in this mode `new` is the list of outputs for the variants.
This is an extension of the `output` mode.
If `old` is also `multivar` then it becomes the reference, otherwise we compare using pairs of variants """
self.cache_dir = ''
""" Directory to cache the intermediate files. Leave it blank to disable the cache """