From 72138e7dd9423eb110e858e00b54b32be6b5aa87 Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Sun, 24 May 2015 15:44:52 +0000 Subject: Maximilian dot Fillinger at uni-duesseldorf dot de starts helping with the pod2mdoc(1)-based conversion of LibreSSL crypto manuals from perlpod(1) to mdoc(7). Here comes the first file, slightly tweaked by me. --- src/lib/libssl/src/doc/crypto/BUF_MEM_new.pod | 72 --------------------------- 1 file changed, 72 deletions(-) delete mode 100644 src/lib/libssl/src/doc/crypto/BUF_MEM_new.pod (limited to 'src/lib/libssl') diff --git a/src/lib/libssl/src/doc/crypto/BUF_MEM_new.pod b/src/lib/libssl/src/doc/crypto/BUF_MEM_new.pod deleted file mode 100644 index 2805755869..0000000000 --- a/src/lib/libssl/src/doc/crypto/BUF_MEM_new.pod +++ /dev/null @@ -1,72 +0,0 @@ -=pod - -=head1 NAME - -BUF_MEM_new, BUF_MEM_free, BUF_MEM_grow, BUF_strdup - simple -character arrays structure - -=head1 SYNOPSIS - - #include - - BUF_MEM *BUF_MEM_new(void); - - void BUF_MEM_free(BUF_MEM *a); - - int BUF_MEM_grow(BUF_MEM *str, size_t len); - - char * BUF_strdup(const char *str); - -=head1 DESCRIPTION - -The buffer library handles simple character arrays. Buffers are used for -various purposes in the library, most notably memory BIOs. - -The library uses the BUF_MEM structure defined in buffer.h: - - typedef struct buf_mem_st - { - size_t length; /* current number of bytes */ - char *data; - size_t max; /* size of buffer */ - } BUF_MEM; - -B is the current size of the buffer in bytes, B is the amount of -memory allocated to the buffer. There are three functions which handle these -and one "miscellaneous" function. - -BUF_MEM_new() allocates a new buffer of zero size. - -BUF_MEM_free() frees up an already existing buffer. The data is zeroed -before freeing up in case the buffer contains sensitive data. - -BUF_MEM_grow() changes the size of an already existing buffer to -B. Any data already in the buffer is preserved if it increases in -size. - -BUF_strdup() copies a null terminated string into a block of allocated memory -and returns a pointer to the allocated block. Unlike the system strdup() -function, BUF_strdup() will accept a NULL argument and will return NULL in -that case. Its use in new programes is discouraged. - -The memory allocated from BUF_strdup() should be freed up using the -free() function. - -=head1 RETURN VALUES - -BUF_MEM_new() returns the buffer or NULL on error. - -BUF_MEM_free() has no return value. - -BUF_MEM_grow() returns zero on error or the new size (i.e. B). - -=head1 SEE ALSO - -L - -=head1 HISTORY - -BUF_MEM_new(), BUF_MEM_free() and BUF_MEM_grow() are available in all -versions of SSLeay and OpenSSL. BUF_strdup() was added in SSLeay 0.8. - -=cut -- cgit v1.2.3-55-g6feb