shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-02-10 17:57:25 +03:00
Code Releases Activity
libvirt/README.rst

95 lines
3.0 KiB
ReStructuredText
Raw Normal View History

README: Add GitLab CI badge We've moved most of our CI jobs to GitLab, so we should display the corresponding badge prominently. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 15:19:54 +02:00
.. image:: https://gitlab.com/libvirt/libvirt/badges/master/pipeline.svg
:target: https://gitlab.com/libvirt/libvirt/pipelines
:alt: GitLab CI Build Status
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
.. 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
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
==============================
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
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:
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
https://libvirt.org
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
License
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
=======
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
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
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
Public License, version 2.0 (or later). See the files ``COPYING.LESSER``
and ``COPYING`` for full license terms & conditions.
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
Installation
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
============
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
Libvirt uses the GNU Autotools build system, so in general can be built
build: mandate use of a build dir != src dir Historically we've allowed builds in the main src dir, but meson does not support this. Explicitly force separate build dir in autotools to align with meson. We must re-enable dependency tracking which the RPM %configure macro turns off. Without this, the build dir doesn't get the source directory tree mirrored. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Pavel Hrdina <phrdina@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2019-11-06 15:55:12 +01:00
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:
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
::
$ mkdir build && cd build
$ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
$ make
$ sudo make install
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
While to build & install as an unprivileged user
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
::
$ mkdir build && cd build
$ ../configure --prefix=$HOME/usr
$ make
$ make install
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
The libvirt code relies on a large number of 3rd party libraries. These will
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
be detected during execution of the ``configure`` script and a summary printed
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
which lists any missing (optional) dependencies.
Contributing
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
============
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
The libvirt project welcomes contributions in many ways. For most components
the best way to contribute is to send patches to the primary development
HACKING: Drop from the git repository Despite being a generated file, HACKING has been tracked in the git repository along with actual source files. As far as I'm aware, it's the only generated file for which that happens. Times and times again, people[1] have committed changes to the source file without refreshing the generated copy at the same time. The rationale for tracking the generated file is to help out people who just cloned the git repository looking to contribue; however, README-hacking already contains enough information to get perspective contributors to a place where they can simply look at docs/hacking.html instead. [1] Mostly me, to be honest Signed-off-by: Andrea Bolognani <abologna@redhat.com>
2017-06-26 08:45:44 +02:00
mailing list. Further guidance on this can be found on the website:
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
https://libvirt.org/contribute.html
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
Contact
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
=======
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
The libvirt project has two primary mailing lists:
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
* libvirt-users@redhat.com (**for user discussions**)
* libvir-list@redhat.com (**for development only**)
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
README: Various minor style tweaks Signed-off-by: Andrea Bolognani <abologna@redhat.com>
2017-06-26 11:01:03 +02:00
Further details on contacting the project are available on the website:
Provide a useful README file The current README file contents has almost no useful info, and that which does exist is very outdated. Reviewed-by: Andrea Bolognani <abologna@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-05-16 11:48:17 +01:00
Convert all remaining Markdown files to reStructuredText We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com>
2020-04-14 12:59:04 +02:00
https://libvirt.org/contact.html
Copy Permalink