x/pkgsite/cmd/pkgsite: document ignored items #65198
Labels
Milestone
Comments
|
I think this is it: // ignoredByGoTool reports whether the given import path corresponds
// to a directory that would be ignored by the go tool.
//
// The logic of the go tool for ignoring directories is documented at
// https://golang.org/cmd/go/#hdr-Package_lists_and_patterns:
//
// Directory and file names that begin with "." or "_" are ignored
// by the go tool, as are directories named "testdata".
//
// However, even though `go list` and other commands that take package
// wildcards will ignore these, they can still be imported and used in
// working Go programs. We continue to ignore the "." and "testdata"
// cases, but we've seen valid Go packages with "_", so we accept those. |
|
This is documented at https://pkg.go.dev/cmd/go#hdr-Package_lists_and_patterns. The pkgsite tool is treating files the way that the go tool does, so that they are both consistent. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Proposal Details
it seems currently items ignored by the
pkgsitetool are not documented. I did this search:here:
https://cs.opensource.google/go
from my own testing, a folder like this is built and indexed:
a folder like this is built, but optionally indexed:
and these are not built or indexed:
The text was updated successfully, but these errors were encountered: