From nobody Mon Apr 29 07:23:50 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1494931846768435.84553861115853; Tue, 16 May 2017 03:50:46 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 4491E80C05; Tue, 16 May 2017 10:50:44 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 52F606292C; Tue, 16 May 2017 10:50:42 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 0F5FC180BAF1; Tue, 16 May 2017 10:50:38 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id v4GAoY8n003501 for ; Tue, 16 May 2017 06:50:34 -0400 Received: by smtp.corp.redhat.com (Postfix) id 971755C3F8; Tue, 16 May 2017 10:50:32 +0000 (UTC) Received: from t460.redhat.com (unknown [10.36.118.16]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4DDE958823; Tue, 16 May 2017 10:50:29 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 4491E80C05 Authentication-Results: ext-mx02.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx02.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=libvir-list-bounces@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 4491E80C05 From: "Daniel P. Berrange" To: libvir-list@redhat.com Date: Tue, 16 May 2017 11:50:27 +0100 Message-Id: <20170516105027.12597-1-berrange@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH] Provide a useful README file X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.26]); Tue, 16 May 2017 10:50:45 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" The current README file contents has almost no useful info, and that which does exist is very outdated. Signed-off-by: Daniel P. Berrange --- README | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----= ---- 1 file changed, 71 insertions(+), 10 deletions(-) diff --git a/README b/README index 3d5167d..7103ae9 100644 --- a/README +++ b/README @@ -1,13 +1,74 @@ + Libvirt API for virtualization + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D =20 - LibVirt : simple 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 PowerHyp. =20 - Libvirt is a C toolkit to interact with the virtualization capabilities -of recent versions of Linux (and other OSes). It is free software -available under the GNU Lesser General Public License. Virtualization of -the Linux Operating System means the ability to run multiple instances of -Operating Systems concurrently on a single hardware system where the basic -resources are driven by a Linux instance. The library aim at providing -long term stable C API initially for the Xen paravirtualization but -should be able to integrate other virtualization mechanisms if needed. +For some of these hypervisors, it provides a stateful management +daemon runs on the virtualization host allowing access to the API +both by non-privileged local users and remote users. =20 -Daniel Veillard +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 +=3D=3D=3D=3D=3D=3D=3D + +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 restricted GNU General +Public License, version 2.1 (or later). See the files COPYING.LESSER +and COPYING for full license terms & conditions. + +Installation +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Libvirt uses the GNU Autotools build system, so in general can be built +and installed with the normal commands. For example, to build in a manner +that is suitable for installing as root, use: + + ./configure --prefix=3D/usr --sysconfdir=3D/etc --localstatedir=3D/var + make + sudo make install + +While to build & install as an unprivileged user + + ./configure --prefix=3D$HOME/usr + make + make install + +The libvirt code relies on a large number of 3rd party libraries. These wi= ll +be detected during execution of the configure script and a summary printed +which lists any missing (optional) dependancies. + +Contributing +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The libvirt project welcomes contributors from all. For most components +the best way to contributor is to send patches to the primary development +mailing list, using the 'git send-email' command. Further guidance on this +can be found in the HACKING file, or the project website + + https://libvirt.org/contribute.html + +Contact +=3D=3D=3D=3D=3D=3D=3D + +The libvirt project has two primary mailing lists: + + * libvir-list@redhat.com (for development) + * libvirt-users@redhat.com (for users) + +Further details on contacting the project are available on the website + + https://libvirt.org/contact.html + +-- End --=20 2.9.3 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list