Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files

[openssl.git] / HACKING.md

diff --git a/HACKING.md b/HACKING.md
index abf199f5418a18e7bb4cb76980e6510f9faf37ef..6375450c24134da541f83dbc45e2bd50f04a5439 100644 (file)
--- 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.