don't use sentence fragments, make the docs searchable
authorSteve Langasek <vorlon@debian.org>
Tue, 10 Aug 2010 01:43:11 +0000 (18:43 -0700)
committerMartin Zobel-Helas <zobel@debian.org>
Tue, 10 Aug 2010 06:38:09 +0000 (08:38 +0200)
Hi all,

Here's a patch to userdir-ldap-cgi to improve the documentation in
doc-mail.wml:

 Replace the sentence fragment at the beginning of the documentation on
 DNS records with a complete sentence that uses the actual field name, making
 the documentation more searchable.

Signed-off-by: Martin Zobel-Helas <zobel@debian.org>
html/doc-mail.wml

index 8b48dd8..99fcb04 100644 (file)
@@ -124,11 +124,11 @@ DNS and ssh keys, any list specified must be specified in its enterity.  The for
 <b>listtype</b> <b>dns.domain.of.rbl/IP to whitelist</b> where listtype is one of mailRBL,
 mailRHSBL, and mailWhitelist
 
 <b>listtype</b> <b>dns.domain.of.rbl/IP to whitelist</b> where listtype is one of mailRBL,
 mailRHSBL, and mailWhitelist
 
-<li>Debian.net DNS Zone Entry. The only way to get a debian.net address is
-to use the mail gateway. It
-will verify the request and prevent name collisions automatically. Requests
-can take three forms: <tt>'foo in a 1.2.3.4'</tt>, <tt>'foo in cname
-foo.bar.'</tt>, or <tt>'foo in mx 10 foo.bar.'</tt> (note the trailing dot).
+<li>The only way to get a dnsZoneEntry record for a debian.net address is to
+use the mail gateway. It will verify the request and prevent name collisions
+automatically. Requests can take three forms: <tt>'foo in a 1.2.3.4'</tt>,
+<tt>'foo in cname foo.bar.'</tt>, or <tt>'foo in mx 10 foo.bar.'</tt> (note
+the trailing dot).
 Note that you
 cannot combine CNAME with any other record types. The precise form
 is critical and must not be deviated from.
 Note that you
 cannot combine CNAME with any other record types. The precise form
 is critical and must not be deviated from.