aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Max Moroz <dor3s1@gmail.com>2017-02-07 17:43:34 +0100
committerGravatar Abhishek Arya <inferno@chromium.org>2017-02-07 08:43:34 -0800
commitb3d93fa7833d52f58b217b5c4f09fec57c9492d6 (patch)
tree5d9dd1cb7833cca9ffda55479f6821fa737ed725
parent137a8ca4c3ae76e4e0e607d325c45fcc54bb22b0 (diff)
[docs] Add more explicit documentation regarding build dependencies. (#360)
-rw-r--r--docs/fuzzer_environment.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/fuzzer_environment.md b/docs/fuzzer_environment.md
index e1164097..2e77dc92 100644
--- a/docs/fuzzer_environment.md
+++ b/docs/fuzzer_environment.md
@@ -7,7 +7,16 @@ Your fuzz targets will be run on a [Google Compute Engine](https://cloud.google.
You should not make any assumptions on the availability of dependent packages
and libraries in the execution environment. Make sure to statically link any
library dependencies with your fuzz target executable during build time
-([example](https://github.com/google/oss-fuzz/blob/master/projects/tor/build.sh#L40)).
+([example](https://github.com/google/oss-fuzz/blob/master/projects/tor/build.sh#L40)).
+
+Please note that it is not required to build all dependecies in
+[build.sh](https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md#buildsh).
+You can install any build dependendcies via
+[Dockerfile](https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md#dockerfile)
+([example](https://github.com/google/oss-fuzz/blob/master/projects/tor/Dockerfile#L19)),
+but make sure that you link statically against them. Those dependecies will be
+available only on a builder machine, not on the ones running the fuzzers.
+
All build artifacts needed during fuzz target execution should be inside `$OUT`
directory. Other directories like `$WORK`, `$SRC` OR dependent packages installed
in build.sh will not be available.