update implementation for 2020 spec changes dmitri.shuralyov.com/go/generated#1

@@ -1,9 +1,31 @@

Parent:     b1254a4 (remove comment about API being undecided)

Author:     Dmitri Shuralyov <dmitri@shuralyov.com>

AuthorDate: Mon Jun 21 00:40:49 2021 -0400

Commit:     Dmitri Shuralyov <dmitri@shuralyov.com>

CommitDate: Sun Aug 1 13:54:44 2021 -0400

CommitDate: Sun Dec 12 15:01:05 2021 -0500

update implementation for 2020 spec changes

dominikh commented 2 years ago (Patch Set 1)

Should capitalize sentence :P

Write Preview Markdown

Resolved Update comment Cancel

dmitshur commented 2 years ago (Patch Set 1)

I'm following the Go style for commit messages, which chooses to do:

A rule of thumb is that it should be written so to complete the sentence "This change modifies Go to _____." That means it does not start with a capital letter, is not a complete sentence, and actually summarizes the result of the change.

(From https://go.dev/doc/contribute#first_line and emphasis mine.)

Write Preview Markdown

Resolved Update comment Cancel

With the new specification, it's possible to stop reading a file early

even when the generated comment is absent, since the generated comment

may no longer appear anywhere in the file. Begin parsing /* */ comment

blocks, which may span multiple lines, to be able to be able to detect

when we run into the first non-comment, non-blank text in the file.

It was mentioned in https://go.dev/issue/41196#issuecomment-686607452:

> [...] the primary focus for these comments is Go code

> and more generally Go package sources.

> Go package sources today can be Go, assembly, C, C++, Objective C,

> SWIG, and Fortran.

> The comment being discussed here, like the //go:build comment,

> handles all of these these except Fortran, which seems fine.

The initial scope of this package was to support parsing Go source only,

but it happens to work well with many other source types that are found

in Go packages. Replace mentions of "a Go source file" in documentation

and code with "a source file", to make it apply more generally. If this

will mean we need to parse comments differently depending on the source

type in the future, we can revisit this decision. Let's see how it goes.

Fixes issue 1.

@@ -1,9 +1,9 @@

// Package generated provides a function that parses a source file and reports

// whether it contains a "// Code generated … DO NOT EDIT." line comment.

//

// It implements the specification at https://golang.org/s/generatedcode.

dmitshur commented 2 years ago (Patch Set 1)

Shortened 'golang.org' to 'go.dev' here, and on line 24.

Write Preview Markdown

Resolved Update comment Cancel

// It implements the specification at https://go.dev/s/generatedcode.

//

// The first priority is correctness (no false negatives, no false positives).

// It must return accurate results even if the input source code is formatted

// unconventionally.

//

@@ -19,11 +19,11 @@ import (

	"os"

)

// Parse parses a source file provided via src, and reports whether

// the file contains a "// Code generated ... DO NOT EDIT." line comment

// matching the specification at https://golang.org/s/generatedcode:

// matching the specification at https://go.dev/s/generatedcode:

//

// 	To convey to humans and machine tools that code is generated,

// 	generated source should have a line that matches the following

// 	regular expression (in Go syntax):

//