Skip to content

Commit 5e56e96

Browse files
committed
Clarify documentation
- Fix typos in the documentation on dictionaries - Link to the fuzzing directory in the main README where it is referenced.
1 parent 576a858 commit 5e56e96

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Please have a look at the [contributions file][contributing].
241241
[3-Clause BSD License](https://opensource.org/license/bsd-3-clause/), also known as the New BSD License. See the [LICENSE file][license].
242242

243243
> [!NOTE]
244-
> There are two special case files located in the `fuzzzing/` directory that are licensed differently:
244+
> There are two special case files located in the [`fuzzzing/` directory](./fuzzing) that are licensed differently:
245245
>
246246
> `fuzz_config.py` and `fuzz_tree.py` were migrated here from the OSS-Fuzz project repository where they were initially
247247
> created and retain the original licence and copyright notice (Apache License, Version 2.0 and Copyright 2023 Google

fuzzing/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ Contains Python files for each fuzz test.
8080
### Dictionaries (`dictionaries/`)
8181

8282
Provides hints to the fuzzing engine about inputs that might trigger unique code paths. Each fuzz target may have a
83-
corresponding `.dict` file. For details on how these are used, refer
84-
to the [LibFuzzer documentation on the subject](https://llvm.org/docs/LibFuzzer.html#dictionaries).
83+
corresponding `.dict` file. For information about dictionary syntax, refer to
84+
the [LibFuzzer documentation on the subject](https://llvm.org/docs/LibFuzzer.html#dictionaries).
8585

8686
**Things to Know**:
8787

@@ -92,7 +92,7 @@ to the [LibFuzzer documentation on the subject](https://llvm.org/docs/LibFuzzer.
9292
existing file here.
9393
- Development or updates to dictionaries should reflect the varied formats and edge cases relevant to the
9494
functionalities under test.
95-
- Example dictionaries (some of which are used to build the default dictionaries mentioned above) are can be found here:
95+
- Example dictionaries (some of which are used to build the default dictionaries mentioned above) can be found here:
9696
- [AFL++ dictionary repository](https://github.com/AFLplusplus/AFLplusplus/tree/stable/dictionaries#readme)
9797
- [Google/fuzzing dictionary repository](https://github.com/google/fuzzing/tree/master/dictionaries)
9898

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy