diff mbox series

[v2] docs/fuzz: fix outdated mention to enable-sanitizers

Message ID 0ecf4e1ab26771009d74a2ce61e7c17ddc586ef7.1726226316.git.quic_mathbern@quicinc.com
State New
Headers show
Series [v2] docs/fuzz: fix outdated mention to enable-sanitizers | expand

Commit Message

Matheus Tavares Bernardino Sept. 13, 2024, 11:19 a.m. UTC
This options has been removed at cb771ac1f5 (meson: Split
--enable-sanitizers to --enable-{asan, ubsan}, 2024-08-13), so let's
update its last standing mention in the docs.

Signed-off-by: Matheus Tavares Bernardino <quic_mathbern@quicinc.com>
---
In v2: fixed grammar typo and s/use-after-frees/uses-after-free/
v1: https://lore.kernel.org/qemu-devel/a788215960b94d863baeffb736f06e3fb94275e7.1726145226.git.quic_mathbern@quicinc.com/

 docs/devel/testing/fuzzing.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Brian Cain Sept. 13, 2024, 3:28 p.m. UTC | #1
On 9/13/2024 6:19 AM, Matheus Tavares Bernardino wrote:
> This options has been removed at cb771ac1f5 (meson: Split
> --enable-sanitizers to --enable-{asan, ubsan}, 2024-08-13), so let's
> update its last standing mention in the docs.
>
> Signed-off-by: Matheus Tavares Bernardino <quic_mathbern@quicinc.com>
> ---
> In v2: fixed grammar typo and s/use-after-frees/uses-after-free/
> v1: https://lore.kernel.org/qemu-devel/a788215960b94d863baeffb736f06e3fb94275e7.1726145226.git.quic_mathbern@quicinc.com/


Reviewed-by: Brian Cain <bcain@quicinc.com>


>   docs/devel/testing/fuzzing.rst | 5 +++--
>   1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/docs/devel/testing/fuzzing.rst b/docs/devel/testing/fuzzing.rst
> index dfe1973cf8..c3ac084311 100644
> --- a/docs/devel/testing/fuzzing.rst
> +++ b/docs/devel/testing/fuzzing.rst
> @@ -21,8 +21,9 @@ Building the fuzzers
>   
>   To build the fuzzers, install a recent version of clang:
>   Configure with (substitute the clang binaries with the version you installed).
> -Here, enable-sanitizers, is optional but it allows us to reliably detect bugs
> -such as out-of-bounds accesses, use-after-frees, double-frees etc.::
> +Here, enable-asan and enable-ubsan are optional but they allow us to reliably
> +detect bugs such as out-of-bounds accesses, uses-after-free, double-frees
> +etc.::
>   
>       CC=clang-8 CXX=clang++-8 /path/to/configure \
>           --enable-fuzzing --enable-asan --enable-ubsan
diff mbox series

Patch

diff --git a/docs/devel/testing/fuzzing.rst b/docs/devel/testing/fuzzing.rst
index dfe1973cf8..c3ac084311 100644
--- a/docs/devel/testing/fuzzing.rst
+++ b/docs/devel/testing/fuzzing.rst
@@ -21,8 +21,9 @@  Building the fuzzers
 
 To build the fuzzers, install a recent version of clang:
 Configure with (substitute the clang binaries with the version you installed).
-Here, enable-sanitizers, is optional but it allows us to reliably detect bugs
-such as out-of-bounds accesses, use-after-frees, double-frees etc.::
+Here, enable-asan and enable-ubsan are optional but they allow us to reliably
+detect bugs such as out-of-bounds accesses, uses-after-free, double-frees
+etc.::
 
     CC=clang-8 CXX=clang++-8 /path/to/configure \
         --enable-fuzzing --enable-asan --enable-ubsan