[gnutls-devel] [PATCH] argument descriptions should not end in a dot

Daniel Kahn Gillmor dkg at fifthhorseman.net
Mon Nov 4 07:43:56 CET 2013


When the descrip value for an argument ends in a dot, the rendered
documentation places two dots (for example "specify a password file.."
in srptool(1)).

Most of the descriptions are declared properly (without a trailing
dot), but this patch should clean up the rest.

After this commit, any auto-generated documentation that is committed
to git will probably will also need to be refreshed (or removed from
git entirely and generated from the definitions during build, which
might be cleaner).
---
 src/args-std.def      |  2 +-
 src/certtool-args.def | 16 ++++++++--------
 src/cli-args.def      |  4 ++--
 src/danetool-args.def | 22 +++++++++++-----------
 src/psk-args.def      |  2 +-
 src/srptool-args.def  |  6 +++---
 6 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/src/args-std.def b/src/args-std.def
index 10cedda..3997e18 100644
--- a/src/args-std.def
+++ b/src/args-std.def
@@ -24,7 +24,7 @@ flag = {
     value     = d;
     arg-type  = number;
     arg-range = "0 -> 9999";
-    descrip   = "Enable debugging.";
+    descrip   = "Enable debugging";
     doc       = "Specifies the debug level.";
 };
 
diff --git a/src/certtool-args.def b/src/certtool-args.def
index c99da89..767bd14 100644
--- a/src/certtool-args.def
+++ b/src/certtool-args.def
@@ -64,33 +64,33 @@ flag = {
 flag = {
     name      = verify-chain;
     value     = e;
-    descrip   = "Verify a PEM encoded certificate chain.";
+    descrip   = "Verify a PEM encoded certificate chain";
     doc = "The last certificate in the chain must be a self signed one.";
 };
 
 flag = {
     name      = verify;
-    descrip   = "Verify a PEM encoded certificate chain using a trusted list.";
+    descrip   = "Verify a PEM encoded certificate chain using a trusted list";
     doc = "The trusted certificate list must be loaded with --load-ca-certificate.";
     flags-must = load-ca-certificate;
 };
 
 flag = {
     name      = verify-crl;
-    descrip   = "Verify a CRL using a trusted list.";
+    descrip   = "Verify a CRL using a trusted list";
     doc = "The trusted certificate list must be loaded with --load-ca-certificate.";
     flags-must = load-ca-certificate;
 };
 
 flag = {
     name      = generate-dh-params;
-    descrip   = "Generate PKCS #3 encoded Diffie-Hellman parameters.";
+    descrip   = "Generate PKCS #3 encoded Diffie-Hellman parameters";
     doc = "";
 };
 
 flag = {
     name      = get-dh-params;
-    descrip   = "Get the included PKCS #3 encoded Diffie-Hellman parameters.";
+    descrip   = "Get the included PKCS #3 encoded Diffie-Hellman parameters";
     doc = "Returns stored DH parameters in GnuTLS. Those parameters are used in the SRP protocol. The parameters returned by fresh generation
 are more efficient since GnuTLS 3.0.9.";
 };
@@ -303,13 +303,13 @@ flag = {
 flag = {
     name      = hash;
     arg-type  = string;
-    descrip   = "Hash algorithm to use for signing.";
+    descrip   = "Hash algorithm to use for signing";
     doc = "Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512.";
 };
 
 flag = {
     name      = inder;
-    descrip   = "Use DER format for input certificates and private keys.";
+    descrip   = "Use DER format for input certificates and private keys";
     disabled;
     disable   = "no";
     doc       = "The input files will be assumed to be in DER or RAW format. 
@@ -346,7 +346,7 @@ flag = {
     name      = sec-param;
     arg-type  = string;
     arg-name  = "Security parameter";
-    descrip   = "Specify the security level [low, legacy, normal, high, ultra].";
+    descrip   = "Specify the security level [low, legacy, normal, high, ultra]";
     doc      = "This is alternative to the bits option.";
 };
 
diff --git a/src/cli-args.def b/src/cli-args.def
index 957ed9f..7b920ac 100644
--- a/src/cli-args.def
+++ b/src/cli-args.def
@@ -32,7 +32,7 @@ available via DNSSEC.";
 
 flag = {
     name      = local-dns;
-    descrip   = "Use the local DNS server for DNSSEC resolving.";
+    descrip   = "Use the local DNS server for DNSSEC resolving";
     disabled;
     disable   = "no";
     doc       = "This option will use the local DNS server for DNSSEC.
@@ -72,7 +72,7 @@ flag = {
 flag = {
     name      = starttls;
     value     = s;
-    descrip   = "Connect, establish a plain session and start TLS.";
+    descrip   = "Connect, establish a plain session and start TLS";
     doc       = "The TLS session will be initiated when EOF or a SIGALRM is received.";
 };
 
diff --git a/src/danetool-args.def b/src/danetool-args.def
index b22fd41..33baf9d 100644
--- a/src/danetool-args.def
+++ b/src/danetool-args.def
@@ -35,38 +35,38 @@ flag = {
 flag = {
     name      = hash;
     arg-type  = string;
-    descrip   = "Hash algorithm to use for signing.";
+    descrip   = "Hash algorithm to use for signing";
     doc = "Available hash functions are SHA1, RMD160, SHA256, SHA384, SHA512.";
 };
 
 flag = {
     name      = check;
     arg-type  = string;
-    descrip   = "Check a host's DANE TLSA entry.";
+    descrip   = "Check a host's DANE TLSA entry";
     doc = "Obtains the DANE TLSA entry from the given hostname and prints information. Note that the actual certificate of the host has to be provided using --load-certificate.";
 };
 
 flag = {
     name      = check-ee;
-    descrip   = "Check only the end-entity's certificate.";
+    descrip   = "Check only the end-entity's certificate";
     doc = "Checks the end-entity's certificate only. Trust anchors or CAs are not considered.";
 };
 
 flag = {
     name      = check-ca;
-    descrip   = "Check only the CA's certificate.";
+    descrip   = "Check only the CA's certificate";
     doc = "Checks the trust anchor's and CA's certificate only. End-entities are not considered.";
 };
 
 flag = {
     name      = insecure;
-    descrip   = "Do not verify any DNSSEC signature.";
+    descrip   = "Do not verify any DNSSEC signature";
     doc = "Ignores any DNSSEC signature verification results.";
 };
 
 flag = {
     name      = local-dns;
-    descrip   = "Use the local DNS server for DNSSEC resolving.";
+    descrip   = "Use the local DNS server for DNSSEC resolving";
     disabled;
     disable   = "no";
     doc       = "This option will use the local DNS server for DNSSEC.
@@ -75,7 +75,7 @@ This is disabled by default due to many servers not allowing DNSSEC.";
 
 flag = {
     name      = inder;
-    descrip   = "Use DER format for input certificates and private keys.";
+    descrip   = "Use DER format for input certificates and private keys";
     disabled;
     disable   = "no";
     doc       = "The input files will be assumed to be in DER or RAW format. 
@@ -114,20 +114,20 @@ flag = {
 flag = {
     name      = port;
     arg-type  = number;
-    descrip   = "Specify the port number for the DANE data.";
+    descrip   = "Specify the port number for the DANE data";
     default-value = 443;
     doc      = "";
 };
 
 flag = {
     name      = ca;
-    descrip   = "Whether the provided certificate or public key is a Certificate Authority.";
+    descrip   = "Whether the provided certificate or public key is a Certificate Authority";
     doc      = "Marks the DANE RR as a CA certificate if specified.";
 };
 
 flag = {
     name      = x509;
-    descrip   = "Use the hash of the X.509 certificate, rather than the public key.";
+    descrip   = "Use the hash of the X.509 certificate, rather than the public key";
     doc      = "This option forces the generated record to contain the hash of the full X.509 certificate. By default only the hash of the public key is used.";
 };
 
@@ -138,7 +138,7 @@ flag = {
 
 flag = {
     name      = domain;
-    descrip   = "The provided certificate or public key is issued by the local domain.";
+    descrip   = "The provided certificate or public key is issued by the local domain";
     enabled;
     disable   = "no";
     doc      = "DANE distinguishes certificates and public keys offered via the DNSSEC to trusted and local entities. This flag indicates that this is a domain-issued certificate, meaning that there could be no CA involved.";
diff --git a/src/psk-args.def b/src/psk-args.def
index d19ae26..819acdb 100644
--- a/src/psk-args.def
+++ b/src/psk-args.def
@@ -30,7 +30,7 @@ flag = {
     name      = passwd;
     value     = p;
     arg-type  = string;
-    descrip   = "specify a password file.";
+    descrip   = "specify a password file";
     doc       = "";
 };
 
diff --git a/src/srptool-args.def b/src/srptool-args.def
index cb78e3b..c6fdd71 100644
--- a/src/srptool-args.def
+++ b/src/srptool-args.def
@@ -20,7 +20,7 @@ flag = {
     value     = i;
     arg-type  = number;
     arg-default = 1;
-    descrip   = "specify the index of the group parameters in tpasswd.conf to use.";
+    descrip   = "specify the index of the group parameters in tpasswd.conf to use";
     doc = "";
 };
 
@@ -36,7 +36,7 @@ flag = {
     name      = passwd;
     value     = p;
     arg-type  = string;
-    descrip   = "specify a password file.";
+    descrip   = "specify a password file";
     doc       = "";
 };
 
@@ -44,7 +44,7 @@ flag = {
     name      = salt;
     value     = s;
     arg-type  = number;
-    descrip   = "specify salt size.";
+    descrip   = "specify salt size";
     doc = "";
 };
 
-- 
1.8.4.rc3




More information about the Gnutls-devel mailing list