]> Cypherpunks repositories - gostls13.git/commit
[release-branch.go1.14] cmd/doc: fix merging comments in -src mode
authorIvan Trubach <mr.trubach@icloud.com>
Thu, 12 Dec 2019 13:33:42 +0000 (13:33 +0000)
committerAndrew Bonventre <andybons@golang.org>
Thu, 28 May 2020 23:17:18 +0000 (23:17 +0000)
commita68b7d324ccbc379be5a05d2033189c9b545cb39
treeaaa52aa3162a4b5f9c7a2b3c92ee3fa7e5eab44c
parent846c00ed3d27a764abeaf0d153adb996751f79aa
[release-branch.go1.14] cmd/doc: fix merging comments in -src mode

These changes fix go doc -src mode that vomits comments from random files if
filesystem does not sort files by name. The issue was with parse.ParseDir
using the Readdir order of files, which varies between platforms and filesystem
implementations. Another option is to merge comments using token.FileSet.Iterate
order in cmd/doc, but since ParseDir is mostly used in go doc, I’ve opted for
smaller change because it’s unlikely to break other uses or cause any perfomance
issues.

Example (macOS APFS): `go doc -src net.ListenPacket`

Fixes #38993

Change-Id: I7f9f368c7d9ccd9a2cbc48665f2cb9798c7b3a3f
GitHub-Last-Rev: 654fb450421266a0bb64518016944db22bd681e3
GitHub-Pull-Request: golang/go#36104
Reviewed-on: https://go-review.googlesource.com/c/go/+/210999
Run-TryBot: Rob Pike <r@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
(cherry picked from commit 585e31df63f6879c03b285711de6f9dcba1f2cb0)
Reviewed-on: https://go-review.googlesource.com/c/go/+/235579
Run-TryBot: Andrew Bonventre <andybons@golang.org>
Reviewed-by: Andrew Gerrand <adg@golang.org>
src/cmd/doc/doc_test.go
src/cmd/doc/testdata/merge/aa.go [new file with mode: 0644]
src/cmd/doc/testdata/merge/bb.go [new file with mode: 0644]
src/go/parser/interface.go