]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: Add sub-page for all golang modules
authorPeter Krempa <pkrempa@redhat.com>
Tue, 14 Feb 2023 12:51:02 +0000 (13:51 +0100)
committerPeter Krempa <pkrempa@redhat.com>
Wed, 15 Feb 2023 11:38:45 +0000 (12:38 +0100)
Our documentation has pages for 4 go modules, 2 current and 2 obsolete
ones, but points only to one of them and directly to golang's docs page.

Add a sub-page where all 4 sub-pages for the modules are linked.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
docs/docs.rst
docs/golang.rst [new file with mode: 0644]
docs/meson.build

index a826bd128c0b43fd84b9d5656643984c096700d2..855ce6a0697ce096b8483d708f21b9d076b135e1 100644 (file)
@@ -79,7 +79,7 @@ Application development
 `Language bindings and API modules <bindings.html>`__
    Bindings of the libvirt API for
    `c# <csharp.html>`__,
-   `go <https://pkg.go.dev/libvirt.org/go/libvirt>`__,
+   `go <https://pkg.go.dev/libvirt.org/go/libvirt>`__ (`all go modules <golang.html>`__),
    `java <java.html>`__,
    `ocaml <https://libvirt.org/ocaml/>`__,
    `perl <https://search.cpan.org/dist/Sys-Virt/>`__,
diff --git a/docs/golang.rst b/docs/golang.rst
new file mode 100644 (file)
index 0000000..ede4d31
--- /dev/null
@@ -0,0 +1,21 @@
+====================
+Go Language bindings
+====================
+
+Modern libvirt API bindings with Go modules
+-------------------------------------------
+
+The libvirt API bindings package and module for XML manipulation:
+
+ - `libvirt.org/go/libvirt <go/libvirt.html>`__ package https://pkg.go.dev/libvirt.org/go/libvirt
+ - `libvirt.org/go/libvirtxml <go/libvirtxml.html>`__ package https://pkg.go.dev/libvirt.org/go/libvirtxml
+
+
+Obsolete libvirt language bindings
+----------------------------------
+
+The following two go packages were superseded, but software currently using them
+will keep working. No further development will take place.
+
+ - `libvirt.org/libvirt-go <libvirt-go.html>`__ - CGo binding to the native API
+ - `libvirt.org/libvirt-go-xml <libvirt-go-xml.html>`)) - annotated Go struct definitions for XML handling
index 5ffd39c01bd5057fa7c4b911b1dd0f71b12b14f3..a90c59866a71e06f84c089ffe8b4c035dd1b63d5 100644 (file)
@@ -80,6 +80,7 @@ docs_rst_files = [
   'formatstorageencryption',
   'glib-adoption',
   'goals',
+  'golang',
   'governance',
   'hacking',
   'hooks',