Start writing a how to review doc

diff --git a/doc/HACKING/CodingStandards.txt b/doc/HACKING/CodingStandards.txt
index 2d03b8e3b23a84a4b69eac488b31f1c83521d2a0..f135fd166df12e4a83177adc04046995e7c16ae7 100644 (file)
--- a/doc/HACKING/CodingStandards.txt
+++ b/doc/HACKING/CodingStandards.txt
@@ -141,6 +141,9 @@ sure that we worked on MSVC6.
 We don't use strcat or strcpy or sprintf of any of those notoriously broken
 old C functions.  Use strlcat, strlcpy, or tor_snprintf/tor_asprintf instead.
 
+We don't call memcmp() directly.  Use fast_memeq(), fast_memneq(),
+tor_memeq(), or tor_memneq() for most purposes.
+
 Functions not to write
 ~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/doc/include.am b/doc/include.am
index 9b9e20bd882d0748089ab358cd1d025bc92e7f99..b2352115662eab61c2dfa2bce325fa60e9efa66f 100644 (file)
--- a/doc/include.am
+++ b/doc/include.am
@@ -43,6 +43,7 @@ EXTRA_DIST+= doc/asciidoc-helper.sh                   \
             doc/HACKING/CodingStandards.txt                    \
             doc/HACKING/GettingStarted.txt                     \
             doc/HACKING/HelpfulTools.txt                       \
+            doc/HACKING/HowToReview.txt                        \
             doc/HACKING/ReleasingTor.txt                       \
             doc/HACKING/WritingTests.txt