Browse code

Added a comment about how to escape the comment char in exclude files

Florent Viard authored on 2020/03/29 09:39:27
Showing 1 changed files
... ...
@@ -2465,6 +2465,9 @@ def process_patterns(patterns_list, patterns_from, is_glob, option_txt = ""):
2465 2465
     Process --exclude / --include GLOB and REGEXP patterns.
2466 2466
     'option_txt' is 'exclude' / 'include' / 'rexclude' / 'rinclude'
2467 2467
     Returns: patterns_compiled, patterns_text
2468
+    Note: process_patterns_from_file will ignore lines starting with # as these
2469
+    are comments. To target escape the initial #, to use it in a file name, one
2470
+    can use: "[#]" (for exclude) or "\#" (for rexclude).
2468 2471
     """
2469 2472
 
2470 2473
     patterns_compiled = []