On Wed, Apr 23, 2014 at 07:21:23PM -0400, Daniel Kahn Gillmor wrote:

> A serious way to fix this is to have the documentation produced *from*
> the code, so that it gets upgraded in sync.  For example, neither
> x509(1ssl) nor "openssl x509 -help" ever mention the -sha256 option,
> but that option has been supported for years.

No, that won't work well.  A more serious way to fix this is to
reject features or patches (no matter how appealing) that extend
or modify functionality without corresponding documentation changes.
Plus a parallel effort to backfill the documentation gaps and errors.

A tiny contribution below:

diff --git a/doc/apps/req.pod b/doc/apps/req.pod
index 51d3083..151fe8f 100644
--- a/doc/apps/req.pod
+++ b/doc/apps/req.pod
@@ -490,7 +490,7 @@ be input by calling it "1.organizationName".
 The actual permitted field names are any object identifier short or
 long names. These are compiled into OpenSSL and include the usual
 values such as commonName, countryName, localityName, organizationName,
-organizationUnitName, stateOrProvinceName. Additionally emailAddress
+organizationalUnitName, stateOrProvinceName. Additionally emailAddress
 is include as well as name, surname, givenName initials and dnQualifier.
 
 Additional object identifiers can be defined with the B<oid_file> or

-- 
        Viktor.
______________________________________________________________________
OpenSSL Project                                 http://www.openssl.org
Development Mailing List                       [email protected]
Automated List Manager                           [email protected]

Reply via email to