[PATCH] golang/xenlight: add an empty line after DO NOT EDIT comment

Nick Rosbrook posted 1 patch 22 weeks ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/xen tags/patchew/49cc21c24b65ef5e1ce9810397c0fcd9d43f77f4.1590072675.git.rosbrookn@ainfosec.com
Maintainers: Ian Jackson <ian.jackson@eu.citrix.com>, George Dunlap <george.dunlap@citrix.com>, Wei Liu <wl@xen.org>
tools/golang/xenlight/gengotypes.py  | 1 +
tools/golang/xenlight/helpers.gen.go | 1 +
tools/golang/xenlight/types.gen.go   | 1 +
3 files changed, 3 insertions(+)

[PATCH] golang/xenlight: add an empty line after DO NOT EDIT comment

Posted by Nick Rosbrook 22 weeks ago
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>
---
 tools/golang/xenlight/gengotypes.py  | 1 +
 tools/golang/xenlight/helpers.gen.go | 1 +
 tools/golang/xenlight/types.gen.go   | 1 +
 3 files changed, 3 insertions(+)

diff --git a/tools/golang/xenlight/gengotypes.py b/tools/golang/xenlight/gengotypes.py
index e9ad92afa0..2b71aa1ea8 100644
--- a/tools/golang/xenlight/gengotypes.py
+++ b/tools/golang/xenlight/gengotypes.py
@@ -737,6 +737,7 @@ if __name__ == '__main__':
     // This file is generated by:
     // {}
     //
+
     """.format(' '.join(sys.argv))
 
     xenlight_golang_generate_types(types=types,
diff --git a/tools/golang/xenlight/helpers.gen.go b/tools/golang/xenlight/helpers.gen.go
index 109e9515a2..d464e38565 100644
--- a/tools/golang/xenlight/helpers.gen.go
+++ b/tools/golang/xenlight/helpers.gen.go
@@ -3,6 +3,7 @@
 // This file is generated by:
 // gengotypes.py ../../libxl/libxl_types.idl
 //
+
 package xenlight
 
 import (
diff --git a/tools/golang/xenlight/types.gen.go b/tools/golang/xenlight/types.gen.go
index df68fd0e88..65c2742bc3 100644
--- a/tools/golang/xenlight/types.gen.go
+++ b/tools/golang/xenlight/types.gen.go
@@ -3,6 +3,7 @@
 // This file is generated by:
 // gengotypes.py ../../libxl/libxl_types.idl
 //
+
 package xenlight
 
 type Error int
-- 
2.17.1


Re: [PATCH] golang/xenlight: add an empty line after DO NOT EDIT comment

Posted by George Dunlap 21 weeks ago
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


RE: [PATCH] golang/xenlight: add an empty line after DO NOT EDIT comment

Posted by Paul Durrant 21 weeks ago
> -----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


Re: [PATCH] golang/xenlight: add an empty line after DO NOT EDIT comment

Posted by Nick Rosbrook 22 weeks ago
> 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."

George,

When I re-generated the code, there were also changes to
types/helpers.gen.go corresponding to recent changes from the linux
stubdom series. How should we make sure the xenlight package is
up-to-date for the 4.14 release?

Thanks,
NR