summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorBen Pfaff <blp@ovn.org>2018-01-11 15:49:24 -0800
committerBen Pfaff <blp@ovn.org>2018-01-12 10:46:50 -0800
commitd4042a708f08a79bb1f7501dec16607a6f602490 (patch)
tree34635219a99a6467cc338f30c68f7ffafb32792c /Documentation
parent2daae85a06d5e0038b94f9a6403bdbf2845ee7b6 (diff)
downloadopenvswitch-d4042a708f08a79bb1f7501dec16607a6f602490.tar.gz
configure: New --enable-sparse option to enable sparse checking by default.
Until now, "make" called sparse to do checking only if C=1 was passed on the command line. It was easy for developers to forget to specify that. This commit adds another option: specifying --enable-sparse on the configure command line enables sparse checking by default. (It can still be disabled with C=0.) Requested-by: Justin Pettit <jpettit@ovn.org> Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Justin Pettit <jpettit@ovn.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/intro/install/general.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst
index 718e5c2f7..b163564d7 100644
--- a/Documentation/intro/install/general.rst
+++ b/Documentation/intro/install/general.rst
@@ -312,6 +312,13 @@ generated by the build. For example::
$ ./configure --enable-Werror
+If you're building with GCC, then, for improved warnings, install ``sparse``
+(see "Prerequisites") and enable it for the build by adding
+``--enable-sparse``. Use this with ``--enable-Werror`` to avoid missing both
+compiler and ``sparse`` warnings, e.g.::
+
+ $ ./configure --enable-Werror --enable-sparse
+
To build with gcov code coverage support, add ``--enable-coverage``::
$ ./configure --enable-coverage
@@ -355,9 +362,6 @@ Building
$ make -C _gcc
$ make -C _clang
- For improved warnings if you installed ``sparse`` (see "Prerequisites"), add
- ``C=1`` to the command line.
-
.. note::
Some versions of Clang and ccache are not completely compatible. If you
see unusual warnings when you use both together, consider disabling