From f8d0ffe005b99a7b8eb39acddcc81d5dae5dbe97 Mon Sep 17 00:00:00 2001 From: Dmitry Vyukov Date: Sat, 2 May 2020 12:42:48 +0200 Subject: 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. --- docs/contributing.md | 15 ++++++++++----- docs/executing_syzkaller_programs.md | 2 +- docs/freebsd/README.md | 2 +- docs/linux/external_fuzzing_usb.md | 2 +- docs/netbsd/README.md | 2 +- docs/openbsd/setup.md | 2 +- 6 files changed, 15 insertions(+), 10 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: diff --git a/docs/executing_syzkaller_programs.md b/docs/executing_syzkaller_programs.md index c0aaf0495..70809b8ab 100644 --- a/docs/executing_syzkaller_programs.md +++ b/docs/executing_syzkaller_programs.md @@ -13,7 +13,7 @@ $ export GOPATH=$HOME/gopath 2. Download syzkaller sources: ``` bash -$ go get -u -d github.com/google/syzkaller/... +$ go get -u -d github.com/google/syzkaller/prog ``` 3. Build necessary syzkaller binaries: diff --git a/docs/freebsd/README.md b/docs/freebsd/README.md index 4be874dad..e54cb42b1 100644 --- a/docs/freebsd/README.md +++ b/docs/freebsd/README.md @@ -22,7 +22,7 @@ When using bhyve as the VM backend, a DHCP server must also be installed: ``` To checkout the syzkaller sources, run: ```console -$ go get -u -d github.com/google/syzkaller/... +$ go get -u -d github.com/google/syzkaller/prog ``` and the binaries can be built by running: ```console diff --git a/docs/linux/external_fuzzing_usb.md b/docs/linux/external_fuzzing_usb.md index 7ccae4fe5..884b8021e 100644 --- a/docs/linux/external_fuzzing_usb.md +++ b/docs/linux/external_fuzzing_usb.md @@ -202,7 +202,7 @@ These instructions describe how to set this up on a Raspberry Pi Zero W, but any ``` ``` bash - go get -u -d github.com/google/syzkaller/... + go get -u -d github.com/google/syzkaller/prog cd ~/gopath-1.10.8/src/github.com/google/syzkaller # Put the patch above into ./syzkaller.patch git apply ./syzkaller.patch diff --git a/docs/netbsd/README.md b/docs/netbsd/README.md index 679a4df93..d411de2a7 100644 --- a/docs/netbsd/README.md +++ b/docs/netbsd/README.md @@ -30,7 +30,7 @@ At this point you should have a NetBSD distribution in `$HOME/netbsd/dest`. 2. Clone the syzkaller repository. ```sh - host$ go get -u -d github.com/google/syzkaller/... + host$ go get -u -d github.com/google/syzkaller/prog host$ cd ~/go/src/github.com/google/syzkaller ``` diff --git a/docs/openbsd/setup.md b/docs/openbsd/setup.md index 8998c40d6..eba34571e 100644 --- a/docs/openbsd/setup.md +++ b/docs/openbsd/setup.md @@ -31,7 +31,7 @@ Variables used throughout the instructions: 2. Clone repository: ```sh - $ go get -u -d github.com/google/syzkaller/... + $ go get -u -d github.com/google/syzkaller/prog $ cd ~/go/src/github.com/google/syzkaller $ gmake all ``` -- cgit mrf-deployment