From 501645f918b5b9e0c5554edfccf1a4614207a109 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Tue, 17 Sep 2019 23:54:00 +0200 Subject: [PATCH] docs: filter syntax: reference 'snap' job type --- docs/configuration/filter_syntax.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/filter_syntax.rst b/docs/configuration/filter_syntax.rst index 6657998..b18172f 100644 --- a/docs/configuration/filter_syntax.rst +++ b/docs/configuration/filter_syntax.rst @@ -5,7 +5,7 @@ Filter Syntax ============= -For :ref:`source jobs ` and :ref:`push jobs `, a filesystem filter must be defined (field ``filesystems``). +For :ref:`source`, :ref:`push` and :ref:`snap` jobs, a filesystem filter must be defined (field ``filesystems``). A filter takes a filesystem path (in the ZFS filesystem hierarchy) as parameter and returns ``true`` (pass) or ``false`` (block). A filter is specified as a **YAML dictionary** with patterns as keys and booleans as values.