github.com/libvirt/libvirt-go-xml@v7.4.0+incompatible/README.rst (about)

     1  ==============
     2  libvirt-go-xml
     3  ==============
     4  
     5  .. image:: https://gitlab.com/libvirt/libvirt-go-xml/badges/master/pipeline.svg
     6     :target: https://gitlab.com/libvirt/libvirt-go-xml/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/libvirt-go-xml
    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  Documentation
    21  =============
    22  
    23  * `API documentation for the bindings <https://pkg.go.dev/libvirt.org/libvirt-go-xml>`_
    24  
    25  * `Libvirt XML schema documentation <https://libvirt.org/format.html>`_
    26  
    27    * `capabilities <https://libvirt.org/formatcaps.html>`_
    28    * `domain <https://libvirt.org/formatdomain.html>`_
    29    * `domain capabilities <https://libvirt.org/formatdomaincaps.html>`_
    30    * `domain snapshot <https://libvirt.org/formatsnapshot.html>`_
    31    * `network <https://libvirt.org/formatnetwork.html>`_
    32    * `node device <https://libvirt.org/formatnode.html>`_
    33    * `nwfilter <https://libvirt.org/formatnwfilter.html>`_
    34    * `secret <https://libvirt.org/formatsecret.html>`_
    35    * `storage <https://libvirt.org/formatstorage.html>`_
    36    * `storage encryption <https://libvirt.org/formatstorageencryption.html>`_
    37  
    38  
    39  Contributing
    40  ============
    41  
    42  The libvirt project aims to add support for new XML elements to
    43  libvirt-go-xml as soon as they are added to the main libvirt C
    44  library. If you are submitting changes to the libvirt C library
    45  that introduce new XML elements, please submit a libvirt-go-xml
    46  change at the same time. Bug fixes and other improvements to the
    47  libvirt-go-xml library are welcome at any time.
    48  
    49  For more information, see the `CONTRIBUTING <CONTRIBUTING.rst>`_
    50  file.