Stowage/go
2
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-12-08 06:10:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

cmd/doc: show the package clause always

Browse source 
If no writes to the package buffer happen, then the package clause
does not get printed. This is a bug for cases where a file just contains
the package clause.

We fix this by separating the printing of package clause to a new
function and calling it from (*pkgBuffer).Write as well as (*Package).flush.

Updates #31457

Change-Id: Ia3bd0ea3963274c460a45d1e37fafc6ee0a197f0
Reviewed-on: https://go-review.googlesource.com/c/go/+/206128
Run-TryBot: Agniva De Sarker <agniva.quicksilver@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
Agniva De Sarker 2019-11-11 21:16:18 +05:30 • committed by Agniva De Sarker
parent 194ae3236d
commit d22b5735e7
3 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/cmd/doc/pkg.go
View file

@ -53,14 +53,18 @@ type pkgBuffer struct {
}
func (pb *pkgBuffer) Write(p []byte) (int, error) {
if !pb.printed && len(p) > 0 {
pb.packageClause()
return pb.Buffer.Write(p)
}
func (pb *pkgBuffer) packageClause() {
if !pb.printed {
pb.printed = true
// Only show package clause for commands if requested explicitly.
if pb.pkg.pkg.Name != "main" || showCmd {
pb.pkg.packageClause()
}
}
return pb.Buffer.Write(p)
}
type PackageError string // type returned by pkg.Fatalf.
@ -210,6 +214,8 @@ func (pkg *Package) Printf(format string, args ...interface{}) {
}
func (pkg *Package) flush() {
// Print the package clause in case it wasn't written already.
pkg.buf.packageClause()
_, err := pkg.writer.Write(pkg.buf.Bytes())
if err != nil {
log.Fatal(err)