From 96313f87175f47a8b75bd37b9e5365ff3df581c1 Mon Sep 17 00:00:00 2001 From: vanhauser-thc Date: Fri, 30 Apr 2021 11:05:25 +0200 Subject: [PATCH] fix typos --- README.md | 2 +- docs/src/design/architecture.md | 2 +- docs/src/getting_started/setup.md | 12 ++++++------ docs/src/medatata/definition.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1c9e7a0a79..eeafb5a5f5 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ It is fast, multi-platform, no_std compatible, and scales over cores and machine It offers a main crate that provide building blocks for custom fuzzers, [libafl](./libafl), a library containing common code that can be used for targets instrumentation, [libafl_targets](./libafl_targets), and a library providing facilities to wrap compilers, [libafl_cc](./libafl_cc). -LibAFL offers integrations with popular instrumemntation frameworks. At the moment, the supported backends are: +LibAFL offers integrations with popular instrumentation frameworks. At the moment, the supported backends are: + SanitizerCoverage, in [libafl_targets](./libafl_targets) + Frida, in [libafl_frida](./libafl_frida), by s1341 (Windows support is broken atm, it relies on [this upstream issue](https://github.com/meme/frida-rust/issues/9) to be fixed.) diff --git a/docs/src/design/architecture.md b/docs/src/design/architecture.md index b600ebdc75..321a612a1b 100644 --- a/docs/src/design/architecture.md +++ b/docs/src/design/architecture.md @@ -2,7 +2,7 @@ The LibAFL architecture is built around some entities to allow code reuse and low-cost abstractions. -Initially, we started thinking to implement LibAFL in an Object Oriented language, such C++. When we landed to Rust, we immediately changed our idea as we realized that, while Rust allow a sort of OOP pattern, we can build the library using a more sane approach like the one described in [this blogpost](https://kyren.github.io/2018/09/14/rustconf-talk.html) about game design in Rust. +Initially, we started thinking to implement LibAFL in an Object Oriented language, such C++. When we landed to Rust, we immediately changed our idea as we realized that, while Rust allows a sort of OOP pattern, we can build the library using a more sane approach like the one described in [this blogpost](https://kyren.github.io/2018/09/14/rustconf-talk.html) about game design in Rust. The LibAFL code reuse meachanism is so based on components rather than sub-classes, but there are still some OOP patterns in the library. diff --git a/docs/src/getting_started/setup.md b/docs/src/getting_started/setup.md index e57aca1f14..3734f90e3e 100644 --- a/docs/src/getting_started/setup.md +++ b/docs/src/getting_started/setup.md @@ -37,17 +37,17 @@ In addition, if you want to perform source-level fuzz testing of C/C++ applicati you will likely need Clang with its instrumentation options to compile the programs under test. -You can download and build the LLVM source tree, Clang included, following the steps -explained [here](https://clang.llvm.org/get_started.html). - -Alternatively, on Linux, you can use your distro's package manager to get Clang, +On Linux you can use your distro's package manager to get Clang, but these packages are not always updated, so we suggest you to use the Debian/Ubuntu prebuilt packages from LLVM that are available using their [official repository](https://apt.llvm.org/). -For Miscrosoft Windows, you can download the [installer package](https://llvm.org/builds/) that LLVM generates periodically. +For Microsoft Windows, you can download the [installer package](https://llvm.org/builds/) that LLVM generates periodically. Despite that Clang is the default C compiler on macOS, we discourage the use of the build shipped by Apple and encourage -the installation from `brew` or direclty a fresh build from the source code. +the installation from `brew` or directly a fresh build from the source code. + +Alternatively you can download and build the LLVM source tree - Clang included - following the steps +explained [here](https://clang.llvm.org/get_started.html). ## Rust installation diff --git a/docs/src/medatata/definition.md b/docs/src/medatata/definition.md index f78e552859..1f854ecc5a 100644 --- a/docs/src/medatata/definition.md +++ b/docs/src/medatata/definition.md @@ -14,6 +14,6 @@ pub struct MyMetadata { } ``` -The struct must be static, so it cannot holds references to borrowed objects. +The struct must be static, so it cannot hold references to borrowed objects.