diff --git a/docs/configuration/map_filter_syntax.rst b/docs/configuration/map_filter_syntax.rst index 8e74e4d..3f6f44a 100644 --- a/docs/configuration/map_filter_syntax.rst +++ b/docs/configuration/map_filter_syntax.rst @@ -82,6 +82,10 @@ The example is from the :sampleconf:`localbackup/host1.yml` example config. zroot/poudriere/ports/2017Q3 => NOT MAPPED zroot/poudriere/ports/HEAD => NOT MAPPED +.. TIP:: + + You can try out patterns for a configured job using the ``zrepl test`` subcommand. + .. _pattern-filter: Filters diff --git a/docs/configuration/preface.rst b/docs/configuration/preface.rst index ed578d5..989f720 100644 --- a/docs/configuration/preface.rst +++ b/docs/configuration/preface.rst @@ -31,3 +31,9 @@ Alternatively, for default settings, the following should to the trick. chmod -R 0700 /var/run/zrepl +---------- +Validating +---------- + +The config can be validated using the ``zrepl test`` subcommand. + diff --git a/docs/configuration/prune.rst b/docs/configuration/prune.rst index 9f2fd62..a102f51 100644 --- a/docs/configuration/prune.rst +++ b/docs/configuration/prune.rst @@ -12,6 +12,10 @@ Check the respective :ref:`job definition ` for details. Currently, the :ref:`prune-retention-grid` is the only supported pruning policy. +.. TIP:: + + You can perform a dry-run of a job's pruning policy using the ``zrepl test`` subcommand. + .. _prune-retention-grid: Retention Grid diff --git a/docs/usage.rst b/docs/usage.rst index b65d37e..dba9729 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -25,6 +25,8 @@ CLI Overview - control / query the daemon * - ``zrepl control status`` - show job activity / monitoring (``--format raw``) + * - ``zrepl test`` + - test configuration, try pattern syntax, dry run pruning policy, etc. * - ``zrepl stdinserver`` - see :ref:`transport-ssh+stdinserver`