github.com/zhaoxuat/libvirt-go-xml@v6.3.1-0.20200612053919-a025f1d30c41+incompatible/README.md (about)

     1  # libvirt-go-xml [![build status](https://gitlab.com/libvirt/libvirt-go-xml/badges/master/pipeline.svg)](https://gitlab.com/libvirt/libvirt-go-xml/pipelines) [![GoDoc](https://godoc.org/libvirt.org/libvirt-go-xml?status.svg)](https://godoc.org/libvirt.org/libvirt-go-xml)
     2  
     3  Go API for manipulating libvirt XML documents
     4  
     5  This package provides a Go API that defines a set of structs, annotated for use
     6  with "encoding/xml", that can represent libvirt XML documents. There is no
     7  dependancy on the libvirt library itself, so this can be used regardless of
     8  the way in which the application talks to libvirt.
     9  
    10  ## Documentation
    11  
    12  * [API documentation for the bindings](https://godoc.org/libvirt.org/libvirt-go-xml)
    13  * [Libvirt XML schema documentation](https://libvirt.org/format.html):
    14    * [capabilities](https://libvirt.org/formatcaps.html)
    15    * [domain](https://libvirt.org/formatdomain.html)
    16    * [domain capabilities](https://libvirt.org/formatdomaincaps.html)
    17    * [domain snapshot](https://libvirt.org/formatsnapshot.html)
    18    * [network](https://libvirt.org/formatnetwork.html)
    19    * [node device](https://libvirt.org/formatnode.html)
    20    * [nwfilter](https://libvirt.org/formatnwfilter.html)
    21    * [secret](https://libvirt.org/formatsecret.html)
    22    * [storage](https://libvirt.org/formatstorage.html)
    23    * [storage encryption](https://libvirt.org/formatstorageencryption.html)
    24  
    25  ## Contributing
    26  
    27  The libvirt project aims to add support for new APIs to libvirt-go
    28  as soon as they are added to the main libvirt C library. If you
    29  are submitting changes to the libvirt C library API, please submit
    30  a libvirt-go change at the same time.
    31  
    32  Bug fixes and other improvements to the libvirt-go library are
    33  welcome at any time. The preferred submission method is to use
    34  git send-email to submit patches to the libvir-list@redhat.com
    35  mailing list. eg. to send a single patch
    36  
    37  ```
    38    # git send-email --to libvir-list@redhat.com --subject-prefix "PATCH go-xml" \
    39         --smtp-server=$HOSTNAME -1
    40  ```
    41  
    42  Or to send all patches on the current branch, against master
    43  
    44  ```
    45    $ git send-email --to libvir-list@redhat.com --subject-prefix "PATCH go-xml" \
    46         --smtp-server=$HOSTNAME --no-chain-reply-to --cover-letter --annotate \
    47         master..
    48  ```
    49  
    50  Note the master GIT repository is at
    51  
    52  ```
    53     http://libvirt.org/git/?p=libvirt-go.git;a=summary
    54  ```
    55  
    56  The following automatic read-only mirrors are available as a
    57  convenience to allow contributors to "fork" the repository:
    58  
    59  ```
    60    https://gitlab.com/libvirt/libvirt-go
    61    https://github.com/libvirt/libvirt-go
    62  ```
    63  
    64  While you can send pull-requests to these mirrors, they will be
    65  re-submitted via emai to the mailing list for review before
    66  being merged, unless they are trivial/obvious bug fixes.
    67