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: don't print a declaration twice

Browse source 
That can occur if we have -u set and there is an upper- and lower-case
name of the same spelling in a single declaration.

A rare corner case but easy to fix.

Fix by remembering what we've printed.

Fixes #21797.

Change-Id: Ie0b681ae8c277fa16e9635ba594c1dff272b8aeb
Reviewed-on: https://go-review.googlesource.com/78715
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
This commit is contained in:
Rob Pike 2017-11-20 14:12:43 +11:00
parent 363a5da3b8
commit 337f04bd6c
3 changed files with 25 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -594,6 +594,11 @@ func (pkg *Package) symbolDoc(symbol string) bool {
// Constants and variables behave the same.
values := pkg.findValues(symbol, pkg.doc.Consts)
values = append(values, pkg.findValues(symbol, pkg.doc.Vars)...)
// A declaration like
// const ( c = 1; C = 2 )
// could be printed twice if the -u flag is set, as it matches twice.
// So we remember which declarations we've printed to avoid duplication.
printed := make(map[*ast.GenDecl]bool)
for _, value := range values {
// Print each spec only if there is at least one exported symbol in it.
// (See issue 11008.)
@ -628,7 +633,7 @@ func (pkg *Package) symbolDoc(symbol string) bool {
}
}
}
if len(specs) == 0 {
if len(specs) == 0 || printed[value.Decl] {
continue
}
value.Decl.Specs = specs
@ -636,6 +641,7 @@ func (pkg *Package) symbolDoc(symbol string) bool {
pkg.packageClause(true)
}
pkg.emit(value.Doc, value.Decl)
printed[value.Decl] = true
found = true
}
// Types.