From 75f79b1a72f14bf1fb2976d49487d2b3f305739d Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Wed, 31 Aug 2022 13:41:06 -0300 Subject: [PATCH] [DOCs] Added advice on how to compress links --- README.md | 3 ++- docs/samples/generic_plot.kibot.yaml | 3 ++- kibot/out_diff.py | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7ab84991..aea4d142 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index f2965e3a..0c1b26d4 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -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: '' diff --git a/kibot/out_diff.py b/kibot/out_diff.py index d4b38d0c..1e3116b9 100644 --- a/kibot/out_diff.py +++ b/kibot/out_diff.py @@ -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'