-po/README.md
\ No newline at end of file
+po/README.rst
\ No newline at end of file
autogen.sh \
GNUmakefile \
run.in \
- README.md \
+ README.rst \
AUTHORS.in \
scripts/apibuild.py \
scripts/augeas-gentest.py \
-README.md
\ No newline at end of file
+README.rst
\ No newline at end of file
+++ /dev/null
-[](https://travis-ci.org/libvirt/libvirt)
- [](https://bestpractices.coreinfrastructure.org/projects/355)
-
-Libvirt API for virtualization
-==============================
-
-Libvirt provides a portable, long term stable C API for managing the
-virtualization technologies provided by many operating systems. It
-includes support for QEMU, KVM, Xen, LXC, bhyve, Virtuozzo, VMware
-vCenter and ESX, VMware Desktop, Hyper-V, VirtualBox and the POWER
-Hypervisor.
-
-For some of these hypervisors, it provides a stateful management
-daemon which runs on the virtualization host allowing access to the
-API both by non-privileged local users and remote users.
-
-Layered packages provide bindings of the libvirt C API into other
-languages including Python, Perl, PHP, Go, Java, OCaml, as well as
-mappings into object systems such as GObject, CIM and SNMP.
-
-Further information about the libvirt project can be found on the
-website:
-
-[https://libvirt.org](https://libvirt.org)
-
-
-License
--------
-
-The libvirt C API is distributed under the terms of GNU Lesser General
-Public License, version 2.1 (or later). Some parts of the code that are
-not part of the C library may have the more restrictive GNU General
-Public License, version 2.0 (or later). See the files `COPYING.LESSER`
-and `COPYING` for full license terms & conditions.
-
-
-Installation
-------------
-
-Libvirt uses the GNU Autotools build system, so in general can be built
-and installed with the usual commands, however, we mandate to have the
-build directory different than the source directory. For example, to build
-in a manner that is suitable for installing as root, use:
-
-```
-$ mkdir build && cd build
-$ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
-$ make
-$ sudo make install
-```
-
-While to build & install as an unprivileged user
-
-```
-$ mkdir build && cd build
-$ ../configure --prefix=$HOME/usr
-$ make
-$ make install
-```
-
-The libvirt code relies on a large number of 3rd party libraries. These will
-be detected during execution of the `configure` script and a summary printed
-which lists any missing (optional) dependencies.
-
-
-Contributing
-------------
-
-The libvirt project welcomes contributions in many ways. For most components
-the best way to contribute is to send patches to the primary development
-mailing list. Further guidance on this can be found on the website:
-
-[https://libvirt.org/contribute.html](https://libvirt.org/contribute.html)
-
-
-Contact
--------
-
-The libvirt project has two primary mailing lists:
-
- * libvirt-users@redhat.com (**for user discussions**)
- * libvir-list@redhat.com (**for development only**)
-
-Further details on contacting the project are available on the website:
-
-[https://libvirt.org/contact.html](https://libvirt.org/contact.html)
--- /dev/null
+.. image:: https://travis-ci.org/libvirt/libvirt.svg
+ :target: https://travis-ci.org/libvirt/libvirt
+ :alt: Travis CI Build Status
+.. image:: https://bestpractices.coreinfrastructure.org/projects/355/badge
+ :target: https://bestpractices.coreinfrastructure.org/projects/355
+ :alt: CII Best Practices
+
+==============================
+Libvirt API for virtualization
+==============================
+
+Libvirt provides a portable, long term stable C API for managing the
+virtualization technologies provided by many operating systems. It
+includes support for QEMU, KVM, Xen, LXC, bhyve, Virtuozzo, VMware
+vCenter and ESX, VMware Desktop, Hyper-V, VirtualBox and the POWER
+Hypervisor.
+
+For some of these hypervisors, it provides a stateful management
+daemon which runs on the virtualization host allowing access to the
+API both by non-privileged local users and remote users.
+
+Layered packages provide bindings of the libvirt C API into other
+languages including Python, Perl, PHP, Go, Java, OCaml, as well as
+mappings into object systems such as GObject, CIM and SNMP.
+
+Further information about the libvirt project can be found on the
+website:
+
+https://libvirt.org
+
+
+License
+=======
+
+The libvirt C API is distributed under the terms of GNU Lesser General
+Public License, version 2.1 (or later). Some parts of the code that are
+not part of the C library may have the more restrictive GNU General
+Public License, version 2.0 (or later). See the files ``COPYING.LESSER``
+and ``COPYING`` for full license terms & conditions.
+
+
+Installation
+============
+
+Libvirt uses the GNU Autotools build system, so in general can be built
+and installed with the usual commands, however, we mandate to have the
+build directory different than the source directory. For example, to build
+in a manner that is suitable for installing as root, use:
+
+::
+
+ $ mkdir build && cd build
+ $ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
+ $ make
+ $ sudo make install
+
+While to build & install as an unprivileged user
+
+::
+
+ $ mkdir build && cd build
+ $ ../configure --prefix=$HOME/usr
+ $ make
+ $ make install
+
+The libvirt code relies on a large number of 3rd party libraries. These will
+be detected during execution of the ``configure`` script and a summary printed
+which lists any missing (optional) dependencies.
+
+
+Contributing
+============
+
+The libvirt project welcomes contributions in many ways. For most components
+the best way to contribute is to send patches to the primary development
+mailing list. Further guidance on this can be found on the website:
+
+https://libvirt.org/contribute.html
+
+
+Contact
+=======
+
+The libvirt project has two primary mailing lists:
+
+* libvirt-users@redhat.com (**for user discussions**)
+* libvir-list@redhat.com (**for development only**)
+
+Further details on contacting the project are available on the website:
+
+https://libvirt.org/contact.html
javascript_DATA = $(javascript)
fonts = \
- fonts/LICENSE.md \
+ fonts/LICENSE.rst \
fonts/stylesheet.css \
fonts/overpass-bold-italic.woff \
fonts/overpass-bold.woff \
+++ /dev/null
-## License
-
-Copyright (C) 2015 Red Hat, Inc.,
-
-This Font Software is licensed under the SIL Open Font License, Version 1.1.
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
-
-#### SIL OPEN FONT LICENSE
-Version 1.1 - 26 February 2007
-
----
-
-#### PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide development
-of collaborative font projects, to support the font creation efforts of
-academic and linguistic communities, and to provide a free and open framework
-in which fonts may be shared and improved in partnership with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The fonts,
-including any derivative works, can be bundled, embedded, redistributed and/or
-sold with any software provided that any reserved names are not used by
-derivative works. The fonts and derivatives, however, cannot be released under
-any other type of license. The requirement for fonts to remain under this
-license does not apply to any document created using the fonts or their
-derivatives.
-
-#### DEFINITIONS
-“Font Software” refers to the set of files released by the Copyright Holder(s)
-under this license and clearly marked as such. This may include source files,
-build scripts and documentation.
-
-“Reserved Font Name” refers to any names specified as such after the copyright
-statement(s).
-
-“Original Version” refers to the collection of Font Software components as
-distributed by the Copyright Holder(s).
-
-“Modified Version” refers to any derivative made by adding to, deleting, or
-substituting—in part or in whole—any of the components of the Original Version,
-by changing formats or by porting the Font Software to a new environment.
-
-“Author” refers to any designer, engineer, programmer, technical writer or
-other person who contributed to the Font Software.
-
-#### PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-the Font Software, to use, study, copy, merge, embed, modify, redistribute, and
-sell modified and unmodified copies of the Font Software, subject to the
-following conditions:
-
-1) Neither the Font Software nor any of its individual components, in Original
-or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy contains
-the above copyright notice and this license. These can be included either as
-stand-alone text files, human-readable headers or in the appropriate machine-
-readable metadata fields within text or binary files as long as those fields
-can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font Name(s)
-unless explicit written permission is granted by the corresponding Copyright
-Holder. This restriction only applies to the primary font name as presented to
-the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software
-shall not be used to promote, endorse or advertise any Modified Version, except
-to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s)
-or with their explicit written permission.
-
-5) The Font Software, modified or unmodified, in part or in whole, must be
-distributed entirely under this license, and must not be distributed under any
-other license. The requirement for fonts to remain under this license does not
-apply to any document created using the Font Software.
-
-#### TERMINATION
-This license becomes null and void if any of the above conditions are not met.
-
-#### DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT,
-TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR
-ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL,
-INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF
-CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE
-THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.
--- /dev/null
+=======
+License
+=======
+
+Copyright (C) 2015 Red Hat, Inc.,
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+
+http://scripts.sil.org/OFL
+
+
+=====================
+SIL OPEN FONT LICENSE
+=====================
+
+Version 1.1 - 26 February 2007
+
+PREAMBLE
+========
+
+The goals of the Open Font License (OFL) are to stimulate worldwide development
+of collaborative font projects, to support the font creation efforts of
+academic and linguistic communities, and to provide a free and open framework
+in which fonts may be shared and improved in partnership with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The fonts,
+including any derivative works, can be bundled, embedded, redistributed and/or
+sold with any software provided that any reserved names are not used by
+derivative works. The fonts and derivatives, however, cannot be released under
+any other type of license. The requirement for fonts to remain under this
+license does not apply to any document created using the fonts or their
+derivatives.
+
+DEFINITIONS
+===========
+
+“Font Software” refers to the set of files released by the Copyright Holder(s)
+under this license and clearly marked as such. This may include source files,
+build scripts and documentation.
+
+“Reserved Font Name” refers to any names specified as such after the copyright
+statement(s).
+
+“Original Version” refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+“Modified Version” refers to any derivative made by adding to, deleting, or
+substituting—in part or in whole—any of the components of the Original Version,
+by changing formats or by porting the Font Software to a new environment.
+
+“Author” refers to any designer, engineer, programmer, technical writer or
+other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+=======================
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+the Font Software, to use, study, copy, merge, embed, modify, redistribute, and
+sell modified and unmodified copies of the Font Software, subject to the
+following conditions:
+
+1) Neither the Font Software nor any of its individual components, in Original
+or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy contains
+the above copyright notice and this license. These can be included either as
+stand-alone text files, human-readable headers or in the appropriate machine-
+readable metadata fields within text or binary files as long as those fields
+can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font Name(s)
+unless explicit written permission is granted by the corresponding Copyright
+Holder. This restriction only applies to the primary font name as presented to
+the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software
+shall not be used to promote, endorse or advertise any Modified Version, except
+to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s)
+or with their explicit written permission.
+
+5) The Font Software, modified or unmodified, in part or in whole, must be
+distributed entirely under this license, and must not be distributed under any
+other license. The requirement for fonts to remain under this license does not
+apply to any document created using the Font Software.
+
+TERMINATION
+===========
+
+This license becomes null and void if any of the above conditions are not met.
+
+DISCLAIMER
+==========
+
+THE FONT SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT,
+TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR
+ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL,
+INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE
+THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.
%files
%files docs
-%doc AUTHORS ChangeLog NEWS README README.md
+%doc AUTHORS ChangeLog NEWS README README.rst
%doc %{_vpath_builddir}/libvirt-docs/*
%files daemon
+++ /dev/null
-Libvirt Message Translation
-===========================
-
-Libvirt translatable messages are maintained using the GNU Gettext tools and
-file formats, in combination with the Zanata web service.
-
-python-zanata-client is required in order to use make to pull/push translations
-from/to Zanata server.
-
-Source repository
-=================
-
-The libvirt GIT repository does NOT store the master "libvirt.pot" file, nor
-does it store full "po" files for translations. The master "libvirt.pot" file
-can be generated at any time using
-
- make libvirt.pot
-
-The translations are kept in minimized files that are the same file format
-as normal po files but with all redundant information stripped and messages
-re-ordered. The key differences between the ".mini.po" files in GIT and the
-full ".po" files are
-
- - msgids with no current translation are omitted
- - msgids are sorted in alphabetical order not source file order
- - msgids with a msgstr marked "fuzzy" are discarded
- - source file locations are omitted
-
-The full po files can be created at any time using
-
- make update-po
-
-This merges the "libvirt.pot" with the "$LANG.mini.po" for each language, to
-create the "$LANG.po" files. These are included in the release archives created
-by "make dist".
-
-When a full po file is updated, changes can be propagated back into the
-minimized po files using
-
- make update-mini-po
-
-Note, however, that this is generally not something that should be run by
-developers normally, as it is triggered by 'make pull-po' when refreshing
-content from Zanata.
-
-
-Zanata web service
-==================
-
-The translation of libvirt messages has been outsourced to the Fedora
-translation team using the Zanata web service:
-
- https://fedora.zanata.org/project/view/libvirt
-
-As such, changes to translations will generally NOT be accepted as patches
-directly to libvirt GIT. Any changes made to "$LANG.mini.po" files in libvirt
-GIT will be overwritten and lost the next time content is imported from Zanata.
-
-The master "libvirt.pot" file is periodically pushed to Zanata to provide the
-translation team with content changes, using
-
- make push-pot
-
-New translated text is then periodically pulled down from Zanata to update the
-minimized po files, using
-
- make pull-po
-
-Sometimes the translators make mistakes, most commonly with handling printf
-format specifiers. The "pull-po" command re-generates the .gmo files to try to
-identify such mistakes. If a mistake is made, the broken msgstr should be
-deleted in the local "$LANG.mini.po" file, and the Zanata web interface used
-to reject the translation so that the broken msgstr isn't pulled down next time.
-
-After pulling down new content the diff should be examined to look for any
-obvious mistakes that are not caught automatically. There have been bugs in
-Zanata tools which caused messges to go missing, so pay particular attention to
-diffs showing deletions where the msgid still exists in libvirt.pot
--- /dev/null
+===========================
+Libvirt Message Translation
+===========================
+
+Libvirt translatable messages are maintained using the GNU Gettext tools and
+file formats, in combination with the Zanata web service.
+
+python-zanata-client is required in order to use make to pull/push translations
+from/to Zanata server.
+
+
+Source repository
+=================
+
+The libvirt GIT repository does NOT store the master "libvirt.pot" file, nor
+does it store full "po" files for translations. The master "libvirt.pot" file
+can be generated at any time using
+
+::
+
+ $ make libvirt.pot
+
+The translations are kept in minimized files that are the same file format
+as normal po files but with all redundant information stripped and messages
+re-ordered. The key differences between the ".mini.po" files in GIT and the
+full ".po" files are
+
+* msgids with no current translation are omitted
+* msgids are sorted in alphabetical order not source file order
+* msgids with a msgstr marked "fuzzy" are discarded
+* source file locations are omitted
+
+The full po files can be created at any time using
+
+::
+
+ $ make update-po
+
+This merges the "libvirt.pot" with the "$LANG.mini.po" for each language, to
+create the "$LANG.po" files. These are included in the release archives created
+by "make dist".
+
+When a full po file is updated, changes can be propagated back into the
+minimized po files using
+
+::
+
+ $ make update-mini-po
+
+Note, however, that this is generally not something that should be run by
+developers normally, as it is triggered by 'make pull-po' when refreshing
+content from Zanata.
+
+
+Zanata web service
+==================
+
+The translation of libvirt messages has been outsourced to the Fedora
+translation team using the Zanata web service:
+
+https://fedora.zanata.org/project/view/libvirt
+
+As such, changes to translations will generally NOT be accepted as patches
+directly to libvirt GIT. Any changes made to "$LANG.mini.po" files in libvirt
+GIT will be overwritten and lost the next time content is imported from Zanata.
+
+The master "libvirt.pot" file is periodically pushed to Zanata to provide the
+translation team with content changes, using
+
+::
+
+ $ make push-pot
+
+New translated text is then periodically pulled down from Zanata to update the
+minimized po files, using
+
+::
+
+ $ make pull-po
+
+Sometimes the translators make mistakes, most commonly with handling printf
+format specifiers. The "pull-po" command re-generates the .gmo files to try to
+identify such mistakes. If a mistake is made, the broken msgstr should be
+deleted in the local "$LANG.mini.po" file, and the Zanata web interface used
+to reject the translation so that the broken msgstr isn't pulled down next time.
+
+After pulling down new content the diff should be examined to look for any
+obvious mistakes that are not caught automatically. There have been bugs in
+Zanata tools which caused messges to go missing, so pay particular attention to
+diffs showing deletions where the msgid still exists in libvirt.pot
+++ /dev/null
-About
-=====
-This is the project of Google Summer of Code 2013 accepted by QEMU.org and
-libvirt community. The goal of this project is, provide Wireshark dissector for
-Libvirt RPC protocol. It will provide Libvirt packet overview/detail analysing
-in Wireshark. Furthermore, it will be able to build(generated) from RPC protocol
-definition placed in Libvirt source tree to support latest protocol
-specification.
-
-See also:
-- http://www.google-melange.com/gsoc/project/google/gsoc2013/kawamuray/7001
-- https://wiki.qemu.org/Features/LibvirtWiresharkDissector
-
-Installation
-=============
-Run ./configure with --with-wireshark-dissector option enabled.
-Then dissector will compiled with libvirt itself.
-
-Add/Remove protocol from dissector's support
---------------------------------------------
-Modify variable WS\_DISSECTOR\_PROTO\_FILES in tools/wireshark/src/Makefile.am.
-
-Changing installation directory
--------------------------------
-You can change installation directory of pluggable shared object(libvirt.so) by
-specifying --with-ws-plugindir=<path>.
-
-You can install libvirt.so into your local wireshark plugin directory:
-
- ./configure --with-wireshark-dissector \
- --with-ws-plugindir=$HOME/.wireshark/plugins
--- /dev/null
+=====
+About
+=====
+
+This is the project of Google Summer of Code 2013 accepted by QEMU.org and
+libvirt community. The goal of this project is, provide Wireshark dissector for
+Libvirt RPC protocol. It will provide Libvirt packet overview/detail analysing
+in Wireshark. Furthermore, it will be able to build(generated) from RPC protocol
+definition placed in Libvirt source tree to support latest protocol
+specification.
+
+See also:
+
+* http://www.google-melange.com/gsoc/project/google/gsoc2013/kawamuray/7001
+* https://wiki.qemu.org/Features/LibvirtWiresharkDissector
+
+
+Installation
+=============
+
+Run ``./configure`` with ``--with-wireshark-dissector`` option enabled.
+Then dissector will compiled with libvirt itself.
+
+Add/Remove protocol from dissector's support
+--------------------------------------------
+
+Modify variable ``WS_DISSECTOR_PROTO_FILES``
+in ``tools/wireshark/src/Makefile.am``.
+
+Changing installation directory
+-------------------------------
+
+You can change installation directory of pluggable shared
+object(``libvirt.so``) by specifying ``--with-ws-plugindir=<path>``.
+
+You can install ``libvirt.so`` into your local wireshark plugin directory:
+
+::
+
+ $ ./configure --with-wireshark-dissector \
+ --with-ws-plugindir=$HOME/.wireshark/plugins
projects / libvirt.git / commitdiff