From e903aaf894d542c02dc9bfd5065f906dc720d841 Mon Sep 17 00:00:00 2001 From: Matt Caswell Date: Tue, 3 May 2016 12:45:45 +0100 Subject: [PATCH] Remove some documentation for functions not in 1.0.x A few functions in the recently added EVP_EncodeInit docs don't apply to the 1.0.x branches. Reviewed-by: Richard Levitte --- doc/crypto/EVP_EncodeInit.pod | 25 +++---------------------- 1 file changed, 3 insertions(+), 22 deletions(-) diff --git a/doc/crypto/EVP_EncodeInit.pod b/doc/crypto/EVP_EncodeInit.pod index bc35acfc42..c6f12674f6 100644 --- a/doc/crypto/EVP_EncodeInit.pod +++ b/doc/crypto/EVP_EncodeInit.pod @@ -2,18 +2,14 @@ =head1 NAME -EVP_ENCODE_CTX_new, EVP_ENCODE_CTX_free, EVP_ENCODE_CTX_num, EVP_EncodeInit, -EVP_EncodeUpdate, EVP_EncodeFinal, EVP_EncodeBlock, EVP_DecodeInit, -EVP_DecodeUpdate, EVP_DecodeFinal, EVP_DecodeBlock - EVP base 64 encode/decode -routines +EVP_EncodeInit, EVP_EncodeUpdate, EVP_EncodeFinal, EVP_EncodeBlock, +EVP_DecodeInit, EVP_DecodeUpdate, EVP_DecodeFinal, EVP_DecodeBlock - EVP base 64 +encode/decode routines =head1 SYNOPSIS #include - EVP_ENCODE_CTX *EVP_ENCODE_CTX_new(void); - void EVP_ENCODE_CTX_free(EVP_ENCODE_CTX *ctx); - int EVP_ENCODE_CTX_num(EVP_ENCODE_CTX *ctx); void EVP_EncodeInit(EVP_ENCODE_CTX *ctx); void EVP_EncodeUpdate(EVP_ENCODE_CTX *ctx, unsigned char *out, int *outl, const unsigned char *in, int inl); @@ -37,12 +33,6 @@ plus some occasional newlines (see below). If the input data length is not a multiple of 3 then the output data will be padded at the end using the "=" character. -EVP_ENCODE_CTX_new() allocates, initializes and returns a context to be used for -the encode/decode functions. - -EVP_ENCODE_CTX_free() cleans up an encode/decode context B and frees up the -space allocated to it. - Encoding of binary data is performed in blocks of 48 input bytes (or less for the final block). For each 48 byte input block encoded 64 bytes of base 64 data is output plus an additional newline character (i.e. 65 bytes in total). The @@ -75,9 +65,6 @@ in B<*outl>. It is the caller's responsibility to ensure that B is sufficiently large to accommodate the output data which will never be more than 65 bytes plus an additional NUL terminator (i.e. 66 bytes in total). -EVP_ENCODE_CTX_num() will return the number of as yet unprocessed bytes still to -be encoded or decoded that are pending in the B object. - EVP_EncodeBlock() encodes a full block of input data in B and of length B and stores it in B. For every 3 bytes of input provided 4 bytes of output data will be produced. If B is not divisible by 3 then the block is @@ -123,12 +110,6 @@ the data decoded or -1 on error. =head1 RETURN VALUES -EVP_ENCODE_CTX_new() returns a pointer to the newly allocated EVP_ENCODE_CTX -object or NULL on error. - -EVP_ENCODE_CTX_num() returns the number of bytes pending encoding or decoding in -B. - EVP_EncodeBlock() returns the number of bytes encoded excluding the NUL terminator. -- 2.25.1