aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.md
diff options
context:
space:
mode:
authorAdam Goska <a@goska.xyz>2022-01-18 14:03:07 -0500
committerDmitry Vyukov <dvyukov@google.com>2022-01-19 09:07:11 +0100
commit0a4cf54d89683dff77317524c754bb668fd16f63 (patch)
tree4906eaaaa7568e73e89e57f3102511441936d998 /docs/contributing.md
parent731a2d2337bad25ba97f688a5f13df7238fdc4f2 (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
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md7
1 files changed, 3 insertions, 4 deletions
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