diff options
| author | Rich Salz <rsalz@akamai.com> | 2019-08-16 08:34:16 -0400 |
|---|---|---|
| committer | Pauli <paul.dale@oracle.com> | 2019-08-27 07:08:11 +1000 |
| commit | 485d336137f2afa62e378bc39dcfa37dcfb222da (patch) | |
| tree | a09e160c8cdc4378fb3d13a9c47989813d131904 /doc/man3/CMS_compress.pod | |
| parent | 6d745d740d37d680ff696486218b650512bbbbc6 (diff) | |
Do not have duplicate section heads
Change find-doc-nits to complain if a section header is repeated,
within a parent header (i.e., duplicate =head2 within a =head1).
In almost all cases, we just remove the duplicate header, as
it was a "continuation" of the =head1 that was already in affect.
In some cases, just remove "=head1 NOTES", possibly moving text
around, because the "NOTES" were really important parts of the
DESCRIPTION section.
No =headX sections should end with a period.
All =head1 labels should be in all uppercase.
No sub-head (=head2, etc) should be in all uppercase.
Update find-doc-nits to reject the above.
Fixup an internal POD link
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Paul Yang <kaishen.yy@antfin.com>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/9631)
Diffstat (limited to 'doc/man3/CMS_compress.pod')
| -rw-r--r-- | doc/man3/CMS_compress.pod | 4 |
1 files changed, 0 insertions, 4 deletions
diff --git a/doc/man3/CMS_compress.pod b/doc/man3/CMS_compress.pod index 56cf26cd57..312484610e 100644 --- a/doc/man3/CMS_compress.pod +++ b/doc/man3/CMS_compress.pod @@ -17,8 +17,6 @@ is the compression algorithm to use or B<NID_undef> to use the default algorithm (zlib compression). B<in> is the content to be compressed. B<flags> is an optional set of flags. -=head1 NOTES - The only currently supported compression algorithm is zlib using the NID NID_zlib_compression. @@ -41,8 +39,6 @@ The compressed data is included in the CMS_ContentInfo structure, unless B<CMS_DETACHED> is set in which case it is omitted. This is rarely used in practice and is not supported by SMIME_write_CMS(). -=head1 NOTES - If the flag B<CMS_STREAM> is set the returned B<CMS_ContentInfo> structure is B<not> complete and outputting its contents via a function that does not properly finalize the B<CMS_ContentInfo> structure will give unpredictable |