about summary refs log tree commit diff
diff options
context:
space:
mode:
authorvan Hauser <vh@thc.org>2022-01-11 19:35:04 +0100
committerGitHub <noreply@github.com>2022-01-11 19:35:04 +0100
commit741dcabd5dfca3607a86acd916b3563e01c3ccea (patch)
tree0a5082f8c79e2feee4ba1a1bf7a76d0e0d0030cb
parentc7dbeb856866b9ca8f9772ff965edce91ce71659 (diff)
parentd8920e31f861501156f366a54f80f9a9f9368df7 (diff)
downloadafl++-741dcabd5dfca3607a86acd916b3563e01c3ccea.tar.gz
Merge pull request #1248 from intrigus-lgtm/patch-2
Fix two typos.
-rw-r--r--README.md6
-rw-r--r--docs/FAQ.md12
-rw-r--r--docs/INSTALL.md6
-rw-r--r--docs/best_practices.md4
-rw-r--r--docs/important_changes.md8
5 files changed, 18 insertions, 18 deletions
diff --git a/README.md b/README.md
index 62b928e4..9e41a088 100644
--- a/README.md
+++ b/README.md
@@ -149,7 +149,7 @@ The following branches exist:
   stability
 * [dev](https://github.com/AFLplusplus/AFLplusplus/tree/dev): development state
   of AFL++ - bleeding edge and you might catch a checkout which does not compile
-  or has a bug. **We only accept PRs (push requests) for the 'dev' branch!**
+  or has a bug. **We only accept PRs (pull requests) for the 'dev' branch!**
 * (any other): experimental branches to work on specific features or testing new
   functionality or changes.
 
@@ -163,7 +163,7 @@ This can be your way to support and contribute to AFL++ - extend it to do
 something cool.
 
 For everyone who wants to contribute (and send pull requests), please read our
-[contributing guidelines](CONTRIBUTING.md) before your submit.
+[contributing guidelines](CONTRIBUTING.md) before you submit.
 
 ## Special thanks
 
@@ -223,7 +223,7 @@ Thank you! (For people sending pull requests - please add yourself to this list
     Josephine Calliotte                   Konrad Welc
     Thomas Rooijakkers                    David Carlier
     Ruben ten Hove                        Joey Jiao
-    fuzzah
+    fuzzah                                @intrigus-lgtm
   ```
 
 </details>
diff --git a/docs/FAQ.md b/docs/FAQ.md
index 3d3dce20..90cae453 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -58,10 +58,10 @@ If you find an interesting or important question missing, submit it via
 
   A program contains `functions`, `functions` contain the compiled machine code.
   The compiled machine code in a `function` can be in a single or many `basic
-  blocks`. A `basic block` is the largest possible number of subsequent machine
-  code instructions that has exactly one entry point (which can be be entered by
-  multiple other basic blocks) and runs linearly without branching or jumping to
-  other addresses (except at the end).
+  blocks`. A `basic block` is the **largest possible number of subsequent machine
+  code instructions** that has **exactly one entry point** (which can be be entered by
+  multiple other basic blocks) and runs linearly **without branching or jumping to
+  other addresses** (except at the end).
 
   ```
   function() {
@@ -191,7 +191,7 @@ If you find an interesting or important question missing, submit it via
   AFL++ comes with several power schedules, initially ported from [AFLFast](https://github.com/mboehme/aflfast)
   however modified to be more effective and several more modes added.
 
-  The most effective modes are '-p fast` (default) and `-p explore`.
+  The most effective modes are `-p fast` (default) and `-p explore`.
 
   If you fuzz with several parallel afl-fuzz instances, then it is beneficial
   to assign a different schedule to each instance, however the majority should
@@ -225,4 +225,4 @@ If you find an interesting or important question missing, submit it via
   package and because of that the AFL++ llvm plugins do not match anymore.
 
   Solution: `git pull ; make clean install` of AFL++.
-</p></details>
\ No newline at end of file
+</p></details>
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
index efec0d8b..2c1eaeb9 100644
--- a/docs/INSTALL.md
+++ b/docs/INSTALL.md
@@ -12,7 +12,7 @@ docker run -ti -v /location/of/your/target:/src aflplusplus/aflplusplus
 ```
 
 This image is automatically generated when a push to the stable repo happens.
-You will find your target source code in /src in the container.
+You will find your target source code in `/src` in the container.
 
 If you want to build AFL++ yourself, you have many options. The easiest choice
 is to build and install everything:
@@ -33,8 +33,8 @@ sudo make install
 It is recommended to install the newest available gcc, clang and llvm-dev
 possible in your distribution!
 
-Note that "make distrib" also builds FRIDA mode, QEMU mode, unicorn_mode
-and more. If you just want plain AFL++, then do "make all". If you want
+Note that `make distrib` also builds FRIDA mode, QEMU mode, unicorn_mode
+and more. If you just want plain AFL++, then do `make all`. If you want
 some assisting tooling compiled but are not interested in binary-only targets
 then instead choose:
 
diff --git a/docs/best_practices.md b/docs/best_practices.md
index 96c6e3c2..133c645e 100644
--- a/docs/best_practices.md
+++ b/docs/best_practices.md
@@ -116,7 +116,7 @@ allows you to define network state with different type of data packets.
 
 ### Improving stability
 
-For fuzzing a 100% stable target that covers all edges is the best case. A 90%
+For fuzzing, a 100% stable target that covers all edges is the best case. A 90%
 stable target that covers all edges is, however, better than a 100% stable
 target that ignores 10% of the edges.
 
@@ -189,4 +189,4 @@ coding and/or disassembly and is effectively possible only with `afl-clang-fast`
      Recompile, fuzz it, be happy :)
 
      This link explains this process for
-     [Fuzzbench](https://github.com/google/fuzzbench/issues/677).
\ No newline at end of file
+     [Fuzzbench](https://github.com/google/fuzzbench/issues/677).
diff --git a/docs/important_changes.md b/docs/important_changes.md
index 040a086d..39fe56b9 100644
--- a/docs/important_changes.md
+++ b/docs/important_changes.md
@@ -12,11 +12,11 @@ With AFL++ 4.00, we introduced the following changes from previous behaviors:
   * better naming for several fields in the UI
 
 With AFL++ 3.15, we introduced the following changes from previous behaviors:
-  * afl-cmin and afl-showmap -Ci now descent into subdirectories like afl-fuzz
+  * afl-cmin and afl-showmap -Ci now descend into subdirectories like afl-fuzz
     -i does (but note that afl-cmin.bash does not)
 
 With AFL++ 3.14, we introduced the following changes from previous behaviors:
-  * afl-fuzz: deterministic fuzzing it not a default for -M main anymore
+  * afl-fuzz: deterministic fuzzing is not a default for -M main anymore
   * afl-cmin/afl-showmap -i now descends into subdirectories (afl-cmin.bash,
     however, does not)
 
@@ -44,9 +44,9 @@ behaviors and defaults:
     * if neither -M or -S is specified, `-S default` is assumed, so more fuzzers
       can easily be added later
     * `-i` input directory option now descends into subdirectories. It also does
-      not fatal on crashes and too large files, instead it skips them and uses
+      not fail on crashes and too large files, instead it skips them and uses
       them for splicing mutations
-    * -m none is now default, set memory limits (in MB) with, e.g., -m 250
+    * -m none is now the default, set memory limits (in MB) with, e.g., -m 250
     * deterministic fuzzing is now disabled by default (unless using -M) and can
       be enabled with -D
     * a caching of test cases can now be performed and can be modified by