[libvirt] [PATCH] website: Drop static FAQ, point to http://wiki.libvirt.org/page/FAQ
The static FAQ was from the days before even QEMU support. I added a few questions to the wiki FAQ about the software license and how to download and install (basically just pointing to downloads.html). The remaining questions on the static page aren't anything that I think is really 'frequently asked' (changing socket perms for regular user xen access, and issues building against libvirt). Signed-off-by: Cole Robinson <crobinso@redhat.com> --- docs/FAQ.html.in | 144 -------------------------------------------------- docs/Makefile.am | 3 +- docs/search.php | 2 +- docs/sitemap.html.in | 2 +- 4 files changed, 3 insertions(+), 148 deletions(-) delete mode 100644 docs/FAQ.html.in diff --git a/docs/FAQ.html.in b/docs/FAQ.html.in deleted file mode 100644 index 50f798d..0000000 --- a/docs/FAQ.html.in +++ /dev/null @@ -1,144 +0,0 @@ -<?xml version="1.0"?> -<html> - <body> - <h1 >FAQ</h1> - <p>Table of Contents:</p> - <ul> - <li> - <a href="FAQ.html#License">License(s)</a> - </li> - <li> - <a href="FAQ.html#Installati">Installation</a> - </li> - <li> - <a href="FAQ.html#Compilatio">Compilation</a> - </li> - <li> - <a href="FAQ.html#Developer">Developer corner</a> - </li> - </ul> - <h3><a name="License" id="License">License</a>(s)</h3> - <ol> - <li> - <em>Licensing Terms for libvirt</em> - <p>libvirt is released under the <a href="http://www.opensource.org/licenses/lgpl-license.html">GNU Lesser - General Public License</a>, 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.</p> - </li> - <li> - <em>Can I embed libvirt in a proprietary application ?</em> - <p>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.</p> - </li> - </ol> - <h3> - <a name="Installati" id="Installati">Installation</a> - </h3> - <ol> - <li><em>Where can I get libvirt</em> ? - <p>The original distribution comes from <a href="ftp://libvirt.org/libvirt/">ftp://libvirt.org/libvirt/</a>.</p> - </li> - <li> - <em>I can't install the libvirt/libvirt-devel RPM packages due to - failed dependencies</em> - <p>The most generic solution is to re-fetch the latest src.rpm , and - rebuild it locally with</p> - <p><code>rpm --rebuild libvirt-xxx.src.rpm</code>.</p> - <p>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.</p> - <p>One can also rebuild the RPMs from a tarball:</p> - <p> - <code>rpmbuild -ta libdir-xxx.tar.gz</code> - </p> - <p>Or from a configured tree with:</p> - <p> - <code>make rpm</code> - </p> - </li> - <li> - <em>Failure to use the API for non-root users</em> - <p>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:</p> - <p> - <code>chmod 666 /var/run/xenstored/socket_ro</code> - </p> - <p>and also make sure that the Xen Daemon is running correctly with local - HTTP server enabled, this is defined in - <code>/etc/xen/xend-config.sxp</code> which need the following line to be - enabled:</p> - <p> - <code>(xend-http-server yes)</code> - </p> - <p>If needed restart the xend daemon after making the change with the - following command run as root:</p> - <p> - <code>service xend restart</code> - </p> - </li> - </ol> - <h3> - <a name="Compilatio" id="Compilatio">Compilation</a> - </h3> - <ol> - <li> - <em>What is the process to compile libvirt ?</em> - <p>As most UNIX libraries libvirt follows the "standard":</p> - <p> - <code>gunzip -c libvirt-xxx.tar.gz | tar xvf -</code> - </p> - <p> - <code>cd libvirt-xxxx</code> - </p> - <p> - <code>./configure --help</code> - </p> - <p>to see the options, then the compilation/installation proper</p> - <p> - <code>./configure [possible options]</code> - </p> - <p> - <code>make</code> - </p> - <p> - <code>make install</code> - </p> - <p>At that point you may have to rerun ldconfig or a similar utility to - update your list of installed shared libs.</p> - </li> - <li> - <em>What other libraries are needed to compile/install libvirt ?</em> - <p>Libvirt requires libxenstore, which is usually provided by the xen - packages as well as the public headers to compile against libxenstore.</p> - </li> - <li> - <em>I use the GIT version and there is no configure script</em> - <p>The configure script (and other Makefiles) are generated. Use the - autogen.sh script to regenerate the configure script and Makefiles, - like:</p> - <p> - <code>./autogen.sh --prefix=/usr --disable-shared</code> - </p> - </li> - </ol> - <h3><a name="Developer" id="Developer">Developer</a> corner</h3> - <ol> - <li> - <em>Troubles compiling or linking programs using libvirt</em> - <p>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:</p> - <p> - <code>pkg-config libvirt --libs</code> - </p> - </li> - </ol> - </body> -</html> diff --git a/docs/Makefile.am b/docs/Makefile.am index edf6fc8..57f3d3d 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -147,8 +147,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/search.php b/docs/search.php index a6c1def..bbd652a 100644 --- a/docs/search.php +++ b/docs/search.php @@ -258,7 +258,7 @@ </li><li> <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a> </li><li> - <a title="Frequently asked questions" class="inactive" href="FAQ.html">FAQ</a> + <a title="Frequently asked questions" class="inactive" href="http://wiki.libvirt.org/page/FAQ">FAQ</a> </li><li> <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a> </li><li> diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in index 76d8faa..aaa0966 100644 --- a/docs/sitemap.html.in +++ b/docs/sitemap.html.in @@ -247,7 +247,7 @@ <span>User contributed content</span> </li> <li> - <a href="FAQ.html">FAQ</a> + <a href="http://wiki.libvirt.org/page/FAQ">FAQ</a> <span>Frequently asked questions</span> </li> <li> -- 1.6.6.1
On Wed, Mar 17, 2010 at 03:32:55PM -0400, Cole Robinson wrote:
The static FAQ was from the days before even QEMU support. I added a few questions to the wiki FAQ about the software license and how to download and install (basically just pointing to downloads.html).
The remaining questions on the static page aren't anything that I think is really 'frequently asked' (changing socket perms for regular user xen access, and issues building against libvirt).
I would like to keep the basic build instructions and rpm rebuild ones as part of the static docs which are distributed with the sources, and not have to rely on web + wiki working. So I'm fine removing this only if we put the informations in another places in the static documetnation, I don't want them just removed. Daniel -- Daniel Veillard | libxml Gnome XML XSLT toolkit http://xmlsoft.org/ daniel@veillard.com | Rpmfind RPM search engine http://rpmfind.net/ http://veillard.com/ | virtualization library http://libvirt.org/
participants (2)
-
Cole Robinson -
Daniel Veillard