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

[Lukas Wagner]

On 11/9/23 15:43, Philipp Hufnagl wrote:
> 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 | 8 ++++++++
>   1 file changed, 8 insertions(+)
> 
> diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst
> index 1c52e120..2f08c3b1 100644
> --- a/docs/managing-remotes.rst
> +++ b/docs/managing-remotes.rst
> @@ -116,6 +116,14 @@ 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}$'
> +
> +If include as well as exclude filters are used, all include filters will be run before the exclude filters.

Maybe it would make sense here to enumerate the different cases and 
their exact behaviors, e.g. in a table?

  - 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

Also, I'm not sure if 'will be run before' is easy to understand for 
users. I think something alike how I described the 'both' case should be 
easier to understand


-- 
- Lukas