From 1dc1ea182be183d8a393fdce4494360aee059cd2 Mon Sep 17 00:00:00 2001 From: "Dr. David von Oheimb" Date: Wed, 10 Jun 2020 17:49:25 +0200 Subject: Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files Reviewed-by: Tim Hudson (Merged from https://github.com/openssl/openssl/pull/12109) --- HACKING.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) (limited to 'HACKING.md') diff --git a/HACKING.md b/HACKING.md index abf199f541..6375450c24 100644 --- a/HACKING.md +++ b/HACKING.md @@ -1,10 +1,13 @@ - MODIFYING OPENSSL SOURCE - ------------------------ - This document describes the way to add custom modifications to OpenSSL sources. +MODIFYING OPENSSL SOURCE +======================== + +This document describes the way to add custom modifications to OpenSSL sources. If you are adding new public functions to the custom library build, you need to either add a prototype in one of the existing OpenSSL header files; - or provide a new header file and edit Configurations/unix-Makefile.tmpl to pick up that file. + or provide a new header file and edit + [Configurations/unix-Makefile.tmpl](Configurations/unix-Makefile.tmpl) + to pick up that file. After that perform the following steps: @@ -13,14 +16,18 @@ make make test - "make update" ensures that your functions declarations are added to util/libcrypto.num or util/libssl.num - If you plan to submit the changes you made to OpenSSL (see CONTRIBUTING), it's worth running: + `make update` ensures that your functions declarations are added to + `util/libcrypto.num` or `util/libssl.num`. + If you plan to submit the changes you made to OpenSSL + (see [CONTRIBUTING.md](CONTRIBUTING.md)), it's worth running: make doc-nits - after running "make update" to ensure that documentation has correct format. + after running `make update` to ensure that documentation has correct format. - "make update" also generates files related to OIDs (in the crypto/objects/ folder) and errors. - If a 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 so they can be removed easily. + `make update` also generates files related to OIDs (in the `crypto/objects/` + folder) and errors. + If a 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 + so they can be removed easily. -- cgit v1.2.3