diff options
| author | Dmitry Vyukov <dvyukov@google.com> | 2020-05-02 12:42:48 +0200 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2020-05-02 14:12:25 +0200 |
| commit | f8d0ffe005b99a7b8eb39acddcc81d5dae5dbe97 (patch) | |
| tree | cb86e2a4140c0d85f61ce3322b1bd0aad94fe9c5 /docs/contributing.md | |
| parent | 4d9915573a3ebf4deb1078af0f00c060c5966f02 (diff) | |
docs: update source download instructions
Since we don't don't have auto-generated files checked-in,
go get fails to parse packages.
go get only prog package without building,
this will checkout the whole repo anyway
and that's the only thing we need.
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 9e3a14dd3..da670687d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -51,8 +51,8 @@ so that there is agreement on high level approach and no duplication of work bet toolchain is required for build. The toolchain can be installed with: ``` -wget https://dl.google.com/go/go1.13.8.linux-amd64.tar.gz -tar -xf go1.13.8.linux-amd64.tar.gz +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 @@ -64,7 +64,7 @@ export PATH=$GOROOT/bin:$PATH Then get and build `syzkaller`: ``` bash -go get -u -d github.com/google/syzkaller/... +go get -u -d github.com/google/syzkaller/prog cd gopath/src/github.com/google/syzkaller/ make ``` @@ -83,8 +83,13 @@ or `make format`, you may be using `Go 1.10` or older. In such case update to `G ## How to create a pull request -- 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 -u -d github.com/google/syzkaller/...`, this will checkout the repository in `$GOPATH/src/github.com/google/syzkaller`. +- 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 -u -d github.com/google/syzkaller/prog`, 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: |