From: Cole Robinson Date: Mon, 26 Jul 2010 14:32:42 +0000 (-0400) Subject: docs: Link wiki FAQ to main page X-Git-Tag: v0.8.3~60 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f8b76f419ad4ce26556d34a03a7ceaa3a77c25a7;p=thirdparty%2Flibvirt.git docs: Link wiki FAQ to main page Since DV recommended keeping the build instructions distributed with the source, move them from the old FAQ to the downloads page. --- diff --git a/docs/FAQ.html.in b/docs/FAQ.html.in deleted file mode 100644 index 50f798d9df..0000000000 --- a/docs/FAQ.html.in +++ /dev/null @@ -1,144 +0,0 @@ - - - -

FAQ

Table of Contents:

License(s)

- Licensing Terms for libvirt -
libvirt is released under the GNU Lesser - General Public License, see the file COPYING.LIB in the distribution - for the precise wording. The only library that libvirt depends upon is - the Xen store access library which is also licenced under the LGPL.
-
- Can I embed libvirt in a proprietary application ? -
Yes. The LGPL allows you to embed libvirt into a proprietary - application. It would be graceful to send-back bug fixes and improvements - as patches for possible incorporation in the main development tree. It - will decrease your maintenance costs anyway if you do so.
-

- Installation -

Where can I get libvirt ? -
The original distribution comes from ftp://libvirt.org/libvirt/.
-
- I can't install the libvirt/libvirt-devel RPM packages due to - failed dependencies -
The most generic solution is to re-fetch the latest src.rpm , and - rebuild it locally with
-
rpm --rebuild libvirt-xxx.src.rpm.
-
If everything goes well it will generate two binary rpm packages (one - providing the shared libs and virsh, and the other one, the -devel - package, providing includes, static libraries and scripts needed to build - applications with libvirt that you can install locally.
-
One can also rebuild the RPMs from a tarball:
-
- rpmbuild -ta libdir-xxx.tar.gz -
-
Or from a configured tree with:
-
- make rpm -
-
- Failure to use the API for non-root users -
Large parts of the API may only be accessible with root privileges, - however the read only access to the xenstore data doesnot have to be - forbidden to user, at least for monitoring purposes. If "virsh dominfo" - fails to run as an user, change the mode of the xenstore read-only socket - with:
-
- chmod 666 /var/run/xenstored/socket_ro -
-
and also make sure that the Xen Daemon is running correctly with local - HTTP server enabled, this is defined in - /etc/xen/xend-config.sxp which need the following line to be - enabled:
-
- (xend-http-server yes) -
-
If needed restart the xend daemon after making the change with the - following command run as root:
-
- service xend restart -
-

- Compilation -

- What is the process to compile libvirt ? -
As most UNIX libraries libvirt follows the "standard":
-
- gunzip -c libvirt-xxx.tar.gz | tar xvf - -
-
- cd libvirt-xxxx -
-
- ./configure --help -
-
to see the options, then the compilation/installation proper
-
- ./configure [possible options] -
-
- make -
-
- make install -
-
At that point you may have to rerun ldconfig or a similar utility to - update your list of installed shared libs.
-
- What other libraries are needed to compile/install libvirt ? -
Libvirt requires libxenstore, which is usually provided by the xen - packages as well as the public headers to compile against libxenstore.
-
- I use the GIT version and there is no configure script -
The configure script (and other Makefiles) are generated. Use the - autogen.sh script to regenerate the configure script and Makefiles, - like:
-
- ./autogen.sh --prefix=/usr --disable-shared -
-

Developer corner

- Troubles compiling or linking programs using libvirt -
To simplify the process of reusing the library, libvirt comes with - pkgconfig support, which can be used directly from autoconf support or - via the pkg-config command line tool, like:
-
- pkg-config libvirt --libs -
-

- - diff --git a/docs/Makefile.am b/docs/Makefile.am index a6a6d073c5..114ea1f546 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -159,8 +159,7 @@ rebuild: api all install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) - -$(INSTALL) -m 0644 $(srcdir)/FAQ.html \ - $(srcdir)/Libxml2-Logo-90x34.gif $(DESTDIR)$(HTML_DIR) + -$(INSTALL) -m 0644 $(srcdir)/Libxml2-Logo-90x34.gif $(DESTDIR)$(HTML_DIR) $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/html for h in $(apihtml); do \ $(INSTALL) -m 0644 $(srcdir)/$$h $(DESTDIR)$(HTML_DIR)/html; done diff --git a/docs/downloads.html.in b/docs/downloads.html.in index a0cb6fcf6d..04fd16cf0e 100644 --- a/docs/downloads.html.in +++ b/docs/downloads.html.in @@ -43,6 +43,35 @@ http://libvirt.org/git/?p=libvirt.git;a=summary + +

Installation

+ Compilation +

As most UNIX libraries libvirt follows the "standard":

+ gunzip -c libvirt-xxx.tar.gz | tar xvf - +

+ cd libvirt-xxxx +

+ ./configure --help +

to see the options, then the compilation/installation proper

+ ./configure [possible options] +

+ make +

+ make install +

At that point you may have to rerun ldconfig or a similar utility to + update your list of installed shared libs.

Building from a source code checkout

The libvirt build process uses GNU autotools, so after obtaining a checkout it is necessary to generate the configure script and Makefile.in diff --git a/docs/search.php b/docs/search.php index a6c1defd64..bbd652aab6 100644 --- a/docs/search.php +++ b/docs/search.php @@ -258,7 +258,7 @@

Wiki

- FAQ + FAQ

Bug reports

diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in index 404ce5a941..e9ab591bdc 100644 --- a/docs/sitemap.html.in +++ b/docs/sitemap.html.in @@ -265,7 +265,7 @@ User contributed content

- FAQ + FAQ Frequently asked questions