golang/xenlight: add an empty line after DO NOT EDIT comment
authorNick Rosbrook <rosbrookn@gmail.com>
Thu, 21 May 2020 14:55:25 +0000 (10:55 -0400)
committerGeorge Dunlap <george.dunlap@citrix.com>
Fri, 22 May 2020 22:17:37 +0000 (23:17 +0100)
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>
tools/golang/xenlight/gengotypes.py
tools/golang/xenlight/helpers.gen.go
tools/golang/xenlight/types.gen.go

index e9ad92afa0d7b7d77abdd4e228e214574850a257..2b71aa1ea87870e61708c83b92f10f02ba6a7bcf 100644 (file)
@@ -737,6 +737,7 @@ if __name__ == '__main__':
     // This file is generated by:
     // {}
     //
+
     """.format(' '.join(sys.argv))
 
     xenlight_golang_generate_types(types=types,
index b5bd0de8306e50eb7d81685a6ccd3259cd3890c0..1e58ebbab296163e9e5064bb909b9830ef439b60 100644 (file)
@@ -3,6 +3,7 @@
 // This file is generated by:
 // gengotypes.py ../../libxl/libxl_types.idl
 //
+
 package xenlight
 
 import (
index 15516ae5527438e7455bfcf2e95201b753da8b9b..be42f75529ac5d324dac9df3e71ed2aa4e6ccee9 100644 (file)
@@ -3,6 +3,7 @@
 // This file is generated by:
 // gengotypes.py ../../libxl/libxl_types.idl
 //
+
 package xenlight
 
 type Error int