x/tools/gopls: don't rename documentation in compiler directive comments

[zikaeroh]

What did you do?

I'm testing out the new embed package. I wrote:

//go:embed static/*
var static embed.FS

Then I went to rename the variable to export it to test somewhere else.

What did you expect to see?

The variable is renamed; the comment is left unmodified.

What did you see instead?

I'm left with:

//go:embed Static/*
var Static embed.FS

(Any name works, static -> static2 works just the same.)

Build info

golang.org/x/tools/gopls master
    golang.org/x/tools/gopls@(devel)
    github.com/BurntSushi/[email protected] h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
    github.com/google/[email protected] h1:JFrFEBb2xKufg6XkJsJr+WbKb4FQlURi5RUcBveYu9k=
    github.com/sergi/[email protected] h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0=
    golang.org/x/[email protected] h1:RM4zey1++hCTbCVQfnWeKs9/IEsaBLA8vTkd0WVtmH4=
    golang.org/x/[email protected] h1:SQFwaSi55rU7vdNs9Yr0Z324VNlrF+0wMqRXT4St8ck=
    golang.org/x/[email protected] => ../
    golang.org/x/[email protected] h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
    honnef.co/go/[email protected] h1:W18jzjh8mfPez+AwGLxmOImucz/IFjpNlrKVnaj2YVc=
    mvdan.cc/[email protected] h1:z+/YqapuV7VZPvBb3GYmuEJbA88M3PFUxaHilHYVCpQ=
    mvdan.cc/xurls/[email protected] h1:NSZPykBXJFCetGZykLAxaL6SIpvbVy/UFEniIfHAa8A=

[stamblerre]

This is the logic in rename that is meant to update doc comments.
I'm not familiar with the embed package--is there any case when you would want the rename to update the comment?

[zikaeroh]

See #41191. These are file paths/globs on disk that are embedded at compile time into the binary.

[zikaeroh]

I don't think there's a reason to do any renames in a //go:embed comment, though I'd almost argue that any compiler directive should be ignored for renames. // +build comments are getting deprecated in favor of //go:build, so that might cause oddities if you accidentally rename a build tag that's the same as a variable name.

[stamblerre]

Thanks! It does sound like we can skip renaming in any comment that starts with //go:.

[zikaeroh]

I would suggest matching the pattern given in #37974 / CL 224737, which is how go doc determines which comment lines to ignore. (See "isDirective")

[stamblerre]

Thank you for linking that--will do!

[gopherbot]

Change https://golang.org/cl/267121 mentions this issue: internal/lsp: do not rename in compiler directive comments