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

[DOCs] Added advice on how to compress links

This commit is contained in:
Salvador E. Tropea 2022-08-31 13:41:06 -03:00
parent e431b42625
commit 75f79b1a72
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

@ -1504,7 +1504,8 @@ Notes:
* Valid keys:
- **`output`**: [string='%f-%i%I%v.%x'] Filename for the output (%i=diff, %x=pdf). Affected by global options.
- `add_link_id`: [boolean=false] When enabled we create a symlink to the output file with a name that contains the
git hashes involved in the comparison.
git hashes involved in the comparison. If you plan to compress the output don't
forget to disable the `follow_links` option.
- `cache_dir`: [string=''] Directory to cache the intermediate files. Leave it blank to disable the cache.
- `diff_mode`: [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

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

@ -416,7 +416,8 @@ outputs:
dir: 'Example/diff_dir'
options:
# [boolean=false] When enabled we create a symlink to the output file with a name that contains the
# git hashes involved in the comparison
# git hashes involved in the comparison. If you plan to compress the output don't
# forget to disable the `follow_links` option
add_link_id: false
# [string=''] Directory to cache the intermediate files. Leave it blank to disable the cache
cache_dir: ''

3
kibot/out_diff.py
View File

@ -89,7 +89,8 @@ class DiffOptions(BaseOptions):
difference bigger than the indicated value will make the diff fail """
self.add_link_id = False
""" When enabled we create a symlink to the output file with a name that contains the
git hashes involved in the comparison """
git hashes involved in the comparison. If you plan to compress the output don't
forget to disable the `follow_links` option """
super().__init__()
self._expand_id = 'diff'
self._expand_ext = 'pdf'