1
0
mirror of https://github.com/golang/go synced 2024-11-15 08:30:35 -07:00
The Go programming language
Go to file
Robert Griesemer b7250b205a [release-branch.go1] go/parser: fix comment grouping (day 1 bug)
««« backport afbf8db1baf4
go/parser: fix comment grouping (day 1 bug)

Comment groups must end at the end of a line (or the
next non-comment token) if the group started on a line
with non-comment tokens.

This is important for correct computation of "lead"
and "line" comments (Doc and Comment fields in AST nodes).

Without this fix, the "line" comment for F1 in the
following example:

type T struct {
     F1 int // comment1
     // comment2
     F2 int
}

is "// comment1// comment2" rather than just "// comment1".

This bug was present from Day 1 but only visible when
looking at export-filtered ASTs where only comments
associated with AST nodes are printed, and only in rare
cases (e.g, in the case above, if F2 where not exported,
godoc would show "// comment2" anyway because it was
considered part of the "line" comment for F1).

The bug fix is very small (parser.go). The bulk of the
changes are additional test cases (parser_test.go).

The fix exposed a caching bug in go/printer via one of the
existing tests, hence the changes to printer.go.

As an aside, the fix removes the the need for empty lines
before an "// Output" comment for some special cases of
code examples (e.g.: src/pkg/strings/example_test.go, Count
example).

No impact on gofmt formatting of src, misc.

Fixes #3139.

R=rsc
CC=golang-dev
https://golang.org/cl/6209080

»»»
2012-06-13 16:24:06 -04:00
api [release-branch.go1] api: undo go1.txt additions made by 27d0a516b7eb 2012-06-13 16:23:58 -04:00
doc [release-branch.go1] doc/install: document minimum system requirements 2012-06-13 16:23:56 -04:00
include build: remove unnecessary pragmas 2012-02-06 12:45:23 -05:00
lib [release-branch.go1] doc: don't wrap package names in directory listing 2012-04-20 10:04:13 -04:00
misc [release-branch.go1] misc/emacs: Restore the window position after a successful gofmt. 2012-06-13 16:23:45 -04:00
src [release-branch.go1] go/parser: fix comment grouping (day 1 bug) 2012-06-13 16:24:06 -04:00
test [release-branch.go1] cmd/gc: fix addresses escaping through closures called in-place. 2012-04-23 15:39:01 -04:00
.hgignore build: update Makefile to track source code dependencies better 2012-03-13 03:31:11 +08:00
.hgtags weekly.2012-03-27 2012-03-28 23:41:03 +11:00
AUTHORS [release-branch.go1] A+C: add James Gray (Individual CLA) 2012-06-13 16:24:01 -04:00
CONTRIBUTORS [release-branch.go1] A+C: add James Gray (Individual CLA) 2012-06-13 16:24:01 -04:00
favicon.ico
LICENSE doc: update licensing text one more time 2012-03-27 15:09:13 +11:00
PATENTS
README
robots.txt
VERSION go1.0.1 2012-04-26 12:50:14 -07:00

This is the source code repository for the Go programming language.  

For documentation about how to install and use Go,
visit http://golang.org/ or load doc/install.html in your web browser.

After installing Go, you can view a nicely formatted
doc/install.html by running godoc --http=:6060
and then visiting http://localhost:6060/doc/install.html.

Unless otherwise noted, the Go source files are distributed
under the BSD-style license found in the LICENSE file.

--

Binary Distribution Notes

If you have just untarred a binary Go distribution, you need to set
the environment variable $GOROOT to the full path of the go
directory (the one containing this README).  You can omit the
variable if you unpack it into /usr/local/go, or if you rebuild
from sources by running all.bash (see doc/install.html).
You should also add the Go binary directory $GOROOT/bin
to your shell's path.

For example, if you extracted the tar file into $HOME/go, you might
put the following in your .profile:

    export GOROOT=$HOME/go
    export PATH=$PATH:$GOROOT/bin

See doc/install.html for more details.