docs: document new Spotlight Elasticsearch options

[samba.git] / docs-xml / smbdotconf / misc / elasticsearchignoreunknowntype.xml

diff --git a/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml b/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml
new file mode 100644 (file)
index 0000000..ca1f873
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="elasticsearch:ignore unknown type"
+                 context="G"
+                 type="boolean"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+  <description>
+    <para>
+      Ignore unknown Spotlight types in search queries. An example query using
+      the unsupported type <literal>&quot;public.calendar-event&quot;</literal>
+      would be
+      <literal>kMDItemContentType==&quot;public.calendar-event&quot;</literal>. By
+      default any query using such a type would completely fail. By enabling
+      this option, if the type match is a subexpression of a larger expression,
+      then this subexpression is just ignored.
+    </para>
+  </description>
+
+  <value type="default">no</value>
+  <value type="example">yes</value>
+</samba:parameter>