diff options
| author | Andrey Konovalov <andreyknvl@google.com> | 2020-05-06 16:53:06 +0200 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2020-05-07 11:26:03 +0200 |
| commit | ec4026808b7fe798de3937f220889403e83611aa (patch) | |
| tree | be2bd668a08082053e02f347cdb9ade86cb6d651 /docs/contributing.md | |
| parent | 4618eb2da0bb479f25c3d0b33a78436971a18946 (diff) | |
docs: move go install instructions to setup.md
Also update go version requirement to 1.13.
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 38 |
1 files changed, 2 insertions, 36 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index da670687d..7ab59d124 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -42,45 +42,11 @@ Extending/improving [system call descriptions](syscall_descriptions.md) is alway Unassigned issues from the [bug tracker](https://github.com/google/syzkaller/issues) are worth doing, but some of them might be complicated. +If you want to contribute code or syscall descriptions, at the very least you need to be able to build and run syzkaller, see the instructions [here](/docs/setup.md). + If you want to work on something non-trivial, please briefly describe it on the [syzkaller@googlegroups.com](https://groups.google.com/forum/#!forum/syzkaller) mailing list first, so that there is agreement on high level approach and no duplication of work between contributors. -## Go - -`syzkaller` is written in [Go](https://golang.org), and `Go 1.11+` -toolchain is required for build. The toolchain can be installed with: - -``` -wget https://dl.google.com/go/go1.14.2.linux-amd64.tar.gz -tar -xf go1.14.2.linux-amd64.tar.gz -mv go goroot -mkdir gopath -export GOPATH=`pwd`/gopath -export GOROOT=`pwd`/goroot -export PATH=$GOPATH/bin:$PATH -export PATH=$GOROOT/bin:$PATH -``` - -Then get and build `syzkaller`: - -``` bash -go get -u -d github.com/google/syzkaller/prog -cd gopath/src/github.com/google/syzkaller/ -make -``` - -As the result compiled binaries should appear in the `bin/` dir. - -Also see [Go Getting Started](https://golang.org/doc/install) for more details. - -Note: if you want to do cross-OS/arch testing, you need to specify `TARGETOS`, -`TARGETVMARCH` and `TARGETARCH` arguments to `make`. See the [Makefile](/Makefile) for details. - -Note: older versions of Go toolchain formatted code in a slightly -[different way](https://github.com/golang/go/issues/25161). -So if you are seeing unrelated code formatting diffs after running `make generate` -or `make format`, you may be using `Go 1.10` or older. In such case update to `Go 1.11+`. - ## How to create a pull request - First, you need an own git fork of syzkaller repository. Nagivate to |