From: Steve Langasek Date: Tue, 10 Aug 2010 01:43:11 +0000 (-0700) Subject: don't use sentence fragments, make the docs searchable X-Git-Tag: release-0.3.33~12 X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fuserdir-ldap-cgi.git;a=commitdiff_plain;h=2a2b117cc76def998556699d8c91d4ecb68813cb don't use sentence fragments, make the docs searchable 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 --- diff --git a/html/doc-mail.wml b/html/doc-mail.wml index 8b48dd8..99fcb04 100644 --- a/html/doc-mail.wml +++ b/html/doc-mail.wml @@ -124,11 +124,11 @@ DNS and ssh keys, any list specified must be specified in its enterity. The for listtype dns.domain.of.rbl/IP to whitelist where listtype is one of mailRBL, mailRHSBL, and mailWhitelist -
  • 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: 'foo in a 1.2.3.4', 'foo in cname -foo.bar.', or 'foo in mx 10 foo.bar.' (note the trailing dot). +
  • 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: 'foo in a 1.2.3.4', +'foo in cname foo.bar.', or 'foo in mx 10 foo.bar.' (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.