Clean up "generic" intro pod files. (53934822) · Commits · CYBER - Cyber Security / TS 103 523 MSP / ETS / ETS OpenSSL

doc/crypto/bn_internal.pod→crypto/bn/README.pod

+0 −0

File moved.

0 → 100644

+44 −0

Original line number	Original line	Diff line number	Diff line
			Adding new libraries
			--------------------

			When adding a new sub-library to OpenSSL, assign it a library number
			ERR_LIB_XXX, define a macro XXXerr() (both in err.h), add its
			name to ERR_str_libraries[] (in crypto/err/err.c), and add
			ERR_load_XXX_strings() to the ERR_load_crypto_strings() function
			(in crypto/err/err_all.c). Finally, add an entry:

			L XXX xxx.h xxx_err.c

			to crypto/err/openssl.ec, and add xxx_err.c to the Makefile.
			Running make errors will then generate a file xxx_err.c, and
			add all error codes used in the library to xxx.h.

			Additionally the library include file must have a certain form.
			Typically it will initially look like this:

			#ifndef HEADER_XXX_H
			#define HEADER_XXX_H

			#ifdef __cplusplus
			extern "C" {
			#endif

			/* Include files */

			#include <openssl/bio.h>
			#include <openssl/x509.h>

			/* Macros, structures and function prototypes */


			/* BEGIN ERROR CODES */

			The BEGIN ERROR CODES sequence is used by the error code
			generation script as the point to place new error codes, any text
			after this point will be overwritten when make errors is run.
			The closing #endif etc will be automatically added by the script.

			The generated C error code file xxx_err.c will load the header
			files stdio.h, openssl/err.h and openssl/xxx.h so the
			header file must load any additional header files containing any
			definitions it uses.

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -2,7 +2,7 @@

	=head1 NAME		=head1 NAME

	blowfish, BF_set_key, BF_encrypt, BF_decrypt, BF_ecb_encrypt, BF_cbc_encrypt,		BF_set_key, BF_encrypt, BF_decrypt, BF_ecb_encrypt, BF_cbc_encrypt,
	BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options - Blowfish encryption		BF_cfb64_encrypt, BF_ofb64_encrypt, BF_options - Blowfish encryption

	=head1 SYNOPSIS		=head1 SYNOPSIS

+1 −10

Original line number	Original line	Diff line number	Diff line
	@@ -45,21 +45,12 @@ BIO_free_all() and BIO_vfree() do not return values.

	=head1 NOTES		=head1 NOTES

	Some BIOs (such as memory BIOs) can be used immediately after calling
	BIO_new(). Others (such as file BIOs) need some additional initialization,
	and frequently a utility function exists to create and initialize such BIOs.

	If BIO_free() is called on a BIO chain it will only free one BIO resulting		If BIO_free() is called on a BIO chain it will only free one BIO resulting
	in a memory leak.		in a memory leak.

	Calling BIO_free_all() a single BIO has the same effect as calling BIO_free()		Calling BIO_free_all() on a single BIO has the same effect as calling BIO_free()
	on it other than the discarded return value.		on it other than the discarded return value.

	Normally the B<type> argument is supplied by a function which returns a
	pointer to a BIO_METHOD. There is a naming convention for such functions:
	a source/sink BIO is normally called BIO_s_*() and a filter BIO
	BIO_f_*();

	=head1 EXAMPLE		=head1 EXAMPLE

	Create a memory BIO:		Create a memory BIO:

+0 −0

File moved.