[pbs-devel] [PATCH proxmox-backup v7 3/4] docs: document new include/exclude paramenter

[Thomas Lamprecht]

Am 02/01/2024 um 12:06 schrieb Philipp Hufnagl:
> Adding the newly introduced optional include/exclude parameter to the
> PBS documentation.
> 
> Signed-off-by: Philipp Hufnagl <p.hufnagl at proxmox.com>
> ---
>  docs/managing-remotes.rst | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst
> index f8dcff6d..10ca1084 100644
> --- a/docs/managing-remotes.rst
> +++ b/docs/managing-remotes.rst
> @@ -116,6 +116,19 @@ of the specified criteria are synced. The available criteria are:
>  The same filter is applied to local groups, for handling of the
>  ``remove-vanished`` option.
>  
> +A ``group-filter`` can be inverted by adding ``exclude:`` to its beginning.
> +
> +* Regular expression example, excluding the match:
> +    .. code-block:: console
> +
> +     # proxmox-backup-manager sync-job update ID --group-filter exclude:regex:'^vm/1\d{2,3}$'
> +
> +For mixing include and exclude filter, following rules apply:
> +
> + - no filters: all backup groups
> + - include: only those matching the include filters
> + - exclude: all but those matching the exclude filters
> + - both: those matching the include filters, but without those matching the exclude filters

FYI: missing a newline here, that broke the admonition node below as sphinx/rst
interprets this as continuation of the list.

Fixed already in git with a follow up, just noting to avoid repetition of 
this tiny mistake, restructured text is (sadly) like python really whitespace
sensitive..

>  .. note:: The ``protected`` flag of remote backup snapshots will not be synced.
>  
>  Namespace Support