libvirt.org/go/libvirtxml@v1.10003.0/README.rst (about)

     1  =====================
     2  libvirt-go-xml-module
     3  =====================
     4  
     5  .. image:: https://gitlab.com/libvirt/libvirt-go-xml-module/badges/master/pipeline.svg
     6     :target: https://gitlab.com/libvirt/libvirt-go-xml-module/pipelines
     7     :alt: Build Status
     8  .. image:: https://img.shields.io/static/v1?label=godev&message=reference&color=00add8
     9     :target: https://pkg.go.dev/libvirt.org/go/libvirtxml
    10     :alt: API Documentation
    11  
    12  Go API for manipulating libvirt XML documents
    13  
    14  This package provides a Go API that defines a set of structs, annotated for use
    15  with "encoding/xml", that can represent libvirt XML documents. There is no
    16  dependency on the libvirt library itself, so this can be used regardless of
    17  the way in which the application talks to libvirt.
    18  
    19  
    20  Development status
    21  ==================
    22  
    23  This API is considered to be production ready; note however that,
    24  while unnecessary changes will be avoided, there are overall no
    25  strong stability guarantees.
    26  
    27  Please see the `VERSIONING <VERSIONING.rst>`_ file for information
    28  about release schedule and versioning scheme.
    29  
    30  
    31  Documentation
    32  =============
    33  
    34  * `API documentation for the bindings <https://pkg.go.dev/libvirt.org/go/libvirtxml>`_
    35  
    36  * `Libvirt XML schema documentation <https://libvirt.org/format.html>`_
    37  
    38    * `capabilities <https://libvirt.org/formatcaps.html>`_
    39    * `domain <https://libvirt.org/formatdomain.html>`_
    40    * `domain capabilities <https://libvirt.org/formatdomaincaps.html>`_
    41    * `domain snapshot <https://libvirt.org/formatsnapshot.html>`_
    42    * `network <https://libvirt.org/formatnetwork.html>`_
    43    * `node device <https://libvirt.org/formatnode.html>`_
    44    * `nwfilter <https://libvirt.org/formatnwfilter.html>`_
    45    * `secret <https://libvirt.org/formatsecret.html>`_
    46    * `storage <https://libvirt.org/formatstorage.html>`_
    47    * `storage encryption <https://libvirt.org/formatstorageencryption.html>`_
    48  
    49  
    50  Contributing
    51  ============
    52  
    53  The libvirt project aims to add support for new XML elements to
    54  libvirt-go-xml-module as soon as they are added to the main libvirt C
    55  library. If you are submitting changes to the libvirt C library
    56  that introduce new XML elements, please submit a libvirt-go-xml-module
    57  change at the same time. Bug fixes and other improvements to the
    58  libvirt-go-xml-module library are welcome at any time.
    59  
    60  For more information, see the `CONTRIBUTING <CONTRIBUTING.rst>`_
    61  file.