Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cmd/compile: Unclear guidelines on what files/directories are ignored #20337

Closed
ascandella opened this issue May 12, 2017 · 11 comments
Closed

cmd/compile: Unclear guidelines on what files/directories are ignored #20337

ascandella opened this issue May 12, 2017 · 11 comments
Labels
FrozenDueToAge

Comments

@ascandella
Copy link

Please answer these questions before submitting your issue. Thanks!

What version of Go are you using (go version)?

1.8.1

What operating system and processor architecture are you using (go env)?

darwin x86_64

What did you do?

underscore-test ❯ pwd
/Users/ai/src/go/src/scratch/underscore-test
underscore-test ❯ tree -a
.
├── .dot
│   └── dot.go
├── _underscore
│   └── underscore.go
└── main.go

2 directories, 3 files
underscore-test ❯ cat main.go _underscore/underscore.go .dot/dot.go
package main

import (
        "fmt"
        "scratch/underscore-test/_underscore"

        "scratch/underscore-test/.dot"
)

func main() {
        fmt.Println(underscore.Underscore)
        fmt.Println(dot.Dot)
}
package underscore

// Underscore is the best yo
const Underscore = "_"
package dot

// Dot is a dot
const Dot = "."

What did you expect to see?

I expected a compilation error, given that documentation states that "." and "_" prefixed files will be ignored, however this rule does not seem to apply to directories. I ran into this yesterday with @davecheney, who suggested that I modify golang/dep to skip scanning directories which start with _ or .. Currently we're in a weird situation where files are ignored but directories are not, and I can't find any documentation stating what the source of truth should be. Does golang/dep have the correct behavior, or broken behavior? Will the golang toolchain eventually stop compiling directories that start with . or _?

What did you see instead?

It worked:

underscore-test ❯ go build
underscore-test ❯ echo $?
0
underscore-test ❯ ./underscore-test
_
.
@ascandella ascandella mentioned this issue May 12, 2017
Merged
@dcheney-atlassian
Copy link

dcheney-atlassian commented May 12, 2017 •
edited

Directory and file names that begin with "." or "_" are ignored by the go tool, as are directories named "testdata".

--https://golang.org/cmd/go/#hdr-Description_of_package_lists

@ascandella
Copy link
Author

Ok, so is it a bug that my example code compiles?

@ascandella
Copy link
Author

I guess the underlying question is "is there a difference between things that are ignored by the gotool, and what are valid import paths?". Is that correct?

@dcheney-atlassian
Copy link

I guess the underlying question is "is there a difference between things that are ignored by the go tool, and what are valid import paths?".

yes, there is a difference. Those paths will (probably) not show up in go list ./... but can be imported.

@ascandella
Copy link
Author

Ok, so we can close this issue, and I should change golang/dep to recurse into .-prefixed dirs when scanning what source packages are available.

Thanks!

@ascandella ascandella mentioned this issue May 12, 2017
Closed
@dcheney-atlassian
Copy link

@sectioneight I think you should do the opposite

deadwood(~/src/scratch/underscore-test) % go list ./...
scratch/underscore-test
deadwood(~/src/scratch/underscore-test) % find . -type d 
.
./.dot
./_underscore

@ascandella
Copy link
Author

Sorry, what exactly do you mean by "the opposite"? Change dep or change go?

@davecheney
Copy link
Contributor

davecheney commented May 12, 2017 via email

@ascandella
Copy link
Author

ascandella commented May 12, 2017 •
edited

Ok. In that case dep will fail if a dependency has a package named ".foo" since it doesn't see the source code.

Suggestions? Or am I missing something really obvious.

@davecheney
Copy link
Contributor

davecheney commented May 12, 2017 via email

@sdboyer
Copy link
Member

sdboyer commented May 12, 2017

(we can probably close this and discuss over in the dep issue)

@golang golang locked and limited conversation to collaborators May 12, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@davecheney @sdboyer @ascandella @gopherbot @dcheney-atlassian