DOCS: Move the description of EVP_PKEY_get0_description()

[openssl.git] / doc / man3 / EVP_PKEY_is_a.pod

diff --git a/doc/man3/EVP_PKEY_is_a.pod b/doc/man3/EVP_PKEY_is_a.pod
index 5a012f780486feddf730ac7b44f7c40eb859e04c..8bada052fa6ecb22d7e9742e6dd83410acd082c1 100644 (file)
--- a/doc/man3/EVP_PKEY_is_a.pod
+++ b/doc/man3/EVP_PKEY_is_a.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 EVP_PKEY_is_a, EVP_PKEY_can_sign, EVP_PKEY_type_names_do_all,
 =head1 NAME
 
 EVP_PKEY_is_a, EVP_PKEY_can_sign, EVP_PKEY_type_names_do_all,

-EVP_PKEY_get0_type_name, EVP_PKEY_get0_provider
+EVP_PKEY_get0_type_name, EVP_PKEY_get0_description, EVP_PKEY_get0_provider

 - key type and capabilities functions
 
 =head1 SYNOPSIS
 - key type and capabilities functions
 
 =head1 SYNOPSIS


@@ -16,6 +16,7 @@ EVP_PKEY_get0_type_name, EVP_PKEY_get0_provider
                                 void (*fn)(const char *name, void *data),
                                 void *data);
  const char *EVP_PKEY_get0_type_name(const EVP_PKEY *key);
                                 void (*fn)(const char *name, void *data),
                                 void *data);
  const char *EVP_PKEY_get0_type_name(const EVP_PKEY *key);

+ const char *EVP_PKEY_get0_description(const EVP_PKEY *key);

  const OSSL_PROVIDER *EVP_PKEY_get0_provider(const EVP_PKEY *key);
 
 =head1 DESCRIPTION
  const OSSL_PROVIDER *EVP_PKEY_get0_provider(const EVP_PKEY *key);
 
 =head1 DESCRIPTION


@@ -39,6 +40,10 @@ that holds the key which one will be returned.
 Ownership of the returned string is retained by the I<pkey> object and should
 not be freed by the caller.
 
 Ownership of the returned string is retained by the I<pkey> object and should
 not be freed by the caller.
 

+EVP_PKEY_get0_description() returns a description of the type of B<EVP_PKEY>,
+meant for display and human consumption.  The description is at the
+discretion of the key type implementation.
+

 EVP_PKEY_get0_provider() returns the provider of the B<EVP_PKEY>'s
 L<EVP_KEYMGMT(3)>.
 
 EVP_PKEY_get0_provider() returns the provider of the B<EVP_PKEY>'s
 L<EVP_KEYMGMT(3)>.
 


@@ -52,6 +57,8 @@ supports signing, otherwise 0.
 
 EVP_PKEY_get0_type_name() returns the name that is found or NULL on error.
 
 
 EVP_PKEY_get0_type_name() returns the name that is found or NULL on error.
 

+EVP_PKEY_get0_description() returns the description if found or NULL if not.
+

 EVP_PKEY_get0_provider() returns the provider if found or NULL if not.
 
 EVP_PKEY_type_names_do_all() returns 1 if the callback was called for all
 EVP_PKEY_get0_provider() returns the provider if found or NULL if not.
 
 EVP_PKEY_type_names_do_all() returns 1 if the callback was called for all