close_issue_1
/
tools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

go/packages: update documentation for Package.Types and Package.Syntax 

so that they don't refer to the deprecated LoadX LoadModes

Also break apart the NeedX from the LoadX fields so that the needX fields
are rendered in the godoc next to the definition of LoadMode

Fixes golang/go#32364

Change-Id: Ic8837950a5e25937c556b62fbedbd8dc5356cfdb
Reviewed-on: https://go-review.googlesource.com/c/tools/+/179741
Run-TryBot: Michael Matloob <matloob@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Dominik Honnef <dominik@honnef.co>
This commit is contained in:
Michael Matloob 2019-05-31 11:34:40 -04:00
parent 75312fb067
commit b3315ee88b
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
go/packages/packages.go
View File

@ -66,7 +66,9 @@ const (
// NeedTypesSizes adds TypesSizes. // NeedTypesSizes adds TypesSizes.
NeedTypesSizes NeedTypesSizes
)
const (
// Deprecated: LoadFiles exists for historical compatibility // Deprecated: LoadFiles exists for historical compatibility
// and should not be used. Please directly specify the needed fields using the Need values. // and should not be used. Please directly specify the needed fields using the Need values.
LoadFiles = NeedName | NeedFiles | NeedCompiledGoFiles LoadFiles = NeedName | NeedFiles | NeedCompiledGoFiles
@ -259,9 +261,9 @@ type Package struct {
Imports map[string]*Package Imports map[string]*Package
// Types provides type information for the package. // Types provides type information for the package.
// Modes LoadTypes and above set this field for packages matching the // The NeedTypes LoadMode bit sets this field for packages matching the
// patterns; type information for dependencies may be missing or incomplete. // patterns; type information for dependencies may be missing or incomplete,
// Mode LoadAllSyntax sets this field for all packages, including dependencies. // unless NeedDeps and NeedImports are also set.
Types *types.Package Types *types.Package
// Fset provides position information for Types, TypesInfo, and Syntax. // Fset provides position information for Types, TypesInfo, and Syntax.
@ -274,8 +276,9 @@ type Package struct {
// Syntax is the package's syntax trees, for the files listed in CompiledGoFiles. // Syntax is the package's syntax trees, for the files listed in CompiledGoFiles.
// //
// Mode LoadSyntax sets this field for packages matching the patterns. // The NeedSyntax LoadMode bit populates this field for packages matching the patterns.
// Mode LoadAllSyntax sets this field for all packages, including dependencies. // If NeedDeps and NeedImports are also set, this field will also be populated
// for dependencies.
Syntax []*ast.File Syntax []*ast.File
// TypesInfo provides type information about the package's syntax trees. // TypesInfo provides type information about the package's syntax trees.
@ -428,7 +431,7 @@ func newLoader(cfg *Config) *loader {
ld.Config = *cfg ld.Config = *cfg
} }
if ld.Config.Mode == 0 { if ld.Config.Mode == 0 {
ld.Config.Mode = LoadFiles // Preserve zero behavior of Mode for backwards compatibility. ld.Config.Mode = NeedName | NeedFiles | NeedCompiledGoFiles // Preserve zero behavior of Mode for backwards compatibility.
} }
if ld.Config.Env == nil { if ld.Config.Env == nil {
ld.Config.Env = os.Environ() ld.Config.Env = os.Environ()
@ -671,7 +674,7 @@ func (ld *loader) loadRecursive(lpkg *loaderPackage) {
// loadPackage loads the specified package. // loadPackage loads the specified package.
// It must be called only once per Package, // It must be called only once per Package,
// after immediate dependencies are loaded. // after immediate dependencies are loaded.
// Precondition: ld.Mode >= LoadTypes. // Precondition: ld.Mode & NeedTypes.
func (ld *loader) loadPackage(lpkg *loaderPackage) { func (ld *loader) loadPackage(lpkg *loaderPackage) {
if lpkg.PkgPath == "unsafe" { if lpkg.PkgPath == "unsafe" {
// Fill in the blanks to avoid surprises. // Fill in the blanks to avoid surprises.