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

[Diff] Better `copy_instead_of_link` description 

Related to #275
This commit is contained in:
Salvador E. Tropea 2022-09-05 13:56:56 -03:00
parent e34d4a01e0
commit 460ffca49b
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1508,8 +1508,8 @@ Notes:
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.
- `copy_instead_of_link`: [boolean=false] When `add_link_id` is enabled creates a copy of the file instead of a symlink.
Useful for some Windows setups.
- `copy_instead_of_link`: [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`: [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
changes are red, but you can abort if the difference is bigger than certain threshold.

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

@ -422,8 +422,8 @@ outputs:
add_link_id: false
# [string=''] Directory to cache the intermediate files. Leave it blank to disable the cache
cache_dir: ''
# [boolean=false] When `add_link_id` is enabled creates a copy of the file instead of a symlink.
# Useful for some Windows setups
# [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
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

4
kibot/out_diff.py
View File

@ -74,8 +74,8 @@ class DiffOptions(BaseOptions):
git hashes involved in the comparison. If you plan to compress the output don't
forget to disable the `follow_links` option """
self.copy_instead_of_link = False
""" When `add_link_id` is enabled creates a copy of the file instead of a symlink.
Useful for some Windows setups """
""" Modifies the behavior of `add_link_id` to create a copy of the file instead of a
symlink. Useful for some Windows setups """
self.force_checkout = False
""" When `old_type` and/or `new_type` are `git` KiBot will checkout the indicated point.
Before doing it KiBot will stash any change. Under some circumstances git could fail