]> Cypherpunks repositories - gostls13.git/commit
go/build: correct value of .Doc field
authorjimmyfrasche <soapboxcicero@gmail.com>
Sat, 24 Feb 2018 23:03:58 +0000 (15:03 -0800)
committerIan Lance Taylor <iant@golang.org>
Wed, 7 Mar 2018 14:35:52 +0000 (14:35 +0000)
commit20b14b71df6aaf044d3e78920a5f56bc20dd2a49
tree767d2499e609fa6abba458fe156ece119b2e4cc2
parentee465831eccef9d8380a0cbfbb526684399d35eb
go/build: correct value of .Doc field

Build could use the package comment from test files to populate the .Doc
field on *Package.

As go list uses this data and several packages in the standard library
have tests with package comments, this lead to:

$ go list -f '{{.Doc}}' flag container/heap image
These examples demonstrate more intricate uses of the flag package.
This example demonstrates an integer heap built using the heap interface.
This example demonstrates decoding a JPEG image and examining its pixels.

This change now only examines non-test files when attempting to populate
.Doc, resulting in the expected behavior:

$ gotip list -f '{{.Doc}}' flag container/heap image
Package flag implements command-line flag parsing.
Package heap provides heap operations for any type that implements heap.Interface.
Package image implements a basic 2-D image library.

Fixes #23594

Change-Id: I37171c26ec5cc573efd273556a05223c6f675968
Reviewed-on: https://go-review.googlesource.com/96976
Run-TryBot: Daniel Martí <mvdan@mvdan.cc>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
src/go/build/build.go
src/go/build/build_test.go
src/go/build/testdata/doc/a_test.go [new file with mode: 0644]
src/go/build/testdata/doc/b_test.go [new file with mode: 0644]
src/go/build/testdata/doc/c_test.go [new file with mode: 0644]
src/go/build/testdata/doc/d_test.go [new file with mode: 0644]
src/go/build/testdata/doc/e.go [new file with mode: 0644]
src/go/build/testdata/doc/f.go [new file with mode: 0644]