CONTRIBUTING.md: Instructions to get the source code should be updated for new version of Go

[mhansen]

What operating system and processor architecture are you using?

Google's defualt workstation golang binary:

$ uname -a
Linux markhansen.syd.corp.google.com 5.10.40-1rodete2-amd64 #1 SMP Debian 5.10.40-1rodete2 (2021-06-22) x86_64 GNU/Linux
$ which go
/usr/lib/google-golang/bin/go
$ go version
go version devel +b7a85e0003 linux/amd64

What did you do?

Followed steps in CONTRIBUTING.md to get the source code. My GOPATH is empty and defaults to ~/go (so I think you could maybe remove that bit of the CONTRIBUTING.md too?)

$ echo $GOPATH

$ go get github.com/google/pprof
go get: installing executables with 'go get' in module mode is deprecated.
        Use 'go install pkg@version' instead.
        For more information, see https://golang.org/doc/go-get-install-deprecation
        or run 'go help get' or 'go help install'.
# net
cgo: C compiler "clang" not found: exec: "clang": executable file not found in $PATH
# crypto/internal/boring
cgo: C compiler "clang" not found: exec: "clang": executable file not found in $PATH

I have some errors due to the new changes around go modules.

Then running the commands to run the tests:

$ cd $GOPATH/src/github.com/google/pprof
$ go test -v ./...

I tried going into ~/go/src/ but there is no src dir, only ~/go/bin/ and ~/go/pkg/. The code seems to be in pkg/mod:

$ ls ~/go/pkg/mod/github.com/google
'[email protected]'/  '[email protected]'/

What did you expect to see?

No errors, and able to run the tests with instructions given.

What did you see instead?

Errors and the tests weren't in the directory given.

[mhansen]

(this isn't particularly blocking me -- I'll just clone the repo -- but thought I'd file the bug in case this is affecting new contributors)

[chavey]

Mark,

Are you using a go version >= 1.8?

for go version < 1.8, GOPATH needs to be set for go get github.com/foo/bar to check out the github.com/foo/bar repo. Setting the GOPATH is required.

for go version >= 1.18 this is not require as by default GOPATH is set to $HOME/go.

In your case, if you are using a go version >= 1.8 and did not set GOPATH, you should have a check out of the repo under $HOME/go/src/github.com/google/pprof.
I you are using a go version < 1.8, you will not have a src directory.

The code that you see in ~/go/pkg/mod/github.com/google/[email protected]/ is not the checkout repo (it does not have a .git directory). The directory is set to readonly/execute.

[mhansen]

Pretty sure the go version I’m using is above 1.18 (check with the hash above) but the go on google workstations is pretty fresh

you should have a check out of the repo under $HOME/go/src/github.com/google/pprof

I git clone’d the pprof repo into ~/projects/pprof. Perhaps this is the problem? This is usually what I do with git clones of forks of github projects.

…

On Thu, 7 Oct 2021 at 17:17, chavey ***@***.***> wrote: Mark, Are you using a go version >= 1.18? for go version < 1.18, GOPATH needs to be set for go get github.com/foo/bar to check out the github.com/foo/bar repo. Setting the GOPATH is required. for go version >= 1.18 this is not require as by default GOPATH is set to $HOME/go. In your case, if you are using a go version >= 1.18 and did not set GOPATH, you should have a check out of the repo under $HOME/go/src/ github.com/google/pprof. I you are using a go version < 1.18, you will not have a src directory. The code that you see in ~/go/pkg/mod/ ***@***.***/ is not the checkout repo (it does not have a .git directory). The directory is set to readonly/execute. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#648 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAZYOKQIIQPYGKE4RXU62TUFU3OFANCNFSM5EQDGQKA> .

[mhansen]

Actually, let me check when I'm at my workstation tomorrow, the above is off-the-cuff and may be wrong.

[mhansen]

for go version < 1.18, GOPATH needs to be set

Is 1.18 a typo? I thought GOPATH was only required before Go 1.8? https://rakyll.org/default-gopath/

[mhansen]

Let me maybe be a bit clearer on what I'm asking:

• I think instead of saying go get github.com/google/pprof perhaps it should say go install github.com/google/pprof@latest because you're installing a binary rather than just getting a package, to silence that deprecation warning.
• I think GOPATH has been implicit since Go 1.8, which is pretty ancient now (from 2016) so you might be able to remove the GOPATH stuff from your guide?

[aalexand]

Hmm, I am not sure go install github.com/google/pprof@latest works that well for the development case, as I think it will download the sources into a versioned directory under ~/go/pkg/ ?

[mhansen]

Looking in the output of 'go help get' looks like maybe we want `go get -d ***@***.***`, that says not to build or install packages.

…

On Fri, 8 Oct 2021 at 20:32, Alexey Alexandrov ***@***.***> wrote: Hmm, I am not sure go install ***@***.*** works that well for the development case, as I think it will download the sources into a versioned directory under ~/go/pkg/ ? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[aalexand]

I think with Go modules it can actually be just

$ cd $(mktemp -d)

$ git clone [email protected]:google/pprof.git
Cloning into 'pprof'...
Bremote: Enumerating objects: 3429, done.
remote: Counting objects: 100% (158/158), done.
remote: Compressing objects: 100% (108/108), done.
remote: Total 3429 (delta 66), reused 103 (delta 44), pack-reused 3271
Receiving objects: 100% (3429/3429), 2.95 MiB | 5.93 MiB/s, done.
Resolving deltas: 100% (2257/2257), done.

$ cd pprof
/tmp/tmp.d4vkfHmtp6/pprof

$ go test -v ./...
go: downloading github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639
go: downloading github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e
?   	github.com/google/pprof	[no test files]
?   	github.com/google/pprof/driver	[no test files]
=== RUN   TestParseData
--- PASS: TestParseData (0.00s)
PASS
...
...

[mhansen]

Yeah, to be honest I always just `git clone` rather than `go get` when I'm developing a project (I like having my edited-projects in a "projects" directory separate from the mostly-read-only ~/go/src), so Alexey's suggestion would work for me.

…

On Fri, 8 Oct 2021 at 20:53, Alexey Alexandrov ***@***.***> wrote: I think with Go modules it can actually be just $ cd $(mktemp -d) $ git clone ***@***.***:google/pprof.git Cloning into 'pprof'... Bremote: Enumerating objects: 3429, done. remote: Counting objects: 100% (158/158), done. remote: Compressing objects: 100% (108/108), done. remote: Total 3429 (delta 66), reused 103 (delta 44), pack-reused 3271 Receiving objects: 100% (3429/3429), 2.95 MiB | 5.93 MiB/s, done. Resolving deltas: 100% (2257/2257), done. $ cd pprof /tmp/tmp.d4vkfHmtp6/pprof $ go test -v ./... go: downloading github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639 go: downloading github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e ? github.com/google/pprof [no test files] ? github.com/google/pprof/driver [no test files] === RUN TestParseData --- PASS: TestParseData (0.00s) PASS ... ... — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#648 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAZYOJKA7O7ZILMZEWSLB3UF25RBANCNFSM5EQDGQKA> .

[chavey]

for go version < 1.18, GOPATH needs to be set

Is 1.18 a typo? I thought GOPATH was only required before Go 1.8? rakyll.org/default-gopath

Yes, sorry for the typo, it should read 1.8. (https://golang.org/doc/go1.8#gopath)

[mhansen]

Right, yeah, I'm definitely using some version > 1.8. My version is an in-development version between 1.17 and 1.18.

…

On Sat, 9 Oct 2021 at 08:41, chavey ***@***.***> wrote: for go version < 1.18, GOPATH needs to be set Is 1.18 a typo? I thought GOPATH was only required before Go 1.8? rakyll.org/default-gopath Yes, sorry for the typo, it should read 1.8. (https://golang.org/doc/go1.8#gopath) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[chavey]

This older thread about 'go get' golang/go#31529 (comment), suggests using git clone.

$ cd /tmp
$ git clone [email protected]:google/pprof.git
$ cd /tmp/pprof
$ go install # to get all dependencies as specified by go.mod

[chavey]

Should we had a section about using git clone OR are we ok with the current documentation?

[aalexand]

Since go get is deprecated for installing things, we should replace the go get usage in both README.md and CONTRIBUTING.md with the git clone based flow.