Add documentation for the newly added RSA_PKCS1_WITH_TLS_PADDING
[openssl.git] / HACKING
1  MODIFYING OPENSSL SOURCE
2  ------------------------
3  This document describes the way to add custom modifications to OpenSSL sources.
4
5  If you are adding new public functions to the custom library build, you need to
6  either add a prototype in one of the existing OpenSSL header files;
7  or provide a new header file and edit Configurations/unix-Makefile.tmpl to pick up that file.
8
9  After that perform the following steps:
10
11     ./config -Werror --strict-warnings [your-options]
12     make update
13     make
14     make test
15
16  "make update" ensures that your functions declarations are added to util/libcrypto.num or util/libssl.num
17  If you plan to submit the changes you made to OpenSSL (see CONTRIBUTING), it's worth running:
18
19     make doc-nits
20
21  after running "make update" to ensure that documentation has correct format.
22
23  "make update" also generates files related to OIDs (in the crypto/objects/ folder) and errors.
24  If a merge error occurs in one of these generated files then the generated files need to be removed
25  and regenerated using "make update".
26  To aid in this process the generated files can be committed separately so they can be removed easily.