]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Stop recommending --enable-gcc-warnings in doc/HACKING
authorNick Mathewson <nickm@torproject.org>
Mon, 23 May 2016 18:40:27 +0000 (14:40 -0400)
committerNick Mathewson <nickm@torproject.org>
Mon, 23 May 2016 18:40:27 +0000 (14:40 -0400)
doc/HACKING/CodingStandards.md
doc/HACKING/HowToReview.md

index 4aafa5ddd47504895f1ccf22ca7d3363a00d957e..f1c65850a49e8db70e78241e85924b185602c0d4 100644 (file)
@@ -3,7 +3,7 @@ Coding conventions for Tor
 
 tl;dr:
 
-   - Run configure with `--enable-gcc-warnings`
+   - Run configure with `--enable-fatal-warnings`
    - Run `make check-spaces` to catch whitespace errors
    - Document your functions
    - Write unit tests
@@ -21,7 +21,7 @@ preference)
 
 Did you remember...
 
-   - To build your code while configured with `--enable-gcc-warnings`?
+   - To build your code while configured with `--enable-fatal-warnings`?
    - To run `make check-spaces` on your code?
    - To run `make check-docs` to see whether all new options are on
      the manpage?
@@ -125,10 +125,10 @@ deviations from our C whitespace style.  Generally, we use:
      `puts (x)`.
    - Function declarations at the start of the line.
 
-We try hard to build without warnings everywhere.  In particular, if you're
-using gcc, you should invoke the configure script with the option
-`--enable-gcc-warnings`.  This will give a bunch of extra warning flags to
-the compiler, and help us find divergences from our preferred C style.
+We try hard to build without warnings everywhere.  In particular, if
+you're using gcc, you should invoke the configure script with the
+option `--enable-fatal-warnings`.  This will tell the compiler
+to make all warnings into errors.
 
 Functions to use; functions not to use
 --------------------------------------
index de7891c923cfe39edbe36889495e4f512d2336d4..d53318942f10c6c5a16f28a441d7f5c377d2f307 100644 (file)
@@ -15,7 +15,7 @@ Top-level smell-checks
 
 (Difficulty: easy)
 
-- Does it compile with `--enable-gcc-warnings`?
+- Does it compile with `--enable-fatal-warnings`?
 
 - Does `make check-spaces` pass?