docs: promote test subcommand

This commit is contained in:
Christian Schwarz 2017-12-29 22:53:33 +01:00
parent 56f13741f9
commit a622ef1487
4 changed files with 16 additions and 0 deletions

View File

@ -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

View File

@ -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.

View File

@ -12,6 +12,10 @@ Check the respective :ref:`job definition <job>` 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

View File

@ -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`