GitHub/openssl
1
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2026-05-07 20:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

move contents of HACKING.md to a doc/HOWTO

Browse Source 
reference list of files and removed -Werror from instructions on adding
functions rename HACKING.md to HOWTO.md.

Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Frederik Wedel-Heinen <fwh.openssl@gmail.com>
MergeDate: Mon Apr 27 06:14:57 2026
(Merged from https://github.com/openssl/openssl/pull/18003)
This commit is contained in:
Michael Richardson
2026-03-18 22:56:02 -04:00
committed by Nikola Pajkovsky
parent 9d9943f031
commit 40577e1355
2 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
HOWTO.md
+8
View File
@@ -0,0 +1,8 @@
MODIFYING OPENSSL SOURCE
========================
This is a collection of pointers to parts of the documentation that will help
people doing modifications.
* [doc/HOWTO/adding-functions.md](Adding new Functions)
* [doc/HOWTO/documenting-functions-macros.md](Documenting Functions and Macros)
HACKING.md → doc/HOWTO/adding-functions.md
+14 -9
View File
@@ -1,5 +1,5 @@
MODIFYING OPENSSL SOURCE
========================
ADDING FUNCTIONS to OPENSSL
===========================
This document describes the way to add custom modifications to OpenSSL
sources.
@@ -58,7 +58,7 @@ public function - as defined above - is added, these files must be updated.
To make such an update, please do the following:
./Configure -Werror --strict-warnings [your-options]
./Configure --strict-warnings [your-options]
make update
If you plan to submit the changes you made to OpenSSL (see
@@ -67,14 +67,19 @@ If you plan to submit the changes you made to OpenSSL (see
make doc-nits
Do note that `make update` also generates files related to OIDs (in the
`crypto/objects/` folder) and errors messages.
`make update` ensures that your functions declarations are added to
`util/libcrypto.num` or `util/libssl.num`.
It also generates files related to OIDs (in the `crypto/objects/` folder)
and error messages.
More details are at
[doc/HOWTO/documenting-functions-macros.md](Documenting Functions and Macros)
If a git merge error occurs in one of these generated files, then the
generated files need to be removed and regenerated using `make update`.
To aid in this process, the generated files can be committed separately
To aid in this process, the generated files should be committed separately
so they can be removed easily by reverting that commit.
[doc/internal/man7/build.info.pod]: ./doc/internal/man7/build.info.pod
[Configurations/unix-Makefile.tmpl]: ./Configurations/unix-Makefile.tmpl
[CONTRIBUTING.md]: ./CONTRIBUTING.md
[doc/internal/man7/build.info.pod]: ../doc/internal/man7/build.info.pod
[Configurations/unix-Makefile.tmpl]: ../../Configurations/unix-Makefile.tmpl
[CONTRIBUTING.md]: ../../CONTRIBUTING.md