aboutsummaryrefslogtreecommitdiff
path: root/docs/getting-started
diff options
context:
space:
mode:
authorCatena cyber <35799796+catenacyber@users.noreply.github.com>2020-11-25 16:40:15 +0100
committerGitHub <noreply@github.com>2020-11-25 07:40:15 -0800
commit6c9bd20f5448fda49649386b32d981e5428e3fe4 (patch)
tree7f3a4b88c2d529601fe381888d24ca8a1d09f19a /docs/getting-started
parentd126898bde76a9c2b2306720b5f36991e911eb87 (diff)
downloadoss-fuzz-6c9bd20f5448fda49649386b32d981e5428e3fe4.tar.gz
Golang modules documentation (#4711)
* Clones golang-protobuf into the expected directory * Improves the documentation for golang projects with modules
Diffstat (limited to 'docs/getting-started')
-rw-r--r--docs/getting-started/new-project-guide/go_lang.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/getting-started/new-project-guide/go_lang.md b/docs/getting-started/new-project-guide/go_lang.md
index 94ab41707..62fde91d6 100644
--- a/docs/getting-started/new-project-guide/go_lang.md
+++ b/docs/getting-started/new-project-guide/go_lang.md
@@ -69,6 +69,13 @@ your Dockerfile.
RUN go get github.com/ianlancetaylor/demangle
```
+In the case you are using modules, the best practice is to `git clone` the repository into the expected `$GOPATH/src` directory.
+
+A usage example from go-coredns project is
+```dockerfile
+RUN git clone --depth 1 https://github.com/coredns/coredns $GOPATH/src/github.com/coredns/coredns
+```
+
### build.sh
In order to build a Go fuzz target, you need to call `go-fuzz`