[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

  • To: Nick Rosbrook <rosbrookn@xxxxxxxxx>
  • From: George Dunlap <George.Dunlap@xxxxxxxxxx>
  • Date: Fri, 22 May 2020 09:14:20 +0000
  • Accept-language: en-GB, en-US
  • Authentication-results: esa6.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none
  • Cc: Nick Rosbrook <rosbrookn@xxxxxxxxxxxx>, xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>, Paul Durrant <paul@xxxxxxx>, Wei Liu <wl@xxxxxxx>, Ian Jackson <Ian.Jackson@xxxxxxxxxx>
  • Delivery-date: Fri, 22 May 2020 09:14:30 +0000
  • Ironport-sdr: B/GeyZWhaZYHqv9pji0HFtvz7Fy7ScTqYq/dAdNyohsU0mRYTPPaSijBH70+rr9rrMeJkZp1tL OAeLOqxIhFQYTwpH8VqgnspeWYO++dXVWEQc3K6LwkRHa1MZfn3zmByFEpqepohs28a+kEpKR9 MOMYncLz7gWTYfuZeqKmuvNo2rBuWV5NUFtfpT1CRQXriNrztInXtbWC4Mgpxmd6iRXXfSeQ8j tRNnKobBlJScs4QfIj06w8zTQNMWHmgtTVxBQ1cKI5uDtt6XXHHSfMJBgoy+AIuMTulLGBk9dc tVU=
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Thread-index: AQHWL3/q51M6HvGdpEqSwwkQaxvEFqiygIWA
  • Thread-topic: [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.:




Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.