]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: hacking: remove notes about -Werror
authorJán Tomko <jtomko@redhat.com>
Fri, 18 Oct 2019 20:59:49 +0000 (22:59 +0200)
committerJán Tomko <jtomko@redhat.com>
Tue, 22 Oct 2019 20:09:13 +0000 (22:09 +0200)
Our HACKING file is clear about requiring submission from a git
checkout, which automatically enables -Werror.

Remove the mentions of explicitly enabling it to alleviate
the collective cognitive encumbrance.

Signed-off-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
docs/hacking.html.in

index c6ab15206abbaaeb2efbf66005d79b186d7e72a6..cad0f1e8c1b61caa99cdb89b8a389c9e8991aa67 100644 (file)
       </li>
 
       <li><p>Run the automated tests on your code before submitting any changes.
-          In particular, configure with compile warnings set to
-          -Werror.  This is done automatically for a git checkout; from a
-          tarball, use:</p>
-<pre>
-  ./configure --enable-werror
-</pre>
-        <p>
-          and run the tests:
+          That is:
         </p>
 <pre>
   make check
@@ -1474,14 +1467,7 @@ int foo()
       how things work, it's better
       to wait for a more authoritative feedback though. Before committing, please
       also rebuild locally, run 'make check syntax-check', and make sure you
-      don't raise errors. Try to look for warnings too; for example,
-      configure with
-    </p>
-<pre>
-  --enable-compile-warnings=error
-</pre>
-    <p>
-      which adds -Werror to compile flags, so no warnings get missed
+      don't raise errors.
     </p>
 
     <p>