From efe15ead8a113c79e352b6aca9b2d4a89a6cc38e Mon Sep 17 00:00:00 2001 From: inferno-chromium Date: Wed, 30 Nov 2016 08:25:49 -0800 Subject: [PATCH] Update new_project_guide.md --- docs/new_project_guide.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/new_project_guide.md b/docs/new_project_guide.md index 6ad4883c8..ba5c76e67 100644 --- a/docs/new_project_guide.md +++ b/docs/new_project_guide.md @@ -88,9 +88,10 @@ When build.sh script is executed, the following locations are available within t | Path | Description | ------ | ----- -| `$OUT` | Output directory containing fuzz targets, dictionary files, options files, seed corpus archives. -| `$SRC/` | Source code needed to build your project. -| `/usr/lib/libfuzzer.a` | Prebuilt libFuzzer library that needs to be linked into all fuzz targets (`-lfuzzer`). +| `/out/` (`$OUT`) | Directory to store build artifacts (fuzz targets, dictionaries, options files, seed corpus archives). +| `/src/` (`$SRC`) | Directory to checkout source files. +| `/work/`(`$WORK`) | Directory for storing intermediate files | +| `/usr/lib/libfuzzer.a` | Location of prebuilt libFuzzer library that needs to be linked into all fuzz targets (`-lfuzzer`). You *must* use the special compiler flags needed to build your project and fuzz targets. These flags are provided in the following environment variables: @@ -152,9 +153,7 @@ custom options by creating a `my_fuzzer.options` file next to a `my_fuzzer` exec max_len = 1024 ``` -[List of available options](http://llvm.org/docs/LibFuzzer.html#options) - -At least, `max_len` is highly recommended. +[List of available options](http://llvm.org/docs/LibFuzzer.html#options). Use of `max_len` is highly recommended. For out of tree fuzz targets, you will likely add options file using docker's `COPY` directive and will copy it into output in build script.