Просмотр исходного кода

Start writing a how to review doc

Nick Mathewson 10 лет назад
Родитель
Сommit
609c1e8870
2 измененных файлов с 4 добавлено и 0 удалено
  1. 3 0
      doc/HACKING/CodingStandards.txt
  2. 1 0
      doc/include.am

+ 3 - 0
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
 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.
 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
 Functions not to write
 ~~~~~~~~~~~~~~~~~~~~~~
 ~~~~~~~~~~~~~~~~~~~~~~
 
 

+ 1 - 0
doc/include.am

@@ -43,6 +43,7 @@ EXTRA_DIST+= doc/asciidoc-helper.sh			\
 	     doc/HACKING/CodingStandards.txt			\
 	     doc/HACKING/CodingStandards.txt			\
 	     doc/HACKING/GettingStarted.txt			\
 	     doc/HACKING/GettingStarted.txt			\
 	     doc/HACKING/HelpfulTools.txt			\
 	     doc/HACKING/HelpfulTools.txt			\
+	     doc/HACKING/HowToReview.txt 			\
 	     doc/HACKING/ReleasingTor.txt                       \
 	     doc/HACKING/ReleasingTor.txt                       \
 	     doc/HACKING/WritingTests.txt
 	     doc/HACKING/WritingTests.txt