diff options
| author | Adam Goska <a@goska.xyz> | 2022-01-18 14:03:07 -0500 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2022-01-19 09:07:11 +0100 |
| commit | 0a4cf54d89683dff77317524c754bb668fd16f63 (patch) | |
| tree | 4906eaaaa7568e73e89e57f3102511441936d998 | |
| parent | 731a2d2337bad25ba97f688a5f13df7238fdc4f2 (diff) | |
/docs: update instructions for source checkout
Updated documentation regarding source code checkout from the legacy gopath
mode 'go get' to 'git clone'.
Fixes #2828
| -rw-r--r-- | CONTRIBUTORS | 1 | ||||
| -rw-r--r-- | docs/contributing.md | 7 | ||||
| -rw-r--r-- | docs/darwin/README.md | 5 | ||||
| -rw-r--r-- | docs/executing_syzkaller_programs.md | 4 | ||||
| -rw-r--r-- | docs/freebsd/README.md | 4 | ||||
| -rw-r--r-- | docs/linux/external_fuzzing_usb.md | 4 | ||||
| -rw-r--r-- | docs/linux/setup.md | 4 | ||||
| -rw-r--r-- | docs/netbsd/README.md | 4 | ||||
| -rw-r--r-- | docs/openbsd/setup.md | 4 |
9 files changed, 18 insertions, 19 deletions
diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 040cad028..0d1857f40 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -101,3 +101,4 @@ Pavel Skripkin Linaro Lee Jones Sabyrzhan Tasbolatov +Adam Goska diff --git a/docs/contributing.md b/docs/contributing.md index 0ab1c07fa..fa60d0b16 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -85,14 +85,13 @@ in the same commit. [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`. +- Checkout main syzkaller repository if you have not already. The simplest way to do it is to run `git clone https://github.com/google/syzkaller`, this will checkout +the repository in the current working directory. - Remember to `export PATH=$GOPATH/bin:$PATH` if you have not already. - Then add your repository as an additional origin: ```shell - cd $GOPATH/src/github.com/google/syzkaller + cd syzkaller git remote add my-origin https://github.com/YOUR_GITHUB_USERNAME/syzkaller.git git fetch my-origin git checkout -b my-branch my-origin/master diff --git a/docs/darwin/README.md b/docs/darwin/README.md index d6d5cde0c..1680ff7e7 100644 --- a/docs/darwin/README.md +++ b/docs/darwin/README.md @@ -218,12 +218,11 @@ Shut down your VM now. We'll let syzkaller boot it back up soon. ``` export GOPATH=/Users/user/go export PATH=$GOPATH/bin:$PATH -export GO111MODULE=off ``` - Relogin and build syzkaller like this: ``` -go get -u -d github.com/google/syzkaller/prog -cd go/src/github.com/google/syzkaller +git clone https://github.com/google/syzkaller +cd syzkaller make HOSTOS=darwin HOSTARCH=amd64 TARGETOS=darwin TARGETARCH=amd64 SOURCEDIR=/Users/user/115/src/Users/user/kernel/xnu-7195.141.2 ``` diff --git a/docs/executing_syzkaller_programs.md b/docs/executing_syzkaller_programs.md index f06f01c86..a6911d270 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 -GO111MODULE=off go get -u -d github.com/google/syzkaller/prog +git clone https://github.com/google/syzkaller ``` Note that your syzkaller revision must be the same as the one that generated the @@ -21,7 +21,7 @@ program you're trying to execute. 3. Build necessary syzkaller binaries: ``` bash -cd $GOPATH/src/github.com/google/syzkaller +cd syzkaller make ``` diff --git a/docs/freebsd/README.md b/docs/freebsd/README.md index fa77db67b..fb28ca37d 100644 --- a/docs/freebsd/README.md +++ b/docs/freebsd/README.md @@ -22,11 +22,11 @@ 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/prog +$ git clone https://github.com/google/syzkaller ``` and the binaries can be built by running: ```console -$ cd go/src/github.com/google/syzkaller/ +$ cd syzkaller $ gmake ``` diff --git a/docs/linux/external_fuzzing_usb.md b/docs/linux/external_fuzzing_usb.md index 43301fa46..9667f2eaf 100644 --- a/docs/linux/external_fuzzing_usb.md +++ b/docs/linux/external_fuzzing_usb.md @@ -154,8 +154,8 @@ index 451b2a7b..64af45c7 100644 ``` ``` bash -go get -u -d github.com/google/syzkaller/prog -cd ~/gopath/src/github.com/google/syzkaller +git clone https://github.com/google/syzkaller +cd syzkaller # Put the patch above into ./syzkaller.patch git apply ./syzkaller.patch make executor diff --git a/docs/linux/setup.md b/docs/linux/setup.md index a23a6a74e..5f3c12727 100644 --- a/docs/linux/setup.md +++ b/docs/linux/setup.md @@ -47,8 +47,8 @@ See [Go: Download and install](https://golang.org/doc/install) for other options To download and build `syzkaller`: ``` bash -go get -u -d github.com/google/syzkaller/prog -cd gopath/src/github.com/google/syzkaller/ +git clone https://github.com/google/syzkaller +cd syzkaller make ``` diff --git a/docs/netbsd/README.md b/docs/netbsd/README.md index fc9c2d821..c59f02ed4 100644 --- a/docs/netbsd/README.md +++ b/docs/netbsd/README.md @@ -30,8 +30,8 @@ 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/prog - host$ cd ~/go/src/github.com/google/syzkaller + host$ git clone https://github.com/google/syzkaller + host$ cd syzkaller ``` 3. Compile syzkaller for NetBSD. diff --git a/docs/openbsd/setup.md b/docs/openbsd/setup.md index eba34571e..fe6fe4a6f 100644 --- a/docs/openbsd/setup.md +++ b/docs/openbsd/setup.md @@ -31,8 +31,8 @@ Variables used throughout the instructions: 2. Clone repository: ```sh - $ go get -u -d github.com/google/syzkaller/prog - $ cd ~/go/src/github.com/google/syzkaller + $ git clone https://github.com/google/syzkaller + $ cd syzkaller $ gmake all ``` |
