docs: --pattern* not experimental any more, fixes #6134

This commit is contained in:
Thomas Waldmann 2022-01-31 20:55:08 +01:00
parent 3a552b4c8b
commit 5d4dda75d3
1 changed files with 7 additions and 10 deletions

View File

@ -2228,10 +2228,9 @@ class Archiver:
File patterns support these styles: fnmatch, shell, regular expressions, File patterns support these styles: fnmatch, shell, regular expressions,
path prefixes and path full-matches. By default, fnmatch is used for path prefixes and path full-matches. By default, fnmatch is used for
``--exclude`` patterns and shell-style is used for the experimental ``--exclude`` patterns and shell-style is used for the ``--pattern``
``--pattern`` option. For commands that support patterns in their option. For commands that support patterns in their ``PATH`` argument
``PATH`` argument like (``borg list``), the default pattern is path like (``borg list``), the default pattern is path prefix.
prefix.
Starting with Borg 1.2, for all but regular expression pattern matching Starting with Borg 1.2, for all but regular expression pattern matching
styles, all paths are treated as relative, meaning that a leading path styles, all paths are treated as relative, meaning that a leading path
@ -2351,11 +2350,9 @@ class Archiver:
EOF EOF
$ borg create --exclude-from exclude.txt backup / $ borg create --exclude-from exclude.txt backup /
.. container:: experimental
A more general and easier to use way to define filename matching patterns exists A more general and easier to use way to define filename matching patterns exists
with the experimental ``--pattern`` and ``--patterns-from`` options. Using these, you with the ``--pattern`` and ``--patterns-from`` options. Using these, you may
may specify the backup roots (starting points) and patterns for inclusion/exclusion. specify the backup roots (starting points) and patterns for inclusion/exclusion.
A root path starts with the prefix `R`, followed by a path (a plain path, not a A root path starts with the prefix `R`, followed by a path (a plain path, not a
file pattern). An include rule starts with the prefix +, an exclude rule starts file pattern). An include rule starts with the prefix +, an exclude rule starts
with the prefix -, an exclude-norecurse rule starts with !, all followed by a pattern. with the prefix -, an exclude-norecurse rule starts with !, all followed by a pattern.
@ -2813,9 +2810,9 @@ class Archiver:
add_option('--exclude-from', metavar='EXCLUDEFILE', action=ArgparseExcludeFileAction, add_option('--exclude-from', metavar='EXCLUDEFILE', action=ArgparseExcludeFileAction,
help='read exclude patterns from EXCLUDEFILE, one per line') help='read exclude patterns from EXCLUDEFILE, one per line')
add_option('--pattern', metavar='PATTERN', action=ArgparsePatternAction, add_option('--pattern', metavar='PATTERN', action=ArgparsePatternAction,
help='experimental: include/exclude paths matching PATTERN') help='include/exclude paths matching PATTERN')
add_option('--patterns-from', metavar='PATTERNFILE', action=ArgparsePatternFileAction, add_option('--patterns-from', metavar='PATTERNFILE', action=ArgparsePatternFileAction,
help='experimental: read include/exclude patterns from PATTERNFILE, one per line') help='read include/exclude patterns from PATTERNFILE, one per line')
if tag_files: if tag_files:
add_option('--exclude-caches', dest='exclude_caches', action='store_true', add_option('--exclude-caches', dest='exclude_caches', action='store_true',