From 7ebe214942038d777fa779b620f245ed92b12eb2 Mon Sep 17 00:00:00 2001 From: Justin Clift Date: Fri, 10 Sep 2010 19:26:05 +1000 Subject: [PATCH] docs: add the app dev guide Added a workable initial page for the libvirt Application Development Guide, giving the online viewable options + the available download ones (pdf, epub, srpm). Added a link to the PDF to the main Downloads page, plus neatened the html tags throughout the page as they were a bit of a mess. Added --enable-compile-warnings=error to the autogen line, as suggested by Eric Blake. --- docs/devguide.html.in | 53 ++++++++++++++ docs/downloads.html.in | 154 ++++++++++++++++++++++++++--------------- docs/sitemap.html.in | 4 ++ 3 files changed, 157 insertions(+), 54 deletions(-) create mode 100644 docs/devguide.html.in diff --git a/docs/devguide.html.in b/docs/devguide.html.in new file mode 100644 index 0000000000..409952e4f7 --- /dev/null +++ b/docs/devguide.html.in @@ -0,0 +1,53 @@ + + + +

libvirt Application Development Guide

+ +

+ This is both a guide to developing with libvirt, and a useful + reference document. It is a work in progress, contributed to by the + members of the libvirt team and being authored by a professional + author. +

+ +

+ Contributors to this are VERY welcome, so if you'd like to + get your name in this and demonstrate your virtualisation prowess, + contributing solidly to the content here will do it. :) +

+ +

Browsable online

+ + + +

GIT source repository

+ +

+ The source is in a git repository: +

+ + 
+      git clone git://libvirt.org/libvirt-appdev-guide.git
+ +

+ Browsable here: +

+ + 
+      http://libvirt.org/git/?p=libvirt-appdev-guide.git;a=summary
+ + + diff --git a/docs/downloads.html.in b/docs/downloads.html.in index 6872272247..66b99e11de 100644 --- a/docs/downloads.html.in +++ b/docs/downloads.html.in @@ -1,7 +1,7 @@ -

Downloads

+

Downloads

Official Releases

@@ -27,62 +27,108 @@
  • libvirt.org HTTP server
    • -

    GIT source repository

    -

    Libvirt code source is now maintained in a git repository available on - libvirt.org: +

    GIT source repository

    + +

    + Libvirt code source is now maintained in a git + repository available on libvirt.org:

    - 
     
-      git clone git://libvirt.org/libvirt.git
-
    -

    - It can also be browsed at + 

    +      git clone git://libvirt.org/libvirt.git
    + +

    + It can also be browsed at: +

    + + 
    +      http://libvirt.org/git/?p=libvirt.git;a=summary
    + +
    + +

    libvirt Application Development Guide

    + +

    + This is both a guide to developing with libvirt, and a useful + reference document. It is a work in progress, contributed to by the + members of the libvirt team and being authored by a professional + author. +

    + +

    + Contributors to this are VERY welcome, so if you'd like to + get your name in this and demonstrate your virtualisation prowess, + contributing solidly to the content here will do it. :)

    - 
    -
-      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 - templates using the autogen.sh command, passing the extra - arguments as for configure. As an example, to do a complete build and - install it into your home directory run:

    - 
    -
-      ./autogen.sh --prefix=$HOME/usr
+
+    
    Downloadable PDF
    
+
+    
    
+      PDF download is available here:
+    
    
+
+    
+
+    
    GIT source repository
    
+
+    
    
+      The source is also in a git repository:
+    
    
+
+    
    +      git clone git://libvirt.org/libvirt-appdev-guide.git
    
+
+    
    
+      Browsable at:
+    
    
+
+    
    +      http://libvirt.org/git/?p=libvirt-appdev-guide.git;a=summary
    
+
+    
    
+
+    
    libvirt Installation
    
+
+    
    Compilation
    
+
+    
    
+      libvirt uses the standard configure/make/install steps:
+    
    
+
+    
    +      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
+      templates using the autogen.sh command, passing the extra
+      arguments as for configure. As an example, to do a complete build and
+      install it into your home directory run:
+    
    
+
+    
    +      ./autogen.sh --prefix=$HOME/usr --enable-compile-warnings=error
       make
-      make install
-    
    
+      make install
    diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in index e9ab591bdc..bb9cd8e82e 100644 --- a/docs/sitemap.html.in +++ b/docs/sitemap.html.in @@ -258,6 +258,10 @@ +
  • + Development Guide + A guide and reference for developing with libvirt +
  • -- GitLab