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

Matheus Tavares Bernardino posted 1 patch 2 months, 1 week ago
There is a newer version of this series
docs/devel/testing/fuzzing.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
[PATCH] docs/fuzz: fix outdated mention to enable-sanitizers
Posted by Matheus Tavares Bernardino 2 months, 1 week ago
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>
---
 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..e42d64d6ec 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 allows us to reliably
+detect bugs such as out-of-bounds accesses, use-after-frees, double-frees
+etc.::
 
     CC=clang-8 CXX=clang++-8 /path/to/configure \
         --enable-fuzzing --enable-asan --enable-ubsan
-- 
2.37.2
Re: [PATCH] docs/fuzz: fix outdated mention to enable-sanitizers
Posted by Brian Cain 2 months, 1 week ago
On 9/12/2024 7:47 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>
> ---
>   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..e42d64d6ec 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 allows us to reliably

s/they allows/they allow/

> +detect bugs such as out-of-bounds accesses, use-after-frees, double-frees

IMO it should be "uses-after-free" but it's probably pretty subtle.  
This was the original text, so feel free to leave it as-is.

> +etc.::
>   
>       CC=clang-8 CXX=clang++-8 /path/to/configure \
>           --enable-fuzzing --enable-asan --enable-ubsan