From: Jeremy C. Reed <jreed@isc.org>
Date: Thu, 5 Nov 2015 18:01:07 +0000 (-0500)
Subject: clean up refpurpose contents to be consistent
X-Git-Tag: v9.11.0a1~328
X-Git-Url: http://git.ipfire.org/gitweb/?a=commitdiff_plain;h=f02194c0538094556090ded7964df2b72771d85e;p=thirdparty%2Fbind9.git

clean up refpurpose contents to be consistent

This is to be consistent with other manuals:
 - no period punctuation at end
 - no capitalization at beginning unless acronym or proper noun
 - and no simple article (like "A") to start sentence.

While the docbook specification says refpurpose is a "one sentence",
its examples show it with the rules shown above.

Also compared with many manpages as this is common format for the
.Nd macro's one line description.
---

diff --git a/bin/dnssec/dnssec-importkey.docbook b/bin/dnssec/dnssec-importkey.docbook
index f4c3f172b33..098b660c006 100644
--- a/bin/dnssec/dnssec-importkey.docbook
+++ b/bin/dnssec/dnssec-importkey.docbook
@@ -32,7 +32,7 @@
 
   <refnamediv>
     <refname><application>dnssec-importkey</application></refname>
-    <refpurpose>Import DNSKEY records from external systems so they can be managed.</refpurpose>
+    <refpurpose>import DNSKEY records from external systems so they can be managed</refpurpose>
   </refnamediv>
 
   <docinfo>
diff --git a/bin/dnssec/dnssec-revoke.docbook b/bin/dnssec/dnssec-revoke.docbook
index 156b509a9a4..83e487b8b9f 100644
--- a/bin/dnssec/dnssec-revoke.docbook
+++ b/bin/dnssec/dnssec-revoke.docbook
@@ -32,7 +32,7 @@
 
   <refnamediv>
     <refname><application>dnssec-revoke</application></refname>
-    <refpurpose>Set the REVOKED bit on a DNSSEC key</refpurpose>
+    <refpurpose>set the REVOKED bit on a DNSSEC key</refpurpose>
   </refnamediv>
 
   <docinfo>
diff --git a/bin/dnssec/dnssec-settime.docbook b/bin/dnssec/dnssec-settime.docbook
index ceb2fe02aaf..4c5aebb1469 100644
--- a/bin/dnssec/dnssec-settime.docbook
+++ b/bin/dnssec/dnssec-settime.docbook
@@ -32,7 +32,7 @@
 
   <refnamediv>
     <refname><application>dnssec-settime</application></refname>
-    <refpurpose>Set the key timing metadata for a DNSSEC key</refpurpose>
+    <refpurpose>set the key timing metadata for a DNSSEC key</refpurpose>
   </refnamediv>
 
   <docinfo>
diff --git a/bin/python/dnssec-checkds.docbook b/bin/python/dnssec-checkds.docbook
index dcf172f0ec7..ed49e75b3ff 100644
--- a/bin/python/dnssec-checkds.docbook
+++ b/bin/python/dnssec-checkds.docbook
@@ -32,7 +32,7 @@
 
   <refnamediv>
     <refname><application>dnssec-checkds</application></refname>
-    <refpurpose>A DNSSEC delegation consistency checking tool.</refpurpose>
+    <refpurpose>DNSSEC delegation consistency checking tool</refpurpose>
   </refnamediv>
 
   <docinfo>
diff --git a/bin/tools/named-rrchecker.docbook b/bin/tools/named-rrchecker.docbook
index d98c713d6b0..34049777ce8 100644
--- a/bin/tools/named-rrchecker.docbook
+++ b/bin/tools/named-rrchecker.docbook
@@ -30,7 +30,7 @@
   </refmeta>
   <refnamediv>
     <refname><application>named-rrchecker</application></refname>
-    <refpurpose>A syntax checker for individual DNS resource records</refpurpose>
+    <refpurpose>syntax checker for individual DNS resource records</refpurpose>
   </refnamediv>
 
   <docinfo>