Fix some errors in documentation
authorRichard Levitte <levitte@openssl.org>
Mon, 6 Apr 2020 12:00:55 +0000 (14:00 +0200)
committerRichard Levitte <levitte@openssl.org>
Sat, 11 Apr 2020 13:51:43 +0000 (15:51 +0200)
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/11476)

doc/internal/man3/OPENSSL_SA.pod [moved from doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod with 98% similarity]
doc/internal/man3/s2i_ASN1_UTF8STRING.pod

similarity index 98%
rename from doc/internal/man3/DEFINE_SPARSE_ARRAY_OF.pod
rename to doc/internal/man3/OPENSSL_SA.pod
index a78193c..77f1a7b 100644 (file)
@@ -2,15 +2,13 @@
 
 =head1 NAME
 
-DEFINE_SPARSE_ARRAY_OF, ossl_sa_TYPE_new, ossl_sa_TYPE_free,
+OPENSSL_SA, ossl_sa_TYPE_new, ossl_sa_TYPE_free,
 ossl_sa_TYPE_free_leaves, ossl_sa_TYPE_num, ossl_sa_TYPE_doall,
 ossl_sa_TYPE_doall_arg, ossl_sa_TYPE_get, ossl_sa_TYPE_set
 - sparse array container
 
 =head1 SYNOPSIS
 
-=for openssl generic
-
  #include "crypto/sparse_array.h"
 
  typedef struct sparse_array_st OPENSSL_SA;
index c5b434a..9b806eb 100644 (file)
@@ -3,12 +3,12 @@
 =head1 NAME
 
 i2s_ASN1_UTF8STRING,
-s2i_ASN1_UTF8STRING,
+s2i_ASN1_UTF8STRING
 - convert objects from/to ASN.1/string representation
 
 =head1 SYNOPSIS
 
-=for openssl generic
+ #include "crypto/x509v3.h"
 
  char *i2s_ASN1_UTF8STRING(X509V3_EXT_METHOD *method,
                            ASN1_UTF8STRING *utf8);
@@ -22,7 +22,7 @@ representation. This function is used for B<X509v3> extentions.
 
 =head1 NOTES
 
-The letters B<i> and B<s> in B<i2s_ASN1_UTF8STRING>() stand for
+The letters B<i> and B<s> in i2s_ASN1_UTF8STRING() stand for
 "internal" (that is, an internal C structure) and string respectively.
 So B<i2s_ASN1_UTF8STRING>() converts from internal to string.