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

[docs] Some clarifications.

This commit is contained in:
Oliver Chang 2016-09-01 11:39:23 -07:00
parent 6e85c5c079
commit 5527f7a198
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/new_library.md
View File

@ -6,14 +6,14 @@ library go into <https://github.com/google/oss-fuzz/tree/master/expat>.
## Prerequisites ## Prerequisites
Install Docker. [Install Docker].
If you're not familiar with how building libFuzzer-style fuzzers work in If you're not familiar with how building libFuzzer-style fuzzers work in
general, check out [this page](http://llvm.org/docs/LibFuzzer.html). general, check out [this page](http://llvm.org/docs/LibFuzzer.html).
## Library directories ## Library directories
At a minimum, a library directory requires 3 files: A library directory requires 3 files:
* Jenkinsfile * Jenkinsfile
* Dockerfile * Dockerfile
@ -25,7 +25,8 @@ This file will be largely the same for most libraries. For expat, this is:
``` ```
def libfuzzerBuild = fileLoader.fromGit('infra/libfuzzer-pipeline.groovy', def libfuzzerBuild = fileLoader.fromGit('infra/libfuzzer-pipeline.groovy',
'https://github.com/google/oss-fuzz.git', 'master', null, '') 'https://github.com/google/oss-fuzz.git',
'master', null, '')
libfuzzerBuild { libfuzzerBuild {
git = "git://git.code.sf.net/p/expat/code_git" git = "git://git.code.sf.net/p/expat/code_git"
@ -145,7 +146,10 @@ the oss-fuzz repo.
```bash ```bash
$ mkdir ~/src; cd ~/src $ mkdir ~/src; cd ~/src
$ git clone https://github.com/google/oss-fuzz $ git clone https://github.com/google/oss-fuzz
# (also checkout upstream library) # Also checkout upstream library, make sure the directory name is the same
# as $LIB_NAME.k
# For expat:
# git clone git://git.code.sf.net/p/expat/code_git expat"
$ cd oss-fuzz $ cd oss-fuzz
# (patch in your changes to oss-fuzz ) # (patch in your changes to oss-fuzz )
@ -201,3 +205,4 @@ ClusterFuzz after a short while!
[oss-fuzz repo]: https://github.com/google/oss-fuzz [oss-fuzz repo]: https://github.com/google/oss-fuzz
[dictionaries]: http://llvm.org/docs/LibFuzzer.html#dictionaries [dictionaries]: http://llvm.org/docs/LibFuzzer.html#dictionaries
[Install Docker]: https://docs.docker.com/engine/installation/linux/ubuntulinux/