diff options
| author | Shiyu Sun <sshiyu@google.com> | 2019-11-19 18:24:33 +1100 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2019-11-20 09:54:55 +0100 |
| commit | 8098ea0f3397d5db00e4852b1b29d0958f2189c6 (patch) | |
| tree | d5c03c186fac63fdfaf00e148947ed9358b9595d | |
| parent | 12be8ffc8752da53edae7dd55bce0f6c776e3ebc (diff) | |
docs: update syscall_descriptions.md and contributing.md
Add suggestions for running make install_prerequisites.
| -rw-r--r-- | docs/contributing.md | 1 | ||||
| -rw-r--r-- | docs/syscall_descriptions.md | 5 |
2 files changed, 5 insertions, 1 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 91058be8b..c5122106d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -77,6 +77,7 @@ or `make format`, you may be using Go 1.10 or older. In such case update to Go 1 - First, you need an own git fork of syzkaller repository. Nagivate to [github.com/google/syzkaller](https://github.com/google/syzkaller) and press `Fork` button in the top-right corner of the page. This will create `https://github.com/YOUR_GITHUB_USERNAME/syzkaller` repository. - Checkout main syzkaller repository if you have not already. To work with `go` command the checkout must be under `$GOPATH`. The simplest way to do it is to run `go get github.com/google/syzkaller`, this will checkout the repository in `$GOPATH/src/github.com/google/syzkaller`. +- Remember to `export PATH=$GOPATH/bin:$PATH` if you have not already. - Then add your repository as an additional origin: ```shell diff --git a/docs/syscall_descriptions.md b/docs/syscall_descriptions.md index c00dbe09a..fab11cf7b 100644 --- a/docs/syscall_descriptions.md +++ b/docs/syscall_descriptions.md @@ -81,7 +81,7 @@ Then `make generate` updates generated code and `make` rebuilds binaries.\ Note: `make generate` does not require any kernel sources, native compilers, etc and is pure text processing. Note: `make generate` also updates the SYZ_REVISION under executor/defs.h, which -is required for machine check while running syz-manager. This should be take care +is required for machine check while running syz-manager. This should be taken care of especially if you are trying to rebase with your own change on syscall description. Note: _all_ generated files (`*.const`, `*.go`, `*.h`) are checked-in with the @@ -90,6 +90,9 @@ Note: _all_ generated files (`*.const`, `*.go`, `*.h`) are checked-in with the Note: `make extract` extracts constants for all architectures which requires installed cross-compilers. If you get errors about missing compilers/libraries, try `sudo make install_prerequisites` or install equivalent package for your distro. +Note: `sudo make install_prerequisites` will success even with some package failed to +install, `sudo apt-get update && sudo apt-get upgrade` might be required to make this +more efficient. If you want to fuzz the new subsystem that you described locally, you may find the `enable_syscalls` configuration parameter useful to specifically target |