From 609c1e88701dd483343af3e5a1276916ffcb68d3 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Thu, 22 Oct 2015 10:01:13 -0400 Subject: Start writing a how to review doc --- doc/HACKING/CodingStandards.txt | 3 +++ doc/include.am | 1 + 2 files changed, 4 insertions(+) diff --git a/doc/HACKING/CodingStandards.txt b/doc/HACKING/CodingStandards.txt index 2d03b8e3b2..f135fd166d 100644 --- 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 9b9e20bd88..b235211566 100644 --- 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 -- cgit v1.2.3-54-g00ecf