diff options
Diffstat (limited to 'doc/HACKING/HowToReview.md')
| -rw-r--r-- | doc/HACKING/HowToReview.md | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/doc/HACKING/HowToReview.md b/doc/HACKING/HowToReview.md index d6b40db937..de7891c923 100644 --- a/doc/HACKING/HowToReview.md +++ b/doc/HACKING/HowToReview.md @@ -15,71 +15,71 @@ Top-level smell-checks (Difficulty: easy) -Does it compile with --enable-gcc-warnings? +- Does it compile with `--enable-gcc-warnings`? -Does 'make check-spaces' pass? +- Does `make check-spaces` pass? -Does it have a reasonable amount of tests? Do they pass? Do they leak -memory? +- Does it have a reasonable amount of tests? Do they pass? Do they leak + memory? -Do all the new functions, global variables, types, and structure members have -documentation? +- Do all the new functions, global variables, types, and structure members have + documentation? -Do all the functions, global variables, types, and structure members with -modified behavior have modified documentation? +- Do all the functions, global variables, types, and structure members with + modified behavior have modified documentation? -Do all the new torrc options have documentation? +- Do all the new torrc options have documentation? -If this changes Tor's behavior on the wire, is there a design proposal? +- If this changes Tor's behavior on the wire, is there a design proposal? Let's look at the code! ----------------------- -Does the code conform to CodingStandards.txt? +- Does the code conform to CodingStandards.txt? -Does the code leak memory? +- Does the code leak memory? -If two or more pointers ever point to the same object, is it clear which -pointer "owns" the object? +- If two or more pointers ever point to the same object, is it clear which + pointer "owns" the object? -Are all allocated resources freed? +- Are all allocated resources freed? -Are all pointers that should be const, const? +- Are all pointers that should be const, const? -Are #defines used for 'magic' numbers? +- Are `#defines` used for 'magic' numbers? -Can you understand what the code is trying to do? +- Can you understand what the code is trying to do? -Can you convince yourself that the code really does that? +- Can you convince yourself that the code really does that? -Is there duplicated code that could be turned into a function? +- Is there duplicated code that could be turned into a function? Let's look at the documentation! -------------------------------- -Does the documentation confirm to CodingStandards.txt? +- Does the documentation confirm to CodingStandards.txt? -Does it make sense? +- Does it make sense? -Can you predict what the function will do from its documentation? +- Can you predict what the function will do from its documentation? Let's think about security! --------------------------- -If there are any arrays, buffers, are you 100% sure that they cannot -overflow? +- If there are any arrays, buffers, are you 100% sure that they cannot + overflow? -If there is any integer math, can it overflow or underflow? +- If there is any integer math, can it overflow or underflow? -If there are any allocations, are you sure there are corresponding -deallocations? +- If there are any allocations, are you sure there are corresponding + deallocations? -Is there a safer pattern that could be used in any case? +- Is there a safer pattern that could be used in any case? -Have they used one of the Forbidden Functions? +- Have they used one of the Forbidden Functions? (Also see your favorite secure C programming guides.) |