]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Allow man7 pages to not have a DESCRIPTION section
authorMatt Caswell <matt@openssl.org>
Wed, 7 Jun 2023 11:10:41 +0000 (12:10 +0100)
committerPauli <pauli@openssl.org>
Wed, 14 Jun 2023 03:08:37 +0000 (13:08 +1000)
For tutorial type pages it doesn't make any sense to have a DESCRIPTION
section.

Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21133)

util/find-doc-nits

index 795c59800f3d484775713ff2ed8f32eefe92cf87..877838f00e697334461a927978a9242b584d038c 100755 (executable)
@@ -86,10 +86,10 @@ die "Argument of -m option may contain only man1, man3, man5, and/or man7"
 my @sections = ( split /[, ]/, $opt_m );
 
 my %mandatory_sections = (
-    '*' => [ 'NAME', 'DESCRIPTION', 'COPYRIGHT' ],
-    1   => [ 'SYNOPSIS', 'OPTIONS' ],
-    3   => [ 'SYNOPSIS', 'RETURN VALUES' ],
-    5   => [ ],
+    '*' => [ 'NAME', 'COPYRIGHT' ],
+    1   => [ 'DESCRIPTION', 'SYNOPSIS', 'OPTIONS' ],
+    3   => [ 'DESCRIPTION', 'SYNOPSIS', 'RETURN VALUES' ],
+    5   => [ 'DESCRIPTION' ],
     7   => [ ]
                          );