]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
clean up refpurpose contents to be consistent
authorJeremy C. Reed <jreed@isc.org>
Thu, 5 Nov 2015 18:01:07 +0000 (13:01 -0500)
committerJeremy C. Reed <jreed@isc.org>
Thu, 5 Nov 2015 18:01:07 +0000 (13:01 -0500)
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.

bin/dnssec/dnssec-importkey.docbook
bin/dnssec/dnssec-revoke.docbook
bin/dnssec/dnssec-settime.docbook
bin/python/dnssec-checkds.docbook
bin/tools/named-rrchecker.docbook

index f4c3f172b331fe11fbd1405ca2bde7b739dc33c6..098b660c006d1cbbbdef76b27eb3bd26ccac8b59 100644 (file)
@@ -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>
index 156b509a9a4d909b3367f2f22f84ba9525a25916..83e487b8b9f8f2d3ae2d69c9f4f16c951c6e308d 100644 (file)
@@ -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>
index ceb2fe02aaf00fd82b95ef49be580717fc067138..4c5aebb1469919e673113aca8553d40a5d9c4abd 100644 (file)
@@ -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>
index dcf172f0ec7fa976717e2c633588caf5accd08f2..ed49e75b3fffd64dc9e8e599a556fac5f73dfdab 100644 (file)
@@ -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>
index d98c713d6b00a8cb17933030d8fbb9ded5b7204f..34049777ce828299631cd9a549534f1be466bc54 100644 (file)
@@ -30,7 +30,7 @@
   </refmeta>
   <refnamediv>
     <refname><application>named-rrchecker</application></refname>
-    <refpurpose>syntax checker for individual DNS resource records</refpurpose>
+    <refpurpose>syntax checker for individual DNS resource records</refpurpose>
   </refnamediv>
 
   <docinfo>