[doc/man3] finish EC_GROUP_get_field_type documentation
authorBilly Brumley <bbrumley@gmail.com>
Sat, 20 Jun 2020 07:11:11 +0000 (10:11 +0300)
committerNicola Tuveri <nic.tuv@gmail.com>
Sun, 21 Jun 2020 12:35:54 +0000 (15:35 +0300)
https://github.com/openssl/openssl/pull/11928 documented
`EC_GROUP_get_field_type` behavior in the `man` page but did not add the
name to the function list.

Fixes #12189.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Nicola Tuveri <nic.tuv@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/12214)

doc/man3/EC_GROUP_copy.pod

index ee3ce27..1dd0364 100644 (file)
@@ -12,7 +12,8 @@ EC_GROUP_get_seed_len, EC_GROUP_set_seed, EC_GROUP_get_degree,
 EC_GROUP_check, EC_GROUP_check_named_curve,
 EC_GROUP_check_discriminant, EC_GROUP_cmp,
 EC_GROUP_get_basis_type, EC_GROUP_get_trinomial_basis,
-EC_GROUP_get_pentanomial_basis, EC_GROUP_get0_field
+EC_GROUP_get_pentanomial_basis, EC_GROUP_get0_field,
+EC_GROUP_get_field_type
 - Functions for manipulating EC_GROUP objects
 
 =head1 SYNOPSIS
@@ -42,9 +43,9 @@ EC_GROUP_get_pentanomial_basis, EC_GROUP_get0_field
  void EC_GROUP_set_point_conversion_form(EC_GROUP *group, point_conversion_form_t form);
  point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *group);
 
- unsigned char *EC_GROUP_get0_seed(const EC_GROUP *x);
- size_t EC_GROUP_get_seed_len(const EC_GROUP *);
- size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len);
+ unsigned char *EC_GROUP_get0_seed(const EC_GROUP *group);
+ size_t EC_GROUP_get_seed_len(const EC_GROUP *group);
+ size_t EC_GROUP_set_seed(EC_GROUP *group, const unsigned char *, size_t len);
 
  int EC_GROUP_get_degree(const EC_GROUP *group);
 
@@ -56,11 +57,13 @@ EC_GROUP_get_pentanomial_basis, EC_GROUP_get0_field
 
  int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
 
- int EC_GROUP_get_basis_type(const EC_GROUP *);
- int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k);
- int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1,
+ int EC_GROUP_get_basis_type(const EC_GROUP *group);
+ int EC_GROUP_get_trinomial_basis(const EC_GROUP *group, unsigned int *k);
+ int EC_GROUP_get_pentanomial_basis(const EC_GROUP *group, unsigned int *k1,
                                     unsigned int *k2, unsigned int *k3);
 
+ int EC_GROUP_get_field_type(const EC_GROUP *group);
+
 Deprecated since OpenSSL 3.0:
 
  const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group);