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

More style adjusts to the replacement docs

This commit is contained in:
Salvador E. Tropea 2021-12-03 18:11:06 -03:00
parent 2e7f3b8180
commit 308725e24f
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -119,10 +119,10 @@ This section is used to specify tasks that will be executed before generating an
- `ignore_unconnected`: [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing.
- `pcb_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date.
* Valid keys:
- `date_command`: [string=''] Command to get the date to use in the PCB.
```git log -1 --format='%as' -- $KIBOT_PCB_NAME```
Will return the date in YYYY-MM-DD format.
```date -d @`git log -1 --format='%at' -- $KIBOT_PCB_NAME` +%Y-%m-%d_%H-%M-%S```
- `date_command`: [string=''] Command to get the date to use in the PCB.\
```git log -1 --format='%as' -- $KIBOT_PCB_NAME```\
Will return the date in YYYY-MM-DD format.\
```date -d @`git log -1 --format='%at' -- $KIBOT_PCB_NAME` +%Y-%m-%d_%H-%M-%S```\
Will return the date in YYYY-MM-DD_HH-MM-SS format.
- `replace_tags`: [dict|list(dict)] Tag or tags to replace.
* Valid keys:
@ -140,10 +140,10 @@ This section is used to specify tasks that will be executed before generating an
The report file name is controlled by the global output pattern (%i=erc %x=txt).
- `sch_replace`: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date.
* Valid keys:
- `date_command`: [string=''] Command to get the date to use in the SCH.
```git log -1 --format='%as' -- $KIBOT_SCH_NAME```
Will return the date in YYYY-MM-DD format.
```date -d @`git log -1 --format='%at' -- $KIBOT_SCH_NAME` +%Y-%m-%d_%H-%M-%S```
- `date_command`: [string=''] Command to get the date to use in the SCH.\
```git log -1 --format='%as' -- $KIBOT_SCH_NAME```\
Will return the date in YYYY-MM-DD format.\
```date -d @`git log -1 --format='%at' -- $KIBOT_SCH_NAME` +%Y-%m-%d_%H-%M-%S```\
Will return the date in YYYY-MM-DD_HH-MM-SS format.
- `replace_tags`: [dict|list(dict)] Tag or tags to replace.
* Valid keys:

8
kibot/pre_any_replace.py
View File

@ -51,10 +51,10 @@ class Base_ReplaceOptions(Optionable):
super().__init__()
with document:
self.date_command = ''
""" Command to get the date to use in the PCB.
```git log -1 --format='%as' -- $KIBOT_PCB_NAME```
Will return the date in YYYY-MM-DD format.
```date -d @`git log -1 --format='%at' -- $KIBOT_PCB_NAME` +%Y-%m-%d_%H-%M-%S```
""" Command to get the date to use in the PCB.\\
```git log -1 --format='%as' -- $KIBOT_PCB_NAME```\\
Will return the date in YYYY-MM-DD format.\\
```date -d @`git log -1 --format='%at' -- $KIBOT_PCB_NAME` +%Y-%m-%d_%H-%M-%S```\\
Will return the date in YYYY-MM-DD_HH-MM-SS format """
self.replace_tags = TagReplaceBase
""" [dict|list(dict)] Tag or tags to replace """