Skip to content

Commit

Permalink
cmd/doc: don't print a declaration twice
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
robpike committed Nov 20, 2017
1 parent 363a5da commit 337f04b
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
13 changes: 13 additions & 0 deletions src/cmd/doc/doc_test.go
Expand Up @@ -445,6 +445,19 @@ var tests = []test{
`CaseMatch`,
},
},

// No dups with -u. Issue 21797.
{
"case matching on, no dups",
[]string{"-u", p, `duplicate`},
[]string{
`Duplicate`,
`duplicate`,
},
[]string{
"\\)\n+const", // This will appear if the const decl appears twice.
},
},
}

func TestDoc(t *testing.T) {
Expand Down
8 changes: 7 additions & 1 deletion src/cmd/doc/pkg.go
Expand Up @@ -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.)
Expand Down Expand Up @@ -628,14 +633,15 @@ func (pkg *Package) symbolDoc(symbol string) bool {
}
}
}
if len(specs) == 0 {
if len(specs) == 0 || printed[value.Decl] {
continue
}
value.Decl.Specs = specs
if !found {
pkg.packageClause(true)
}
pkg.emit(value.Doc, value.Decl)
printed[value.Decl] = true
found = true
}
// Types.
Expand Down
5 changes: 5 additions & 0 deletions src/cmd/doc/testdata/pkg.go
Expand Up @@ -193,3 +193,8 @@ var LongLine = newLongLine(
type T2 int

type T1 = T2

const (
Duplicate = iota
duplicate
)

0 comments on commit 337f04b

Please sign in to comment.