[5/5] docs: formatnetwork: Document xmlns:dnsmasq

Message ID d8953e8fe107e3e83da0e3bab4bf9c6da97a2131.1563148979.git.crobinso@redhat.com
State Accepted
Commit e10b599a24205576de1d4b9f85b9b4e9968865e2
Headers show
Series
  • network: xmlns dnsmasq option passthrough
Related show

Commit Message

Cole Robinson July 15, 2019, 12:04 a.m.
Signed-off-by: Cole Robinson <crobinso@redhat.com>

---
 docs/formatnetwork.html.in | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

-- 
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Patch

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>