External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-11-05 04:41:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
ee3b96bcb0
libvirt/docs/go/libvirt.rst
Daniel P. Berrangé 1832c0a02b 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.

Reviewed-by: Andrea Bolognani <abologna@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2021-06-07 17:04:14 +01:00

889 B
Raw Blame History

Libvirt Go Language API (with Go modules)

The Go package libvirt.org/go/libvirt provides CGo binding from the OS native Libvirt API.

This package replaces the obsolete libvirt.org/libvirt-go package in order to switch to using semver and Go modules. Aside from the changed import path and versioning scheme, the API is fully compatible with the legacy 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.