[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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



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>
---
 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




 


Rackspace

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