about summary refs log tree commit diff
path: root/instrumentation/README.gcc_plugin.md
diff options
context:
space:
mode:
authorvan Hauser <vh@thc.org>2020-09-10 08:54:57 +0200
committervan Hauser <vh@thc.org>2020-09-10 08:54:57 +0200
commitfdb0452245672db94be0832288f1335e905a2fc8 (patch)
tree8bbac9c1a645eb9895efcb9b32fe7413321b66ad /instrumentation/README.gcc_plugin.md
parent454a860020048c5531f518b5691c92949bdc8017 (diff)
downloadafl++-fdb0452245672db94be0832288f1335e905a2fc8.tar.gz
update documentation
Diffstat (limited to 'instrumentation/README.gcc_plugin.md')
-rw-r--r--instrumentation/README.gcc_plugin.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/instrumentation/README.gcc_plugin.md b/instrumentation/README.gcc_plugin.md
index 53519b90..919801d1 100644
--- a/instrumentation/README.gcc_plugin.md
+++ b/instrumentation/README.gcc_plugin.md
@@ -3,6 +3,13 @@
 See [../README.md](../README.md) for the general instruction manual.
 See [README.llvm.md](README.llvm.md) for the LLVM-based instrumentation.
 
+TLDR:
+  * `apt-get install gcc-VERSION-plugin-dev`
+  * `make`
+  * gcc and g++ must point to the gcc-VERSION you you have to set AFL_CC/AFL_CXX
+    to point to these!
+  * just use afl-gcc-fast/afl-g++-fast normally like you would afl-clang-fast
+
 ## 1) Introduction
 
 The code in this directory allows you to instrument programs for AFL using
@@ -40,8 +47,12 @@ installing the `gcc-VERSION-plugin-dev` packages.
 
 To build the instrumentation itself, type 'make'. This will generate binaries
 called afl-gcc-fast and afl-g++-fast in the parent directory. 
+
+The gcc and g++ compiler links have to point to gcc-VERSION - or set these
+by pointing the environment variables AFL_CC/AFL_CXX to them.
 If the CC/CXX have been overridden, those compilers will be used from
 those wrappers without using AFL_CXX/AFL_CC settings.
+
 Once this is done, you can instrument third-party code in a way similar to the
 standard operating mode of AFL, e.g.: