[deployment-guide/comm-rel: 367/727] Updated the Comment Tags section.

Jaromir Hradilek jhradile at fedoraproject.org
Tue Oct 19 12:55:33 UTC 2010


commit 0040ca7364765d127d240d40f656766c153fa39d
Author: Jaromir Hradilek <jhradile at redhat.com>
Date:   Fri Aug 13 18:06:19 2010 +0200

    Updated the Comment Tags section.

 en-US/The_BIND_DNS_Server.xml |   48 +++++++++++++++++++++++++---------------
 1 files changed, 30 insertions(+), 18 deletions(-)
---
diff --git a/en-US/The_BIND_DNS_Server.xml b/en-US/The_BIND_DNS_Server.xml
index 93202c6..59d110d 100644
--- a/en-US/The_BIND_DNS_Server.xml
+++ b/en-US/The_BIND_DNS_Server.xml
@@ -903,25 +903,37 @@ options {
     <section id="s2-bind-namedconf-comm">
       <title>Comment Tags</title>
       <para>
-        The following is a list of valid comment tags used within <filename>named.conf</filename>:
+        Additionally to statements, the <filename>/etc/named.conf</filename> file can also contain comments. The comments are ignored by the <systemitem class="service">named</systemitem> service, but can prove useful when providing additional information to a user. The following are valid comment tags:
       </para>
-      <itemizedlist>
-        <listitem>
-          <para>
-            <command>//</command> — When placed at the beginning of a line, that line is ignored by <command>named</command>.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            <command>#</command> — When placed at the beginning of a line, that line is ignored by <command>named</command>.
-          </para>
-        </listitem>
-        <listitem>
-          <para>
-            <command>/*</command> and <command>*/</command> — When text is enclosed in these tags, the block of text is ignored by <command>named</command>.
-          </para>
-        </listitem>
-      </itemizedlist>
+      <variablelist>
+        <varlistentry>
+          <term><literal>//</literal></term>
+          <listitem>
+            <para>
+              The text after the <literal>//</literal> characters to the end of the line is considered a comment. For example:
+            </para>
+            <screen>notify yes;  // notify all secondary name servers</screen>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><literal>#</literal></term>
+          <listitem>
+            <para>
+              The text after the <literal>#</literal> character to the end of the line is considered a comment. For example:
+            </para>
+            <screen>notify yes;  # notify all secondary name servers</screen>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><literal>/*</literal> and <literal>*/</literal></term>
+          <listitem>
+            <para>
+              The block of text enclosed in <literal>/*</literal> and <literal>*/</literal> is considered a comment. For example:
+            </para>
+            <screen>notify yes;  /* notify all secondary name servers */</screen>
+          </listitem>
+        </varlistentry>
+      </variablelist>
     </section>
   </section>
   <section id="s1-bind-zone">


More information about the docs-commits mailing list