about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--Makefile14
-rw-r--r--README.md13
-rw-r--r--docs/ChangeLog1
3 files changed, 25 insertions, 3 deletions
diff --git a/Makefile b/Makefile
index 44258a4f..da4c5e95 100644
--- a/Makefile
+++ b/Makefile
@@ -81,6 +81,20 @@ endif
 all:	test_x86 test_shm test_python27 ready $(PROGS) afl-as test_build all_done
 
 
+help:
+	@echo "HELP --- the following make targets exist:"
+	@echo "=========================================="
+	@echo "all: just the main afl++ binaries"
+	@echo "binary-only: everything for binary-only fuzzing: qemu_mode, unicorn_mode, libdislocator, libtokencap"
+	@echo "source-only: everything for source code fuzzing: llvm_mode, libdislocator, libtokencap"
+	@echo "distrib: everything (for both binary-only and source code fuzzing)"
+	@echo "install: installs everything you have compiled with the build option above"
+	@echo "clean: cleans everything. for qemu_mode and unicorn_mode it means it deletes all downloads as well"
+	@echo "help: shows these build options :-)"
+	@echo "=========================================="
+	@echo "Recommended: \"distrib\" or \"source-only\", then \"install\""
+
+
 ifndef AFL_NO_X86
 
 test_x86:
diff --git a/README.md b/README.md
index 6fa95c95..b1a04611 100644
--- a/README.md
+++ b/README.md
@@ -80,16 +80,23 @@ $ sudo make install
 
 Note that "make distrib" also builds llvm_mode, qemu_mode, unicorn_mode and
 more. If you just want plain afl then do "make all", however compiling and
-using at least llvm_mode is highly recommended for much better results!
+using at least llvm_mode is highly recommended for much better results -
+hence in this case 
+
+```shell
+$ make source-only
+```
+is what you should choose.
 
 These build options exist:
 
-* all: just afl
+* all: just the main afl++ binaries
 * binary-only: everything for binary-only fuzzing: qemu_mode, unicorn_mode, libdislocator, libtokencap
 * source-only: everything for source code fuzzing: llvm_mode, libdislocator, libtokencap
 * distrib: everything (for both binary-only and source code fuzzing)
-* install: installs everything you have compiled with the build option above
+* install: installs everything you have compiled with the build options above
 * clean: cleans everything. for qemu_mode and unicorn_mode it means it deletes all downloads as well
+* help: shows these build options
 
 
 ## 1) Challenges of guided fuzzing
diff --git a/docs/ChangeLog b/docs/ChangeLog
index 171845b7..c1b401c9 100644
--- a/docs/ChangeLog
+++ b/docs/ChangeLog
@@ -23,6 +23,7 @@ Version ++2.54d (dev):
   - no more unlinking the input file, this way the input file can also be a
     FIFO or disk partition
   - reducing duplicate code in afl-fuzz
+  - added "make help"
   - removed compile warnings from python internal stuff
   - added man page for afl-clang-fast[++]
   - updated documentation