Rooba
/
oss-fuzz
mirror of https://github.com/google/oss-fuzz.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[docs] Add note about running /bin/bash in container for new_library.md

This commit is contained in:
Oliver Chang 2016-09-29 13:02:03 -07:00
parent 9d94f2bec5
commit eabd27ae77
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/new_library.md
View File

@ -40,7 +40,7 @@ This is the Docker image definition that build.sh will be executed in.
It is very simple for most libraries:
```bash
FROM ossfuzz/base-libfuzzer # base image with clang toolchain
MAINTAINER YOUR_EMAL # each file should have a maintainer
MAINTAINER YOUR_EMAIL # each file should have a maintainer
RUN apt-get install -y ... # install required packages to build a project
CMD /src/oss-fuzz/LIB_NAME/build.sh # specify build script for the project.
```
@ -183,6 +183,16 @@ $ python scripts/helper.py run_fuzzer $LIB_NAME name_of_a_fuzzer
If everything works locally, then it should also work on our automated builders
and ClusterFuzz.
### Debugging build scripts
While developing your build script, it may be useful to run bash within the
container:
```bash
$ python scripts/helper.py shell $LIB_NAME # runs /bin/bash within container
$ bash /src/oss-fuzz/$LIB_NAME/build.sh # to run the build script manually
```
## Checking in to oss-fuzz repository
Fork oss-fuzz, commit and push to the fork, and then create a pull request with