From: Cole Robinson <crobinso@redhat.com>
Date: Sun, 14 Jul 2019 23:46:15 +0000 (-0400)
Subject: docs: formatnetwork: Document xmlns:dnsmasq
X-Git-Tag: v5.6.0-rc1~179
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e10b599a24205576de1d4b9f85b9b4e9968865e2;p=thirdparty%2Flibvirt.git

docs: formatnetwork: Document xmlns:dnsmasq

Reviewed-by: Laine Stump <laine@laine.org>
Signed-off-by: Cole Robinson <crobinso@redhat.com>
---

diff --git a/docs/formatnetwork.html.in b/docs/formatnetwork.html.in
index 509cca9e8b..2448fb09e7 100644
--- a/docs/formatnetwork.html.in
+++ b/docs/formatnetwork.html.in
@@ -1096,6 +1096,28 @@
       </dd>
     </dl>
 
+    <h3><a id="elementsNamespaces">Network namespaces</a></h3>
+
+    <p>
+      A special XML namespace is available for passing options directly to the
+      underlying dnsmasq configuration file. Usage of XML namespaces comes with no
+      support guarantees, so use at your own risk.
+    </p>
+
+    <p>
+      This example XML will pass the option strings <code>foo=bar</code> and
+      <code>cname=*.foo.example.com,master.example.com</code> directly to the
+      underlying dnsmasq instance.
+      <pre>
+&lt;network xmlns:dnsmasq='http://libvirt.org/schemas/network/dnsmasq/1.0'&gt;
+  ...
+  &lt;dnsmasq:options&gt;
+    &lt;dnsmasq:option value="foo=bar"/&gt;
+    &lt;dnsmasq:option value="cname=*.foo.example.com,master.example.com"/&gt;
+  &lt;/dnsmasq:options&gt;
+&lt;/network&gt;</pre>
+    </p>
+
     <h2><a id="examples">Example configuration</a></h2>
 
     <h3><a id="examplesNAT">NAT based network</a></h3>