aboutsummaryrefslogtreecommitdiff
path: root/docs/getting-started
diff options
context:
space:
mode:
authorvan Hauser <vh@thc.org>2021-03-22 02:56:53 +0100
committerGitHub <noreply@github.com>2021-03-21 18:56:53 -0700
commitc0d989a5f419afc5f7461cf688e4280b57b0da44 (patch)
tree03b734c6ca05a128aa89341659903bc129fed241 /docs/getting-started
parent812b837d6b67322d78a9f46aab59b4af4c643ea1 (diff)
downloadoss-fuzz-c0d989a5f419afc5f7461cf688e4280b57b0da44.tar.gz
update documenation (#5462)
* output afl++ setup * update commit id * update afl++ commit id * asan + cmplog fix * update commit id * update and enhance afl++ * update afl++ commit id, better run asan options * fix linter * add debug_afl script * Update debug_afl * Update compile_afl * fix for karchive * put debug_afl in the docker container * asan poison fix * fix asan settings for zeek * update afl++ commit id * fix * update afl++ commit id * final touches * remove map size * remove old comment * llvm 13 fix * enhance documentation * fix capstone build.sh * update doc Co-authored-by: jonathanmetzman <31354670+jonathanmetzman@users.noreply.github.com>
Diffstat (limited to 'docs/getting-started')
-rw-r--r--docs/getting-started/new_project_guide.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/getting-started/new_project_guide.md b/docs/getting-started/new_project_guide.md
index d42db11a3..0ffba8f96 100644
--- a/docs/getting-started/new_project_guide.md
+++ b/docs/getting-started/new_project_guide.md
@@ -246,6 +246,30 @@ If your project is written in Go, check out the [Integrating a Go project]({{ si
alphanumeric characters, underscore(_) or dash(-). Otherwise, they won't run on our infrastructure.
3. Don't remove source code files. They are needed for code coverage.
+### Temporarily disabling code instrumentation during builds
+
+Sometimes not every 3rd party library might be needed to be instrumented or
+tools are being compiled that just support the target built.
+
+If for any reasons part of the build process should not be instrumented
+then the following code snippit can be used for this:
+
+```
+CFLAGS_SAVE="$CFLAGS"
+CXXFLAGS_SAVE="$CXXFLAGS"
+unset CFLAGS
+unset CXXFLAGS
+export AFL_NOOPT=1
+
+#
+# build commands here that should not result in instrumented code.
+#
+
+export CFLAGS="${CFLAGS_SAVE}"
+export CXXFLAGS="${CXXFLAGS_SAVE}"
+unset AFL_NOOPT
+```
+
### build.sh script environment
When your build.sh script is executed, the following locations are available within the image: