This is an automated email from the ASF dual-hosted git repository.

vatamane pushed a commit to branch fix-docs-for-scanner-skip-dbs
in repository https://gitbox.apache.org/repos/asf/couchdb.git

commit 3cc7a87c4982519cec83f56409b87de83cfbd8f4
Author: Nick Vatamaniuc <[email protected]>
AuthorDate: Thu Aug 22 23:00:53 2024 -0400

    Correct scanner docs
    
    Plugin skip section can be full regexes, not just plain strings.
    
    Initially they were just plain strings, but since the `find` plugin got
    regexes, it was easy to just re-use the same logic. In the meantime, I 
forgot
    to update the docs.
---
 src/docs/src/config/scanner.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/docs/src/config/scanner.rst b/src/docs/src/config/scanner.rst
index c395cd8fd..ba62e7c6f 100644
--- a/src/docs/src/config/scanner.rst
+++ b/src/docs/src/config/scanner.rst
@@ -126,31 +126,31 @@ settings in their ``[$plugin]`` section.
 
     .. config:option:: $string
 
-        Skip over databases if their names contain any of the strings in this 
section. ::
+        Skip over databases if their names match any of these regexes. ::
 
             [$plugin.skip_dbs]
-            string1 = true
-            string2 = true
+            regex1 = a|b
+            regex2 = bar(.*)baz
 
 .. config:section:: $plugin.skip_ddocs :: Skip design documents
 
     .. config:option:: $string
 
-        Skip over design documents if their DocIDs contain any of the strings 
in this section. ::
+        Skip over design documents if their DocIDs match any of these regexes. 
::
 
             [$plugin.skip_ddocs]
-            string1 = true
-            string2 = true
+            regex1 = x|y|z
+            regex2 = c(d|e)f
 
 .. config:section:: $plugin.skip_docs :: Skip documents
 
     .. config:option:: $string
 
-        Skip over documents if their DocIds contain any of the strings in this 
section. ::
+        Skip over documents if their DocIds match any of the regexes. ::
 
             [$plugin.skip_docs]
-            string1 = true
-            string2 = true
+            regex1 = k|l
+            regex2 = mno$
 
 .. config:section:: couch_scanner_plugin_find.regexes :: Configure the "Find" 
plugin
 

Reply via email to