From d9321c09ea0b1231d9752935e15eb05231ae147a Mon Sep 17 00:00:00 2001 From: Nikolay Morozov Date: Thu, 14 May 2020 22:32:59 +0300 Subject: [PATCH] Fix small documentation issues Reviewed-by: Tomas Mraz Reviewed-by: Matt Caswell (Merged from https://github.com/openssl/openssl/pull/11835) --- doc/man3/ASN1_STRING_TABLE_add.pod | 2 +- doc/man3/ASN1_STRING_length.pod | 6 ++-- doc/man3/ASN1_STRING_new.pod | 4 +-- doc/man3/ISSUER_SIGN_TOOL_new.pod | 51 ------------------------------ doc/man3/X509_dup.pod | 5 +++ doc/man3/d2i_X509.pod | 2 ++ util/missingcrypto.txt | 2 -- 7 files changed, 13 insertions(+), 59 deletions(-) delete mode 100644 doc/man3/ISSUER_SIGN_TOOL_new.pod diff --git a/doc/man3/ASN1_STRING_TABLE_add.pod b/doc/man3/ASN1_STRING_TABLE_add.pod index f7b65fc23e..340a99e683 100644 --- a/doc/man3/ASN1_STRING_TABLE_add.pod +++ b/doc/man3/ASN1_STRING_TABLE_add.pod @@ -13,7 +13,7 @@ ASN1_STRING_TABLE_cleanup - ASN1_STRING_TABLE manipulation functions int ASN1_STRING_TABLE_add(int nid, long minsize, long maxsize, unsigned long mask, unsigned long flags); - ASN1_STRING_TABLE * ASN1_STRING_TABLE_get(int nid); + ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid); void ASN1_STRING_TABLE_cleanup(void); =head1 DESCRIPTION diff --git a/doc/man3/ASN1_STRING_length.pod b/doc/man3/ASN1_STRING_length.pod index ae03dd9737..5d974fddd1 100644 --- a/doc/man3/ASN1_STRING_length.pod +++ b/doc/man3/ASN1_STRING_length.pod @@ -11,10 +11,10 @@ ASN1_STRING_to_UTF8 - ASN1_STRING utility functions #include int ASN1_STRING_length(ASN1_STRING *x); - const unsigned char * ASN1_STRING_get0_data(const ASN1_STRING *x); - unsigned char * ASN1_STRING_data(ASN1_STRING *x); + const unsigned char *ASN1_STRING_get0_data(const ASN1_STRING *x); + unsigned char *ASN1_STRING_data(ASN1_STRING *x); - ASN1_STRING * ASN1_STRING_dup(const ASN1_STRING *a); + ASN1_STRING *ASN1_STRING_dup(const ASN1_STRING *a); int ASN1_STRING_cmp(ASN1_STRING *a, ASN1_STRING *b); diff --git a/doc/man3/ASN1_STRING_new.pod b/doc/man3/ASN1_STRING_new.pod index 581d3f6e36..83f6aaa6f8 100644 --- a/doc/man3/ASN1_STRING_new.pod +++ b/doc/man3/ASN1_STRING_new.pod @@ -9,8 +9,8 @@ ASN1_STRING allocation functions #include - ASN1_STRING * ASN1_STRING_new(void); - ASN1_STRING * ASN1_STRING_type_new(int type); + ASN1_STRING *ASN1_STRING_new(void); + ASN1_STRING *ASN1_STRING_type_new(int type); void ASN1_STRING_free(ASN1_STRING *a); =head1 DESCRIPTION diff --git a/doc/man3/ISSUER_SIGN_TOOL_new.pod b/doc/man3/ISSUER_SIGN_TOOL_new.pod deleted file mode 100644 index 4fb1f70f25..0000000000 --- a/doc/man3/ISSUER_SIGN_TOOL_new.pod +++ /dev/null @@ -1,51 +0,0 @@ -=pod - -=head1 NAME - -ISSUER_SIGN_TOOL_new, ISSUER_SIGN_TOOL_free,ISSUER_SIGN_TOOL_it, -d2i_ISSUER_SIGN_TOOL, i2d_ISSUER_SIGN_TOOL - -=head1 SYNOPSIS - -=for openssl generic - - #include - - extern const ISSUER_SIGN_TOOL_it; - - ISSUER_SIGN_TOOL *ISSUER_SIGN_TOOL_new(void); - void ISSUER_SIGN_TOOL_free(ISSUER_SIGN_TOOL *v); - - ISSUER_SIGN_TOOL *d2i_ISSUER_SIGN_TOOL(ISSUER_SIGN_TOOL **a, const unsigned char **pp, long length); - int i2d_ISSUER_SIGN_TOOL(const ISSUER_SIGN_TOOL *a, unsigned char **pp); - -=head1 DESCRIPTION - -The ISSUER_SIGN_TOOL_new() function returns a new ISSUER_SIGN_TOOL. - -ISSUER_SIGN_TOOL_free() frees up a single ISSUER_SIGN_TOOL object. - -=head1 RETURN VALUES - -ISSUER_SIGN_TOOL_new() returns a newly created ISSUER_SIGN_TOOL or NULL if the call fails. - -ISSUER_SIGN_TOOL_free() does not return values. - -d2i_ISSUER_SIGN_TOOL() and i2d_ISSUER_SIGN_TOOL() decode and encode an B -structure. They otherwise follow the conventions of other ASN.1 functions such as d2i_X509(). - -=head1 HISTORY - -The ISSUER_SIGN_TOOL_up_ref(), ISSUER_SIGN_TOOL_lock() and ISSUER_SIGN_TOOL_unlock() -functions were added in OpenSSL 3.0. - -=head1 COPYRIGHT - -Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. - -Licensed under the Apache License 2.0 (the "License"). You may not use -this file except in compliance with the License. You can obtain a copy -in the file LICENSE in the source distribution or at -L. - -=cut diff --git a/doc/man3/X509_dup.pod b/doc/man3/X509_dup.pod index 16c9935741..a92d82098d 100644 --- a/doc/man3/X509_dup.pod +++ b/doc/man3/X509_dup.pod @@ -81,7 +81,11 @@ IPAddressOrRange_free, IPAddressOrRange_new, IPAddressRange_free, IPAddressRange_new, +ISSUER_SIGN_TOOL_free, +ISSUER_SIGN_TOOL_it, +ISSUER_SIGN_TOOL_new, ISSUING_DIST_POINT_free, +ISSUING_DIST_POINT_it, ISSUING_DIST_POINT_new, NAME_CONSTRAINTS_free, NAME_CONSTRAINTS_new, @@ -252,6 +256,7 @@ TS_TST_INFO_new, USERNOTICE_free, USERNOTICE_new, X509_ALGOR_free, +X509_ALGOR_it, X509_ALGOR_new, X509_ATTRIBUTE_dup, X509_ATTRIBUTE_free, diff --git a/doc/man3/d2i_X509.pod b/doc/man3/d2i_X509.pod index 03548b233c..4dea774fb6 100644 --- a/doc/man3/d2i_X509.pod +++ b/doc/man3/d2i_X509.pod @@ -75,6 +75,7 @@ d2i_IPAddressChoice, d2i_IPAddressFamily, d2i_IPAddressOrRange, d2i_IPAddressRange, +d2i_ISSUER_SIGN_TOOL, d2i_ISSUING_DIST_POINT, d2i_NAMING_AUTHORITY, d2i_NETSCAPE_CERT_SEQUENCE, @@ -267,6 +268,7 @@ i2d_IPAddressChoice, i2d_IPAddressFamily, i2d_IPAddressOrRange, i2d_IPAddressRange, +i2d_ISSUER_SIGN_TOOL, i2d_ISSUING_DIST_POINT, i2d_NAMING_AUTHORITY, i2d_NETSCAPE_CERT_SEQUENCE, diff --git a/util/missingcrypto.txt b/util/missingcrypto.txt index 3473a8694c..6fba94701a 100644 --- a/util/missingcrypto.txt +++ b/util/missingcrypto.txt @@ -738,7 +738,6 @@ IPAddressChoice_it(3) IPAddressFamily_it(3) IPAddressOrRange_it(3) IPAddressRange_it(3) -ISSUING_DIST_POINT_it(3) LONG_it(3) MD2_options(3) MD4_Transform(3) @@ -1315,7 +1314,6 @@ X509V3_set_ctx(3) X509V3_set_nconf(3) X509V3_string_free(3) X509_ALGORS_it(3) -X509_ALGOR_it(3) X509_ATTRIBUTE_count(3) X509_ATTRIBUTE_create(3) X509_ATTRIBUTE_create_by_NID(3) -- 2.34.1