From: Paul Durrant <xadimgnik@gmail.com>
To: "'George Dunlap'" <George.Dunlap@citrix.com>,
"'Nick Rosbrook'" <rosbrookn@gmail.com>
Cc: 'Nick Rosbrook' <rosbrookn@ainfosec.com>,
'xen-devel' <xen-devel@lists.xenproject.org>,
'Wei Liu' <wl@xen.org>, 'Ian Jackson' <Ian.Jackson@citrix.com>
Subject: RE: [PATCH] golang/xenlight: add an empty line after DO NOT EDIT comment
Date: Fri, 22 May 2020 10:44:09 +0100 [thread overview]
Message-ID: <001201d6301d$8b6364a0$a22a2de0$@xen.org> (raw)
In-Reply-To: <D90B93AD-977A-468E-840E-2E2354905968@citrix.com>
> -----Original Message-----
> From: George Dunlap <George.Dunlap@citrix.com>
> Sent: 22 May 2020 10:14
> To: Nick Rosbrook <rosbrookn@gmail.com>
> Cc: xen-devel <xen-devel@lists.xenproject.org>; Nick Rosbrook <rosbrookn@ainfosec.com>; Ian Jackson
> <Ian.Jackson@citrix.com>; Wei Liu <wl@xen.org>; Paul Durrant <paul@xen.org>
> 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@gmail.com> 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@ainfosec.com>
>
> Reviewed-by: George Dunlap <george.dunlap@citrix.com>
>
> 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
prev parent reply other threads:[~2020-05-22 9:44 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-21 14:55 [PATCH] golang/xenlight: add an empty line after DO NOT EDIT comment Nick Rosbrook
2020-05-21 15:45 ` Nick Rosbrook
2020-05-22 9:14 ` George Dunlap
2020-05-22 9:44 ` Paul Durrant [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='001201d6301d$8b6364a0$a22a2de0$@xen.org' \
--to=xadimgnik@gmail.com \
--cc=George.Dunlap@citrix.com \
--cc=Ian.Jackson@citrix.com \
--cc=paul@xen.org \
--cc=rosbrookn@ainfosec.com \
--cc=rosbrookn@gmail.com \
--cc=wl@xen.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).