Skip to content

Commit ad33ea0

Browse files
authored
Fix typos and crates names formatting in crates.md (#1639)
* Fix typos and crates formatting in crates.md * Fix header in crates.md
1 parent c6c93b5 commit ad33ea0

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/src/getting_started/crates.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ You can choose the features by using `features = ["feature1", "feature2", ...]`
3131
Out of this list, by default, `std`, `derive`, and `rand_trait` are already set.
3232
You can choose to disable them by setting `default-features = false` in your `Cargo.toml`.
3333

34-
## [`libafl_bolts](https://github.com/AFLplusplus/LibAFL/tree/main/libafl)
34+
### [`libafl_bolts`](https://github.com/AFLplusplus/LibAFL/tree/main/libafl)
3535

36-
The `libafl_bolts` create is a minimal tool shed filled with useful low-level rust features, not necessarily related to fuzzers.
36+
The `libafl_bolts` crate is a minimal tool shed filled with useful low-level rust features, not necessarily related to fuzzers.
3737
In it, you'll find highlights like:
3838

3939
- `core_affinity` to bind the current process to cores
@@ -46,20 +46,20 @@ In it, you'll find highlights like:
4646

4747
... and much more.
4848

49-
### libafl_sugar
49+
### `libafl_sugar`
5050

5151
The sugar crate abstracts away most of the complexity of LibAFL's API.
5252
Instead of high flexibility, it aims to be high-level and easy-to-use.
5353
It is not as flexible as stitching your fuzzer together from each individual component, but allows you to build a fuzzer with minimal lines of code.
5454
To see it in action, take a look at the [`libfuzzer_stb_image_sugar` example fuzzer](https://github.com/AFLplusplus/LibAFL/tree/main/fuzzers/libfuzzer_stb_image_sugar).
5555

56-
### libafl_derive
56+
### `libafl_derive`
5757

5858
This a proc-macro crate paired with the `libafl` crate.
5959

6060
At the moment, it just exposes the `derive(SerdeAny)` macro that can be used to define Metadata structs, see the section about [Metadata](../design/metadata.md) for details.
6161

62-
### libafl_targets
62+
### `libafl_targets`
6363

6464
This crate exposes code to interact with, and to instrument, targets.
6565
To enable and disable features at compile-time, the features are enabled and disabled using feature flags.
@@ -71,32 +71,32 @@ Currently, the supported flags are:
7171
- `libfuzzer` exposes a compatibility layer with libFuzzer style harnesses.
7272
- `value_profile` defines the SanitizerCoverage trace-cmp hooks to track the matching bits of each comparison in a map.
7373

74-
### libafl_cc
74+
### `libafl_cc`
7575

7676
This is a library that provides utils to wrap compilers and create source-level fuzzers.
7777

7878
At the moment, only the Clang compiler is supported.
7979
To understand it deeper, look through the tutorials and examples.
8080

81-
### libafl_frida
81+
### `libafl_frida`
8282

8383
This library bridges LibAFL with Frida as instrumentation backend.
8484
With this crate, you can instrument targets on Linux/macOS/Windows/Android for coverage collection.
8585
Additionally, it supports CmpLog, and AddressSanitizer instrumentation and runtimes for aarch64.
8686
See further information, as well as usage instructions, [later in the book](../advanced_features/frida.md).
8787

88-
### libafl_qemu
88+
### `libafl_qemu`
8989

9090
This library bridges LibAFL with QEMU user-mode to fuzz ELF cross-platform binaries.
9191

9292
It works on Linux and can collect edge coverage without collisions!
9393
It also supports a wide range of hooks and instrumentation options.
9494

95-
### libafl_nyx
95+
### `libafl_nyx`
9696

9797
[Nyx](https://nyx-fuzz.com/) is a KVM-based snapshot fuzzer. `libafl_nyx` adds these capabilities to LibAFL. There is a specific section explaining usage of libafl_nyx [later in the book](../advanced_features/nyx.md).
9898

99-
### libafl_concolic
99+
### `libafl_concolic`
100100

101101
Concolic fuzzing is the combination of fuzzing and a symbolic execution engine.
102102
This can reach greater depth than normal fuzzing, and is exposed in this crate.

0 commit comments

Comments
 (0)