[libvirt PATCH v2] docs: introduce stubs for new libvirt Go packages

Currently we expose libvirt Go packages at libvirt.org/libvirt-go libvirt.org/libvirt-go-xml These packages have not supported Go modules historically and when we tried to introduce modules, we hit the problem that we're not using semver for versioning. The only way around this is to introduce new packages under a different namespace, that will have the exact same code, but be tagged with a different version numbering scheme. This change proposes: libvirt.org/go/libvirt libvirt.org/go/libvirtxml Note the hyphen is removed so that the import basename matches the Go package name. Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com&gt; --- docs/go/libvirt.rst | 18 ++++++++++++++ docs/go/libvirtxml.rst | 15 ++++++++++++ docs/go/meson.build | 53 +++++++++++++++++++++++++++++++++++++++++ docs/libvirt-go-xml.rst | 12 +++++++--- docs/libvirt-go.rst | 12 +++++++--- docs/meson.build | 1 + 6 files changed, 105 insertions(+), 6 deletions(-) create mode 100644 docs/go/libvirt.rst create mode 100644 docs/go/libvirtxml.rst create mode 100644 docs/go/meson.build diff --git a/docs/go/libvirt.rst b/docs/go/libvirt.rst new file mode 100644 index 0000000000..df74660b5f --- /dev/null +++ b/docs/go/libvirt.rst @@ -0,0 +1,18 @@ +================================================= +Libvirt Go Language API (semver, with Go modules) +================================================= + +The `Go <https://golang.org/>`__ package ``libvirt.org/go/libvirt`` provides +`CGo <https://golang.org/cmd/cgo/>`__ binding from the OS native Libvirt API. + +This package replaces the original `libvirt-go <../libvirt-go.html>`__ +package in order to switch to using `semver <https://semver.org/>`__ and +`Go modules <https://golang.org/ref/mod>`__. Aside from the changed +import path, the API is fully compatible with the original package. + +In general the Go representation is a direct 1-1 mapping from native API +concepts to Go, so the native API documentation should serve as a reference +for most behaviour. + +For details of Go specific behaviour consult the +`Go package documentation <https://pkg.go.dev/libvirt.org/go/libvirt>`__. diff --git a/docs/go/libvirtxml.rst b/docs/go/libvirtxml.rst new file mode 100644 index 0000000000..70b2aca594 --- /dev/null +++ b/docs/go/libvirtxml.rst @@ -0,0 +1,15 @@ +==================================================== +Libvirt Go XML parsing API (semver, with Go modules) +==================================================== + +The `Go <https://golang.org/>`__ package ``libvirt.org/go/libvirtxml`` provides +annotated Go struct definitions for parsing (and formatting) XML documents used +with libvirt APIs. + +This package replaces the original `libvirt-go-xml <../libvirt-go-xml.html>`__ +package in order to switch to using `semver <https://semver.org/>`__ and +`Go modules <https://golang.org/ref/mod>`__. Aside from the changed +import path, the API is fully compatible with the original package. + +For details of Go specific behaviour consult the +`Go package documentation <https://pkg.go.dev/libvirt.org/go/libvirtxml>`__. diff --git a/docs/go/meson.build b/docs/go/meson.build new file mode 100644 index 0000000000..d2accd322b --- /dev/null +++ b/docs/go/meson.build @@ -0,0 +1,53 @@ +docs_go_files = [ + 'libvirt', + 'libvirtxml', +] + +html_xslt_gen_xslt = subsite_xsl +html_xslt_gen_install_dir = docs_html_dir / 'go' +html_xslt_gen = [] + +foreach name : docs_go_files + rst_file = '@0@.rst'.format(name) + + html_xslt_gen += { + 'name': name, + 'file': docs_rst2html_gen.process(rst_file), + 'source': 'docs' / 'go' / rst_file, + } +endforeach + +# keep the XSLT processing code block in sync with docs/meson.build + +# --- begin of XSLT processing --- + +foreach data : html_xslt_gen + html_filename = data['name'] + '.html' + + html_file = custom_target( + html_filename, + input: data.get('file', data['name'] + '.html.in'), + output: html_filename, + command: [ + xsltproc_prog, + '--stringparam', 'pagesrc', data.get('source', ''), + '--stringparam', 'builddir', meson.build_root(), + '--stringparam', 'timestamp', docs_timestamp, + '--nonet', + html_xslt_gen_xslt, + '@INPUT@', + ], + depends: data.get('depends', []), + depend_files: [ page_xsl ], + capture: true, + install: true, + install_dir: html_xslt_gen_install_dir, + ) + + install_web_deps += html_file + install_web_files += html_file.full_path() + ':' + html_xslt_gen_install_dir +endforeach + +html_xslt_gen = [] + +# --- end of XSLT processing --- diff --git a/docs/libvirt-go-xml.rst b/docs/libvirt-go-xml.rst index 995fdd2b07..11954043c9 100644 --- a/docs/libvirt-go-xml.rst +++ b/docs/libvirt-go-xml.rst @@ -1,10 +1,16 @@ -========================== -Libvirt Go XML parsing API -========================== +================================================== +Libvirt Go XML parsing API (calver, no Go modules) +================================================== The `Go <https://golang.org/>`__ package ``libvirt.org/libvirt-go-xml`` provides annotated Go struct definitions for parsing (and formatting) XML documents used with libvirt APIs. +This package is replaced by the new `libvirt <go/libvirtxml.html>`__ +package in order to switch to using `semver <https://semver.org/>`__ and +`Go modules <https://golang.org/ref/mod>`__. Aside from the changed +import path, the new package API is fully compatible with this original +package. + For details of Go specific behaviour consult the `Go package documentation <https://pkg.go.dev/libvirt.org/libvirt-go-xml>`__. diff --git a/docs/libvirt-go.rst b/docs/libvirt-go.rst index f2d3f80fb2..7fc1a430a9 100644 --- a/docs/libvirt-go.rst +++ b/docs/libvirt-go.rst @@ -1,10 +1,16 @@ -======================= -Libvirt Go Language API -======================= +=============================================== +Libvirt Go Language API (calver, no Go modules) +=============================================== The `Go <https://golang.org/>`__ package ``libvirt.org/libvirt-go`` provides `CGo <https://golang.org/cmd/cgo/>`__ binding from the OS native Libvirt API. +This package is replaced by the new `libvirt <go/libvirt.html>`__ +package in order to switch to using `semver <https://semver.org/>`__ and +`Go modules <https://golang.org/ref/mod>`__. Aside from the changed +import path, the new package API is fully compatible with this original +package. + In general the Go representation is a direct 1-1 mapping from native API concepts to Go, so the native API documentation should serve as a reference for most behaviour. diff --git a/docs/meson.build b/docs/meson.build index bee0d80d53..4497f7270f 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -297,6 +297,7 @@ html_xslt_gen = [] # --- end of XSLT processing --- subdir('fonts') +subdir('go') subdir('html') subdir('internals') subdir('js') -- 2.31.1