[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] RE: [PATCH] golang/xenlight: add an empty line after DO NOT EDIT comment
> -----Original Message----- > From: George Dunlap <George.Dunlap@xxxxxxxxxx> > Sent: 22 May 2020 10:14 > To: Nick Rosbrook <rosbrookn@xxxxxxxxx> > Cc: xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>; Nick Rosbrook > <rosbrookn@xxxxxxxxxxxx>; Ian Jackson > <Ian.Jackson@xxxxxxxxxx>; Wei Liu <wl@xxxxxxx>; Paul Durrant <paul@xxxxxxx> > Subject: Re: [PATCH] golang/xenlight: add an empty line after DO NOT EDIT > comment > > CC’ing the release manager, since we’re past the last posting date > > > On May 21, 2020, at 3:55 PM, Nick Rosbrook <rosbrookn@xxxxxxxxx> wrote: > > > > When generating documentation, pkg.go.dev and godoc.org assume a comment > > that immediately precedes the package declaration is a "package > > comment", and should be shown in the documentation. Add an empty line > > after the DO NOT EDIT comment in generated files to prevent these > > comments from appearing as "package comments." > > > > Signed-off-by: Nick Rosbrook <rosbrookn@xxxxxxxxxxxx> > > Reviewed-by: George Dunlap <george.dunlap@xxxxxxxxxx> > > Paul, I would classify this as a bug fix: It won’t have any functional effect > on the code itself, but > it fixes how it’s displayed; e.g.: > > https://pkg.go.dev/xenbits.xenproject.org/git-http/xen.git/tools/golang/xenlight?tab=doc > Since it is apparently a pure whitespace change I have no problem with this going in. We're not at freeze yet so technically you don't need my release-ack as yet :-) Paul
|
Lists.xenproject.org is hosted with RackSpace, monitoring our |