Skip to content

Commit 542bea3

Browse files
vanhauser-thcvanhauser-thc
committed
fix MDs
1 parent 1d8e772 commit 542bea3

20 files changed

+41
-55
lines changed

‎Makefile

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -410,17 +410,3 @@ endif
410410
cp -r testcases/ $${DESTDIR}$(MISC_PATH)
411411
cp -r dictionaries/ $${DESTDIR}$(MISC_PATH)
412412

413-
#publish: clean
414-
# test "`basename $$PWD`" = "afl" || exit 1
415-
# test -f ~/www/afl/releases/$(PROGNAME)-$(VERSION).tgz; if [ "$$?" = "0" ]; then echo; echo "Change program version in config.h, mmkay?"; echo; exit 1; fi
416-
# cd ..; rm -rf $(PROGNAME)-$(VERSION); cp -pr $(PROGNAME) $(PROGNAME)-$(VERSION); \
417-
# tar -cvz -f ~/www/afl/releases/$(PROGNAME)-$(VERSION).tgz $(PROGNAME)-$(VERSION)
418-
# chmod 644 ~/www/afl/releases/$(PROGNAME)-$(VERSION).tgz
419-
# ( cd ~/www/afl/releases/; ln -s -f $(PROGNAME)-$(VERSION).tgz $(PROGNAME)-latest.tgz )
420-
# cat docs/README.md >~/www/afl/README.txt
421-
# cat docs/status_screen.txt >~/www/afl/status_screen.txt
422-
# cat docs/historical_notes.txt >~/www/afl/historical_notes.txt
423-
# cat docs/technical_details.txt >~/www/afl/technical_details.txt
424-
# cat docs/ChangeLog >~/www/afl/ChangeLog.txt
425-
# cat docs/QuickStartGuide.txt >~/www/afl/QuickStartGuide.txt
426-
# echo -n "$(VERSION)" >~/www/afl/version.txt

‎README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ contains a good example of the input data normally expected by the targeted
315315
application. There are two basic rules:
316316

317317
- Keep the files small. Under 1 kB is ideal, although not strictly necessary.
318-
For a discussion of why size matters, see [perf_tips.txt](docs/perf_tips.txt).
318+
For a discussion of why size matters, see [perf_tips.md](docs/perf_tips.md).
319319

320320
- Use multiple test cases only if they are functionally different from
321321
each other. There is no point in using fifty different vacation photos
@@ -359,7 +359,7 @@ You can use -t and -m to override the default timeout and memory limit for the
359359
executed process; rare examples of targets that may need these settings touched
360360
include compilers and video decoders.
361361

362-
Tips for optimizing fuzzing performance are discussed in [perf_tips.txt](docs/perf_tips.txt).
362+
Tips for optimizing fuzzing performance are discussed in [perf_tips.md](docs/perf_tips.md).
363363

364364
Note that afl-fuzz starts by performing an array of deterministic fuzzing
365365
steps, which can take several days, but tend to produce neat test cases. If you
@@ -369,7 +369,7 @@ fuzzers - add the -d option to the command line.
369369

370370
## 8) Interpreting output
371371

372-
See the [docs/status_screen.txt](docs/status_screen.txt) file for information on
372+
See the [docs/status_screen.md](docs/status_screen.md) file for information on
373373
how to interpret the displayed stats and monitor the health of the process. Be
374374
sure to consult this file especially if any UI elements are highlighted in red.
375375

@@ -521,7 +521,7 @@ file, attempts to sequentially flip bytes, and observes the behavior of the
521521
tested program. It then color-codes the input based on which sections appear to
522522
be critical, and which are not; while not bulletproof, it can often offer quick
523523
insights into complex file formats. More info about its operation can be found
524-
near the end of [docs/technical_details.txt](docs/technical_details.txt).
524+
near the end of [docs/technical_details.md](docs/technical_details.md).
525525

526526

527527
## 12) Going beyond crashes

‎docs/QuickStartGuide.md

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

3-
You should read docs/README.md - it's pretty short. If you really can't, here's
3+
You should read [README.md](README.md) - it's pretty short. If you really can't, here's
44
how to hit the ground running:
55

6-
1) Compile AFL with 'make'. If build fails, see docs/INSTALL for tips.
6+
1) Compile AFL with 'make'. If build fails, see [INSTALL.md](INSTALL.md) for tips.
77

88
2) Find or write a reasonably fast and simple program that takes data from
99
a file or stdin, processes it in a test-worthy way, then exits cleanly.
@@ -15,7 +15,7 @@ how to hit the ground running:
1515

1616
The program must crash properly when a fault is encountered. Watch out for
1717
custom SIGSEGV or SIGABRT handlers and background processes. For tips on
18-
detecting non-crashing flaws, see section 11 in docs/README.md .
18+
detecting non-crashing flaws, see section 11 in [README.md](README.md) .
1919

2020
3) Compile the program / library to be fuzzed using afl-gcc. A common way to
2121
do this would be:
@@ -38,7 +38,7 @@ how to hit the ground running:
3838
command line; AFL will put an auto-generated file name in there for you.
3939

4040
6) Investigate anything shown in red in the fuzzer UI by promptly consulting
41-
docs/status_screen.txt.
41+
[status_screen.md](status_screen.md).
4242

4343
7) compile and use llvm_mode (afl-clang-fast/afl-clang-fast++) as it is way
4444
faster and has a few cool features
@@ -49,6 +49,6 @@ That's it. Sit back, relax, and - time permitting - try to skim through the
4949
following files:
5050

5151
- README.md - A general introduction to AFL,
52-
- docs/perf_tips.txt - Simple tips on how to fuzz more quickly,
53-
- docs/status_screen.txt - An explanation of the tidbits shown in the UI,
54-
- docs/parallel_fuzzing.md - Advice on running AFL on multiple cores.
52+
- docs/perf_tips.md - Simple tips on how to fuzz more quickly,
53+
- docs/status_screen.md - An explanation of the tidbits shown in the UI,
54+
- docs/parallel_fuzzing.md - Advice on running AFL on multiple cores.

‎docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ contains a good example of the input data normally expected by the targeted
315315
application. There are two basic rules:
316316

317317
- Keep the files small. Under 1 kB is ideal, although not strictly necessary.
318-
For a discussion of why size matters, see [perf_tips.txt](docs/perf_tips.txt).
318+
For a discussion of why size matters, see [perf_tips.md](docs/perf_tips.md).
319319

320320
- Use multiple test cases only if they are functionally different from
321321
each other. There is no point in using fifty different vacation photos
@@ -359,7 +359,7 @@ You can use -t and -m to override the default timeout and memory limit for the
359359
executed process; rare examples of targets that may need these settings touched
360360
include compilers and video decoders.
361361

362-
Tips for optimizing fuzzing performance are discussed in [perf_tips.txt](docs/perf_tips.txt).
362+
Tips for optimizing fuzzing performance are discussed in [perf_tips.md](docs/perf_tips.md).
363363

364364
Note that afl-fuzz starts by performing an array of deterministic fuzzing
365365
steps, which can take several days, but tend to produce neat test cases. If you
@@ -369,7 +369,7 @@ fuzzers - add the -d option to the command line.
369369

370370
## 8) Interpreting output
371371

372-
See the [docs/status_screen.txt](docs/status_screen.txt) file for information on
372+
See the [docs/status_screen.md](docs/status_screen.md) file for information on
373373
how to interpret the displayed stats and monitor the health of the process. Be
374374
sure to consult this file especially if any UI elements are highlighted in red.
375375

@@ -521,7 +521,7 @@ file, attempts to sequentially flip bytes, and observes the behavior of the
521521
tested program. It then color-codes the input based on which sections appear to
522522
be critical, and which are not; while not bulletproof, it can often offer quick
523523
insights into complex file formats. More info about its operation can be found
524-
near the end of [docs/technical_details.txt](docs/technical_details.txt).
524+
near the end of [docs/technical_details.md](docs/technical_details.md).
525525

526526

527527
## 12) Going beyond crashes

‎docs/binaryonly_fuzzing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
emulation. Runtime environment and/or loaders have to be written from scratch,
4444
if needed. On top, block chaining has been removed. This means the speed boost
4545
introduced in the patched QEMU Mode of afl++ cannot simply be ported over to
46-
Unicorn. For further information, check out ./unicorn_mode.txt.
46+
Unicorn. For further information, check out [unicorn_mode/README.md](../unicorn_mode/README.md).
4747

4848
As it is included in afl++ this needs no URL.
4949

‎docs/env_variables.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ tools make fairly broad use of environmental variables:
2222

2323
- Setting AFL_USE_ASAN automatically enables ASAN, provided that your
2424
compiler supports that. Note that fuzzing with ASAN is mildly challenging
25-
- see notes_for_asan.txt.
25+
- see [notes_for_asan.md](notes_for_asan.md).
2626

2727
(You can also enable MSAN via AFL_USE_MSAN; ASAN and MSAN come with the
2828
same gotchas; the modes are mutually exclusive. UBSAN and other exotic
@@ -221,10 +221,10 @@ checks or alter some of the more exotic semantics of the tool:
221221
- Setting AFL_CUSTOM_MUTATOR_LIBRARY to a shared library with
222222
afl_custom_mutator() export run additional mutations though this library.
223223
If AFL_CUSTOM_MUTATOR_ONLY is also set, all mutations will solely be
224-
performed with/from the libary. see docs/custom_mutator.txt
224+
performed with/from the libary. see [custom_mutator.md](custom_mutator.md)
225225

226226
- For AFL_PYTHON_MODULE and AFL_PYTHON_ONLY - they require to be compiled
227-
with -DUSE_PYTHON. Please see docs/python_mutators.txt
227+
with -DUSE_PYTHON. Please see [python_mutators.md](python_mutators.md)
228228
This feature allows to configure custom mutators which can be very helpful
229229
in e.g. fuzzing XML or other highly flexible structured input.
230230

‎docs/historical_notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ coverage-driven fuzzer that relied on coverage as a fitness function.
4040
Jared's approach was by no means identical to what afl-fuzz does, but it was in
4141
the same ballpark. His fuzzer tried to explicitly solve for the maximum coverage
4242
with a single input file; in comparison, afl simply selects for cases that do
43-
something new (which yields better results - see technical_details.txt).
43+
something new (which yields better results - see [technical_details.md](technical_details.md)).
4444

4545
A few years later, Gabriel Campana released fuzzgrind, a tool that relied purely
4646
on Valgrind and a constraint solver to maximize coverage without any brute-force
@@ -133,7 +133,7 @@ several itches that seemed impossible to scratch with other tools:
133133
corpora of interesting test cases that can be fed into a manual testing
134134
process or a UI harness later on.
135135

136-
As mentioned in technical_details.txt, AFL does all this not by systematically
136+
As mentioned in [technical_details.md](technical_details.md), AFL does all this not by systematically
137137
applying a single overarching CS concept, but by experimenting with a variety
138138
of small, complementary methods that were shown to reliably yields results
139139
better than chance. The use of instrumentation is a part of that toolkit, but is

‎docs/life_pro_tips.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ to read or memorize every other piece of documentation for AFL.
55

66
## Get more bang for your buck by using fuzzing dictionaries.
77

8-
See dictionaries/README.md to learn how.
8+
See [dictionaries/README.md](../dictionaries/README.md) to learn how.
99

1010
## You can get the most out of your hardware by parallelizing AFL jobs.
1111

12-
See docs/parallel_fuzzing.md for step-by-step tips.
12+
See [parallel_fuzzing.md](parallel_fuzzing.md) for step-by-step tips.
1313

1414
## Improve the odds of spotting memory corruption bugs with libdislocator.so!
1515

16-
It's easy. Consult libdislocator/README.md for usage tips.
16+
It's easy. Consult [libdislocator/README.md](../libdislocator/README.md) for usage tips.
1717

1818
## Want to understand how your target parses a particular input file?
1919

‎docs/parallel_fuzzing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ cases on the fly.
2525

2626
Note that afl++ has AFLfast's power schedules implemented.
2727
It is therefore a good idea to use different power schedules if you run
28-
several instances in parallel. See docs/power_schedules.txt
28+
several instances in parallel. See [power_schedules.md](power_schedules.md)
2929

3030
Alternatively running other AFL spinoffs in parallel can be of value,
3131
e.g. Angora (https://github.com/AngoraFuzzer/Angora/)

‎docs/status_screen.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ most of the time - and if it stays below 100, the job will probably take very
218218
long.
219219

220220
The fuzzer will explicitly warn you about slow targets, too. If this happens,
221-
see the perf_tips.txt file included with the fuzzer for ideas on how to speed
221+
see the [perf_tips.md](perf_tips.md) file included with the fuzzer for ideas on how to speed
222222
things up.
223223

224224
### Findings in depth

‎examples/asan_cgroups/limit_memory.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# This tool allows the amount of actual memory allocated to a program
2121
# to be limited on Linux systems using cgroups, instead of the traditional
2222
# setrlimit() API. This helps avoid the address space problems discussed in
23-
# docs/notes_for_asan.txt.
23+
# docs/notes_for_asan.md.
2424
#
2525
# Important: the limit covers *both* afl-fuzz and the fuzzed binary. In some
2626
# hopefully rare circumstances, afl-fuzz could be killed before the fuzzed

‎examples/custom_mutators/README

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
This is a simple example for the AFL_CUSTOM_MUTATOR_LIBRARY feature.
2-
For more information see docs/custom_mutator.txt
2+
For more information see [docs/custom_mutator.md](../docs/custom_mutator.md)

‎examples/python_mutators/README

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
These are example and helper files for the AFL_PYTHON_MODULE feature.
2-
See docs/python_mutators.txt for more information
2+
See [docs/python_mutators.md](../docs/python_mutators.md) for more information
33

44
Note that if you compile with python3.7 you must use python3 scripts, and if
55
you use pyton2.7 to compile python2 scripts!

‎gcc_plugin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ standard operating mode of AFL, e.g.:
5656
Be sure to also include CXX set to afl-g++-fast for C++ code.
5757

5858
The tool honors roughly the same environmental variables as afl-gcc (see
59-
../docs/env_variables.txt). This includes AFL_INST_RATIO, AFL_USE_ASAN,
59+
[env_variables.md](../docs/env_variables.md). This includes AFL_INST_RATIO, AFL_USE_ASAN,
6060
AFL_HARDEN, and AFL_DONT_OPTIMIZE.
6161

6262
Note: if you want the GCC plugin to be installed on your system for all

‎llvm_mode/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ operating mode of AFL, e.g.:
7373
Be sure to also include CXX set to afl-clang-fast++ for C++ code.
7474

7575
The tool honors roughly the same environmental variables as afl-gcc (see
76-
../docs/env_variables.txt). This includes AFL_USE_ASAN,
76+
[docs/env_variables.md](../docs/env_variables.md)). This includes AFL_USE_ASAN,
7777
AFL_HARDEN, and AFL_DONT_OPTIMIZE. However AFL_INST_RATIO is not honored
7878
as it does not serve a good purpose with the more effective instrim CFG
7979
analysis.

‎src/afl-forkserver.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ void init_forkserver(char **argv) {
332332
"have a\n"
333333
" restrictive memory limit configured, this is expected; please "
334334
"read\n"
335-
" %s/notes_for_asan.txt for help.\n",
335+
" %s/notes_for_asan.md for help.\n",
336336
doc_path);
337337

338338
} else if (!mem_limit) {
@@ -408,7 +408,7 @@ void init_forkserver(char **argv) {
408408
"with ASAN and\n"
409409
" you have a restrictive memory limit configured, this is "
410410
"expected; please\n"
411-
" read %s/notes_for_asan.txt for help.\n",
411+
" read %s/notes_for_asan.md for help.\n",
412412
doc_path);
413413

414414
} else if (!mem_limit) {

‎src/afl-fuzz-cmplog.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ void init_cmplog_forkserver(char** argv) {
217217
"have a\n"
218218
" restrictive memory limit configured, this is expected; please "
219219
"read\n"
220-
" %s/notes_for_asan.txt for help.\n",
220+
" %s/notes_for_asan.md for help.\n",
221221
doc_path);
222222

223223
} else if (!mem_limit) {
@@ -293,7 +293,7 @@ void init_cmplog_forkserver(char** argv) {
293293
"with ASAN and\n"
294294
" you have a restrictive memory limit configured, this is "
295295
"expected; please\n"
296-
" read %s/notes_for_asan.txt for help.\n",
296+
" read %s/notes_for_asan.md for help.\n",
297297
doc_path);
298298

299299
} else if (!mem_limit) {

‎src/afl-fuzz-init.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ void perform_dry_run(char** argv) {
601601
"quickly\n"
602602
" estimate the required amount of virtual memory for the "
603603
"binary. Also,\n"
604-
" if you are using ASAN, see %s/notes_for_asan.txt.\n\n"
604+
" if you are using ASAN, see %s/notes_for_asan.md.\n\n"
605605

606606
MSG_FORK_ON_APPLE
607607

‎src/afl-fuzz-stats.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -747,7 +747,7 @@ void show_init_stats(void) {
747747
SAYF("\n");
748748

749749
if (avg_us > ((qemu_mode || unicorn_mode) ? 50000 : 10000))
750-
WARNF(cLRD "The target binary is pretty slow! See %s/perf_tips.txt.",
750+
WARNF(cLRD "The target binary is pretty slow! See %s/perf_tips.md.",
751751
doc_path);
752752

753753
/* Let's keep things moving with slow binaries. */
@@ -762,10 +762,10 @@ void show_init_stats(void) {
762762
if (!resuming_fuzz) {
763763

764764
if (max_len > 50 * 1024)
765-
WARNF(cLRD "Some test cases are huge (%s) - see %s/perf_tips.txt!",
765+
WARNF(cLRD "Some test cases are huge (%s) - see %s/perf_tips.md!",
766766
DMS(max_len), doc_path);
767767
else if (max_len > 10 * 1024)
768-
WARNF("Some test cases are big (%s) - see %s/perf_tips.txt.",
768+
WARNF("Some test cases are big (%s) - see %s/perf_tips.md.",
769769
DMS(max_len), doc_path);
770770

771771
if (useless_at_start && !in_bitmap)

‎src/afl-fuzz.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ static void usage(u8* argv0) {
9696
"score.\n"
9797
" <explore (default), fast, coe, lin, quad, or "
9898
"exploit>\n"
99-
" see docs/power_schedules.txt\n"
99+
" see docs/power_schedules.md\n"
100100
" -f file - location read by the fuzzed program (stdin)\n"
101101
" -t msec - timeout for each run (auto-scaled, 50-%d ms)\n"
102102
" -m megs - memory limit for child process (%d MB)\n"
@@ -145,7 +145,7 @@ static void usage(u8* argv0) {
145145
argv0, EXEC_TIMEOUT, MEM_LIMIT);
146146

147147
#ifdef USE_PYTHON
148-
SAYF("Compiled with %s module support, see docs/python_mutators.txt\n",
148+
SAYF("Compiled with %s module support, see docs/python_mutators.md\n",
149149
(char*)PYTHON_VERSION);
150150
#endif
151151

0 commit comments

Comments
 (0)