about summary refs log tree commit diff
diff options
context:
space:
mode:
authorllzmb <46303940+llzmb@users.noreply.github.com>2021-09-10 21:37:55 +0200
committerllzmb <46303940+llzmb@users.noreply.github.com>2021-09-10 21:37:55 +0200
commit82ef4a90b0ff12a297e1bc3f1c8256ae9ace4f25 (patch)
tree53533545aadbfac3996a1e8f0badac531f51bf27
parentbd4ecd83b1e4126300475d5beb09b4a8327b045a (diff)
downloadafl++-82ef4a90b0ff12a297e1bc3f1c8256ae9ace4f25.tar.gz
Fix links
-rw-r--r--README.md2
-rw-r--r--docs/best_practices.md2
-rw-r--r--docs/branches.md2
-rw-r--r--docs/fuzzing_expert.md2
-rw-r--r--docs/interpreting_output.md2
-rw-r--r--docs/known_limitations.md2
-rw-r--r--docs/life_pro_tips.md20
-rw-r--r--docs/rpc_statsd.md2
-rw-r--r--docs/triaging_crashes.md2
9 files changed, 18 insertions, 18 deletions
diff --git a/README.md b/README.md
index eb99d9bd..25e47ef2 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ You are free to copy, modify, and distribute AFL++ with attribution under the te
 
 Here is some information to get you started:
 
-* For releases, please see the [Releases](https://github.com/AFLplusplus/AFLplusplus/releases) tab and [branches](docs/branches.md). Also take a look at the list of [important behaviour changes in AFL++](docs/important_changes.md).
+* For releases, please see the [Releases](https://github.com/AFLplusplus/AFLplusplus/releases) tab and [branches](docs/branches.md). Also take a look at the list of [important changes in AFL++](docs/important_changes.md).
 * If you want to use AFL++ for your academic work, check the [papers page](https://aflplus.plus/papers/) on the website.
 * To cite our work, look at the [Cite](#cite) section.
 * For comparisons, use the fuzzbench `aflplusplus` setup, or use `afl-clang-fast` with `AFL_LLVM_CMPLOG=1`. You can find the `aflplusplus` default configuration on Google's [fuzzbench](https://github.com/google/fuzzbench/tree/master/fuzzers/aflplusplus).
diff --git a/docs/best_practices.md b/docs/best_practices.md
index 23fa237d..1521748a 100644
--- a/docs/best_practices.md
+++ b/docs/best_practices.md
@@ -59,7 +59,7 @@ which allows you to define network state with different type of data packets.
 1. Use [llvm_mode](../instrumentation/README.llvm.md): afl-clang-lto (llvm >= 11) or afl-clang-fast (llvm >= 9 recommended).
 2. Use [persistent mode](../instrumentation/README.persistent_mode.md) (x2-x20 speed increase).
 3. Use the [AFL++ snapshot module](https://github.com/AFLplusplus/AFL-Snapshot-LKM) (x2 speed increase).
-4. If you do not use shmem persistent mode, use `AFL_TMPDIR` to put the input file directory on a tempfs location, see [docs/env_variables.md](docs/env_variables.md).
+4. If you do not use shmem persistent mode, use `AFL_TMPDIR` to put the input file directory on a tempfs location, see [env_variables.md](env_variables.md).
 5. Improve Linux kernel performance: modify `/etc/default/grub`, set `GRUB_CMDLINE_LINUX_DEFAULT="ibpb=off ibrs=off kpti=off l1tf=off mds=off mitigations=off no_stf_barrier noibpb noibrs nopcid nopti nospec_store_bypass_disable nospectre_v1 nospectre_v2 pcid=off pti=off spec_store_bypass_disable=off spectre_v2=off stf_barrier=off"`; then `update-grub` and `reboot` (warning: makes the system less secure).
 6. Running on an `ext2` filesystem with `noatime` mount option will be a bit faster than on any other journaling filesystem.
 7. Use your cores! [README.md:3.b) Using multiple cores/threads](../README.md#b-using-multiple-coresthreads).
diff --git a/docs/branches.md b/docs/branches.md
index 1e4ebbb2..81c73a0f 100644
--- a/docs/branches.md
+++ b/docs/branches.md
@@ -7,4 +7,4 @@ The following branches exist:
 * [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 in dev!!*
 * (any other): experimental branches to work on specific features or testing new functionality or changes.
 
-For releases, please see the [Releases](https://github.com/AFLplusplus/AFLplusplus/releases) tab. Also take a look at the list of [major behaviour changes in AFL++](behaviour_changes.md).
\ No newline at end of file
+For releases, please see the [Releases](https://github.com/AFLplusplus/AFLplusplus/releases) tab. Also take a look at the list of [important changes in AFL++](important_changes.md).
\ No newline at end of file
diff --git a/docs/fuzzing_expert.md b/docs/fuzzing_expert.md
index 23b24ad0..37ab8e2f 100644
--- a/docs/fuzzing_expert.md
+++ b/docs/fuzzing_expert.md
@@ -620,4 +620,4 @@ This is basically all you need to know to professionally run fuzzing campaigns.
 If you want to know more, the tons of texts in [docs/](./) will have you covered.
 
 Note that there are also a lot of tools out there that help fuzzing with AFL++
-(some might be deprecated or unsupported), see [links_tools.md](links_tools.md).
\ No newline at end of file
+(some might be deprecated or unsupported), see [tools.md](tools.md).
\ No newline at end of file
diff --git a/docs/interpreting_output.md b/docs/interpreting_output.md
index 54ad76df..364d2cf4 100644
--- a/docs/interpreting_output.md
+++ b/docs/interpreting_output.md
@@ -1,6 +1,6 @@
 # Interpreting output
 
-See the [docs/status_screen.md](docs/status_screen.md) file for information on
+See the [status_screen.md](status_screen.md) file for information on
 how to interpret the displayed stats and monitor the health of the process. Be
 sure to consult this file especially if any UI elements are highlighted in red.
 
diff --git a/docs/known_limitations.md b/docs/known_limitations.md
index deb539e2..b5fc8446 100644
--- a/docs/known_limitations.md
+++ b/docs/known_limitations.md
@@ -15,7 +15,7 @@ Here are some of the most important caveats for AFL:
     To work around this, you can comment out the relevant checks (see
     utils/libpng_no_checksum/ for inspiration); if this is not possible,
     you can also write a postprocessor, one of the hooks of custom mutators.
-    See [docs/custom_mutators.md](docs/custom_mutators.md) on how to use
+    See [custom_mutators.md](custom_mutators.md) on how to use
     `AFL_CUSTOM_MUTATOR_LIBRARY`
 
   - There are some unfortunate trade-offs with ASAN and 64-bit binaries. This
diff --git a/docs/life_pro_tips.md b/docs/life_pro_tips.md
index 13ffcea0..e79bcafa 100644
--- a/docs/life_pro_tips.md
+++ b/docs/life_pro_tips.md
@@ -27,16 +27,16 @@ Run the bundled `afl-plot` utility to generate browser-friendly graphs.
 Check out the `fuzzer_stats` file in the AFL output dir or try `afl-whatsup`.
 
 ## Puzzled by something showing up in red or purple in the AFL UI?
-It could be important - consult docs/status_screen.md right away!
+It could be important - consult [status_screen.md](status_screen.md) right away!
 
 ## Know your target? Convert it to persistent mode for a huge performance gain!
-Consult section #5 in README.llvm.md for tips.
+Consult section #5 in [instrumentation/README.llvm.md](../instrumentation/README.llvm.md) for tips.
 
 ## Using clang? 
-Check out instrumentation/ for a faster alternative to afl-gcc!
+Check out [instrumentation/](../instrumentation/) for a faster alternative to afl-gcc!
 
 ## Did you know that AFL can fuzz closed-source or cross-platform binaries?
-Check out qemu_mode/README.md and unicorn_mode/README.md for more.
+Check out [qemu_mode/README.md](../qemu_mode/README.md) and [unicorn_mode/README.md](../unicorn_mode/README.md) for more.
 
 ## Did you know that afl-fuzz can minimize any test case for you?
 Try the bundled `afl-tmin` tool - and get small repro files fast!
@@ -46,7 +46,7 @@ Try the bundled `afl-tmin` tool - and get small repro files fast!
 
 ## Trouble dealing with a machine uprising? Relax, we've all been there.
 
-Find essential survival tips at http://lcamtuf.coredump.cx/prep/.
+Find essential survival tips at [http://lcamtuf.coredump.cx/prep/](http://lcamtuf.coredump.cx/prep/).
 
 ## Want to automatically spot non-crashing memory handling bugs?
 
@@ -54,7 +54,7 @@ Try running an AFL-generated corpus through ASAN, MSAN, or Valgrind.
 
 ## Good selection of input files is critical to a successful fuzzing job.
 
-See docs/perf_tips.md for pro tips.
+See [perf_tips.md](perf_tips.md) for pro tips.
 
 ## You can improve the odds of automatically spotting stack corruption issues.
 
@@ -70,18 +70,18 @@ sanity-checking `assert()` / `abort()` statements to effortlessly catch logic bu
 
 ## Hey kid... pssst... want to figure out how AFL really works?
 
-Check out docs/technical_details.md for all the gory details in one place!
+Check out [technical_details.md](technical_details.md) for all the gory details in one place!
 
 ## There's a ton of third-party helper tools designed to work with AFL!
 
-Be sure to check out docs/sister_projects.md before writing your own.
+Be sure to check out [sister_projects.md](sister_projects.md) before writing your own.
 
 ## Need to fuzz the command-line arguments of a particular program?
 
-You can find a simple solution in utils/argv_fuzzing.
+You can find a simple solution in [utils/argv_fuzzing](../utils/argv_fuzzing/).
 
 ## Attacking a format that uses checksums? 
 
 Remove the checksum-checking code or use a postprocessor!
-See `afl_custom_post_process` in custom_mutators/examples/example.c for more.
+See `afl_custom_post_process` in [custom_mutators/examples/example.c](../custom_mutators/examples/example.c) for more.
 
diff --git a/docs/rpc_statsd.md b/docs/rpc_statsd.md
index 898ad099..efbd550b 100644
--- a/docs/rpc_statsd.md
+++ b/docs/rpc_statsd.md
@@ -41,7 +41,7 @@ To enable the StatsD reporting on your fuzzer instances, you need to set the env
 
 Setting `AFL_STATSD_TAGS_FLAVOR` to the provider of your choice will assign tags / labels to each metric based on their format.
 The possible values are  `dogstatsd`, `librato`, `signalfx` or `influxdb`.
-For more information on these env vars, check out `docs/env_variables.md`.
+For more information on these env vars, check out [env_variables.md](env_variables.md).
 
 The simplest way of using this feature is to use any metric provider and change the host/port of your StatsD daemon,
 with `AFL_STATSD_HOST` and `AFL_STATSD_PORT`, if required (defaults are `localhost` and port `8125`).
diff --git a/docs/triaging_crashes.md b/docs/triaging_crashes.md
index 1857c4b1..21ccecaa 100644
--- a/docs/triaging_crashes.md
+++ b/docs/triaging_crashes.md
@@ -43,4 +43,4 @@ file, attempts to sequentially flip bytes, and observes the behavior of the
 tested program. It then color-codes the input based on which sections appear to
 be critical, and which are not; while not bulletproof, it can often offer quick
 insights into complex file formats. More info about its operation can be found
-near the end of [docs/technical_details.md](docs/technical_details.md).
\ No newline at end of file
+near the end of [technical_details.md](technical_details.md).
\ No newline at end of file