Skip to content

Commit 891b568

Browse files
hexcoder-hexcoder-
committed
fix references to README docs
1 parent 901360b commit 891b568

24 files changed

+42
-42
lines changed

‎afl-cmin.bash

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Minimization settings:
126126
-C - keep crashing inputs, reject everything else
127127
-e - solve for edge coverage only, ignore hit counts
128128
129-
For additional tips, please consult docs/README.
129+
For additional tips, please consult docs/README.md.
130130
131131
Environment variables used:
132132
AFL_KEEP_TRACES: leave the temporary <out_dir>\.traces directory

‎docs/Changelog.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Changelog
22

33
This is the list of all noteworthy changes made in every public release of
4-
the tool. See README for the general instruction manual.
4+
the tool. See README.md for the general instruction manual.
55

66
## Staying informed
77

@@ -45,7 +45,7 @@ sending a mail to <[email protected]>.
4545
- now does not need to be recompiled between trace-pc and pass
4646
instrumentation. compile normally and set AFL_LLVM_USE_TRACE_PC :)
4747
- LLVM 11 is supported
48-
- CmpLog instrumentation using SanCov (see llvm_mode/README.cmplog)
48+
- CmpLog instrumentation using SanCov (see llvm_mode/README.cmplog.md)
4949
- afl-gcc, afl-clang-fast, afl-gcc-fast:
5050
- experimental support for undefined behaviour sanitizer UBSAN
5151
(set AFL_USE_UBSAN=1)
@@ -189,7 +189,7 @@ sending a mail to <[email protected]>.
189189
- fix llvm_mode AFL_TRACE_PC with modern llvm
190190
- fix a crash in qemu_mode which also exists in stock afl
191191
- added libcompcov, a laf-intel implementation for qemu! :)
192-
see qemu_mode/libcompcov/README.libcompcov
192+
see qemu_mode/libcompcov/README.libcompcov.md
193193
- afl-fuzz now displays the selected core in the status screen (blue {#})
194194
- updated afl-fuzz and afl-system-config for new scaling governor location
195195
in modern kernels
@@ -198,8 +198,8 @@ sending a mail to <[email protected]>.
198198
- if llvm_mode was compiled, afl-clang/afl-clang++ will point to these
199199
instead of afl-gcc
200200
- added instrim, a much faster llvm_mode instrumentation at the cost of
201-
path discovery. See llvm_mode/README.instrim (https://github.com/csienslab/instrim)
202-
- added MOpt (github.com/puppet-meteor/MOpt-AFL) mode, see docs/README.MOpt
201+
path discovery. See llvm_mode/README.instrim.md (https://github.com/csienslab/instrim)
202+
- added MOpt (github.com/puppet-meteor/MOpt-AFL) mode, see docs/README.MOpt.md
203203
- added code to make it more portable to other platforms than Intel Linux
204204
- added never zero counters for afl-gcc and optionally (because of an
205205
optimization issue in llvm < 9) for llvm_mode (AFL_LLVM_NEVER_ZERO=1)
@@ -229,11 +229,11 @@ sending a mail to <[email protected]>.
229229
LLVM and Qemu modes are now faster.
230230
Important changes:
231231
afl-fuzz: -e EXTENSION commandline option
232-
llvm_mode: LAF-intel performance (needs activation, see llvm/README.laf-intel)
233-
a few new environment variables for afl-fuzz, llvm and qemu, see docs/env_variables.txt
232+
llvm_mode: LAF-intel performance (needs activation, see llvm/README.laf-intel.md)
233+
a few new environment variables for afl-fuzz, llvm and qemu, see docs/env_variables.md
234234
- Added the power schedules of AFLfast by Marcel Boehme, but set the default
235235
to the AFL schedule, not to the FAST schedule. So nothing changes unless
236-
you use the new -p option :-) - see docs/power_schedules.txt
236+
you use the new -p option :-) - see docs/power_schedules.md
237237
- added afl-system-config script to set all system performance options for fuzzing
238238
- llvm_mode works with llvm 3.9 up to including 8 !
239239
- qemu_mode got upgraded from 2.1 to 3.1 - incorporated from
@@ -476,7 +476,7 @@ sending a mail to <[email protected]>.
476476
- Added libtokencap, a simple feature to intercept strcmp / memcmp and
477477
generate dictionary entries that can help extend coverage.
478478

479-
- Moved libdislocator to its own dir, added README.
479+
- Moved libdislocator to its own dir, added README.md.
480480

481481
- The demo in examples/instrumented_cmp is no more.
482482

‎docs/QuickStartGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ how to hit the ground running:
2727

2828
4) Get a small but valid input file that makes sense to the program. When
2929
fuzzing verbose syntax (SQL, HTTP, etc), create a dictionary as described in
30-
dictionaries/README.dictionaries, too.
30+
dictionaries/README.md, too.
3131

3232
5) If the program reads from stdin, run 'afl-fuzz' like so:
3333

‎docs/env_variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document discusses the environment variables used by American Fuzzy Lop++
44
to expose various exotic functions that may be (rarely) useful for power
5-
users or for some types of custom fuzzing setups. See README for the general
5+
users or for some types of custom fuzzing setups. See README.md for the general
66
instruction manual.
77

88
## 1) Settings for afl-gcc, afl-clang, and afl-as - and gcc_plugin afl-gcc-fast

‎docs/life_pro_tips.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Specify `AFL_HARDEN=1` in the environment to enable hardening flags.
6262

6363
## Bumping into problems with non-reproducible crashes?
6464
It happens, but usually
65-
isn't hard to diagnose. See section #7 in README for tips.
65+
isn't hard to diagnose. See section #7 in README.md for tips.
6666

6767
## Fuzzing is not just about memory corruption issues in the codebase.
6868
Add some
@@ -87,4 +87,4 @@ use a postprocessor! See examples/post_library/ for more.
8787

8888
## Dealing with a very slow target or hoping for instant results?
8989

90-
Specify `-d` when calling afl-fuzz!
90+
Specify `-d` when calling afl-fuzz!

‎docs/notes_for_asan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Notes for using ASAN with afl-fuzz
22

33
This file discusses some of the caveats for fuzzing under ASAN, and suggests
4-
a handful of alternatives. See README for the general instruction manual.
4+
a handful of alternatives. See README.md for the general instruction manual.
55

66
## 1) Short version
77

‎docs/parallel_fuzzing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Tips for parallel fuzzing
22

33
This document talks about synchronizing afl-fuzz jobs on a single machine
4-
or across a fleet of systems. See README for the general instruction manual.
4+
or across a fleet of systems. See README.md for the general instruction manual.
55

66
## 1) Introduction
77

‎docs/perf_tips.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Tips for performance optimization
22

33
This file provides tips for troubleshooting slow or wasteful fuzzing jobs.
4-
See README for the general instruction manual.
4+
See README.md for the general instruction manual.
55

66
## 1. Keep your test cases small
77

@@ -221,4 +221,4 @@ early on, you can always resort to the `-d` mode.
221221
The mode causes `afl-fuzz` to skip all the deterministic fuzzing steps, which
222222
makes output a lot less neat and can ultimately make the testing a bit less
223223
in-depth, but it will give you an experience more familiar from other fuzzing
224-
tools.
224+
tools.

‎docs/sister_projects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Sister projects
22

33
This doc lists some of the projects that are inspired by, derived from,
4-
designed for, or meant to integrate with AFL. See README for the general
4+
designed for, or meant to integrate with AFL. See README.md for the general
55
instruction manual.
66

77
!!!
@@ -252,7 +252,7 @@ https://code.google.com/p/address-sanitizer/wiki/AsanCoverage#Coverage_counters
252252
### AFL JS (Han Choongwoo)
253253

254254
One-off optimizations to speed up the fuzzing of JavaScriptCore (now likely
255-
superseded by LLVM deferred forkserver init - see llvm_mode/README.llvm).
255+
superseded by LLVM deferred forkserver init - see llvm_mode/README.md).
256256

257257
https://github.com/tunz/afl-fuzz-js
258258

‎docs/status_screen.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Understanding the status screen
22

33
This document provides an overview of the status screen - plus tips for
4-
troubleshooting any warnings and red text shown in the UI. See README for
4+
troubleshooting any warnings and red text shown in the UI. See README.md for
55
the general instruction manual.
66

77
## A note about colors

‎docs/technical_details.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Technical "whitepaper" for afl-fuzz
22

33
This document provides a quick overview of the guts of American Fuzzy Lop.
4-
See README for the general instruction manual; and for a discussion of
4+
See README.md for the general instruction manual; and for a discussion of
55
motivations and design goals behind AFL, see historical_notes.md.
66

77
## 0. Design statement
@@ -542,4 +542,4 @@ It uses the following classification scheme:
542542
takes place.
543543
- "Magic value section" - a generic token where changes cause the type
544544
of binary behavior outlined earlier, but that doesn't meet any of the
545-
other criteria. May be an atomically compared keyword or so.
545+
other criteria. May be an atomically compared keyword or so.

‎gcc_plugin/afl-gcc-rt.o.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ static void __afl_start_forkserver(void) {
214214

215215
}
216216

217-
/* A simplified persistent mode handler, used as explained in README.llvm. */
217+
/* A simplified persistent mode handler, used as explained in README.md. */
218218

219219
int __afl_persistent_loop(unsigned int max_cnt) {
220220

‎libdislocator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# libdislocator, an abusive allocator
22

3-
(See ../docs/README for the general instruction manual.)
3+
(See ../docs/README.md for the general instruction manual.)
44

55
This is a companion library that can be used as a drop-in replacement for the
66
libc allocator in the fuzzed binaries. It improves the odds of bumping into

‎libtokencap/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# strcmp() / memcmp() token capture library
22

3-
(See ../docs/README for the general instruction manual.)
3+
(See ../docs/README.md for the general instruction manual.)
44

55
This companion library allows you to instrument `strcmp()`, `memcmp()`,
66
and related functions to automatically extract syntax tokens passed to any of

‎llvm_mode/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
(See [../README](../README.md) for the general instruction manual.)
44

5-
(See [../gcc_plugin/README.gcc](../gcc_plugin/README.gcc.md) for the GCC-based instrumentation.)
5+
(See [../gcc_plugin/README](../gcc_plugin/README.md) for the GCC-based instrumentation.)
66

77
## 1) Introduction
88

‎llvm_mode/afl-llvm-rt.o.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ static void __afl_start_forkserver(void) {
260260

261261
}
262262

263-
/* A simplified persistent mode handler, used as explained in README.llvm. */
263+
/* A simplified persistent mode handler, used as explained in llvm_mode/README.md. */
264264

265265
int __afl_persistent_loop(unsigned int max_cnt) {
266266

@@ -346,7 +346,7 @@ __attribute__((constructor(CONST_PRIO))) void __afl_auto_init(void) {
346346

347347
/* The following stuff deals with supporting -fsanitize-coverage=trace-pc-guard.
348348
It remains non-operational in the traditional, plugin-backed LLVM mode.
349-
For more info about 'trace-pc-guard', see README.llvm.
349+
For more info about 'trace-pc-guard', see llvm_mode/README.md.
350350
351351
The first function (__sanitizer_cov_trace_pc_guard) is called back on every
352352
edge (as opposed to every basic block). */

‎qemu_mode/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# High-performance binary-only instrumentation for afl-fuzz
22

3-
(See ../docs/README for the general instruction manual.)
3+
(See ../docs/README.md for the general instruction manual.)
44

55
## 1) Introduction
66

@@ -60,7 +60,7 @@ binary on x86_64) use QEMU_LD_PREFIX.
6060

6161
## 3) Bonus feature #1: deferred initialization
6262

63-
As for LLVM mode (refer to its README for mode details) QEMU mode supports
63+
As for LLVM mode (refer to its README.md for mode details) QEMU mode supports
6464
the deferred initialization.
6565

6666
This can be enabled setting the environment variable AFL_ENTRYPOINT which allows

‎qemu_mode/libcompcov/libcompcov.so.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
1616
This Linux-only companion library allows you to instrument strcmp(),
1717
memcmp(), and related functions to get compare coverage.
18-
See README.compcov for more info.
18+
See README.md for more info.
1919
2020
*/
2121

‎qemu_mode/patches/afl-qemu-cpu-inl.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ void afl_forkserver(CPUState *cpu) {
407407

408408
}
409409

410-
/* A simplified persistent mode handler, used as explained in README.llvm. */
410+
/* A simplified persistent mode handler, used as explained in llvm_mode/README.md. */
411411

412412
void afl_persistent_loop(void) {
413413

‎src/afl-analyze.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ static void usage(u8* argv0) {
798798

799799
" -e - look for edge coverage only, ignore hit counts\n\n"
800800

801-
"For additional tips, please consult %s/README.\n\n",
801+
"For additional tips, please consult %s/README.md.\n\n",
802802

803803
argv0, EXEC_TIMEOUT, MEM_LIMIT, doc_path);
804804

‎src/afl-common.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ char** get_qemu_argv(u8* own_loc, char** argv, int argc) {
163163
SAYF("\n" cLRD "[-] " cRST
164164
"Oops, unable to find the 'afl-qemu-trace' binary. The binary must be "
165165
"built\n"
166-
" separately by following the instructions in qemu_mode/README.qemu. "
166+
" separately by following the instructions in qemu_mode/README.md. "
167167
"If you\n"
168168
" already have the binary installed, you may need to specify "
169169
"AFL_PATH in the\n"
@@ -259,7 +259,7 @@ char** get_wine_argv(u8* own_loc, char** argv, int argc) {
259259
SAYF("\n" cLRD "[-] " cRST
260260
"Oops, unable to find the '%s' binary. The binary must be "
261261
"built\n"
262-
" separately by following the instructions in qemu_mode/README.qemu. "
262+
" separately by following the instructions in qemu_mode/README.md. "
263263
"If you\n"
264264
" already have the binary installed, you may need to specify "
265265
"AFL_PATH in the\n"

‎src/afl-fuzz-init.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1980,11 +1980,11 @@ void check_binary(u8* fname) {
19801980
"while\n"
19811981
" mutating the input data. For more information, and for tips on "
19821982
"how to\n"
1983-
" instrument binaries, please see %s/README.\n\n"
1983+
" instrument binaries, please see %s/README.md.\n\n"
19841984

19851985
" When source code is not available, you may be able to leverage "
19861986
"QEMU\n"
1987-
" mode support. Consult the README for tips on how to enable this.\n"
1987+
" mode support. Consult the README.md for tips on how to enable this.\n"
19881988

19891989
" (It is also possible to use afl-fuzz as a traditional, \"dumb\" "
19901990
"fuzzer.\n"

‎src/afl-fuzz.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ static void usage(u8* argv0) {
112112
"entering the\n"
113113
" pacemaker mode (minutes of no new paths, 0 = "
114114
"immediately).\n"
115-
" a recommended value is 10-60. see docs/README.MOpt\n"
115+
" a recommended value is 10-60. see docs/README.MOpt.md\n"
116116
" -c program - enable CmpLog by specifying a binary compiled for "
117117
"it.\n"
118118
" if using QEMU, just use -c 0.\n\n"
@@ -121,7 +121,7 @@ static void usage(u8* argv0) {
121121
" -N - do not unlink the fuzzing input file\n"
122122
" -d - quick & dirty mode (skips deterministic steps)\n"
123123
" -n - fuzz without instrumentation (dumb mode)\n"
124-
" -x dir - optional fuzzer dictionary (see README, its really "
124+
" -x dir - optional fuzzer dictionary (see README.md, its really "
125125
"good!)\n\n"
126126

127127
"Testing settings:\n"
@@ -1087,7 +1087,7 @@ int main(int argc, char** argv, char** envp) {
10871087

10881088
SAYF("\n" cYEL "[!] " cRST
10891089
"Stopped during the first cycle, results may be incomplete.\n"
1090-
" (For info on resuming, see %s/README)\n",
1090+
" (For info on resuming, see %s/README.md)\n",
10911091
doc_path);
10921092

10931093
}

‎src/afl-showmap.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -647,7 +647,7 @@ static void usage(u8* argv0) {
647647
" -c - allow core dumps\n\n"
648648

649649
"This tool displays raw tuple data captured by AFL instrumentation.\n"
650-
"For additional help, consult %s/README.\n\n" cRST,
650+
"For additional help, consult %s/README.md.\n\n" cRST,
651651

652652
argv0, MEM_LIMIT, doc_path);
653653

0 commit comments

Comments
 (0)