[Gluster-devel] doc-patch!

[Harshavardhana Ranganath]

gluster.texi patch with building with iso as texinfo document.
-------------- next part --------------
--- gluster.texi	2006-01-24 12:01:36.000000000 +0530
+++ /root/texi/gluster/gluster.texi	2006-01-25 15:50:55.000000000 +0530
@@ -13,7 +13,8 @@
 @end direntry
 
 @ifinfo
- at noident This file documents Gluster version @value{VERSION}
+ at noindent 
+This file documents Gluster version @value{VERSION}
 Gluster is a GNU/Linux Live distribution, used to run clustering
 applications.
 
@@ -24,7 +25,8 @@ Copyright @copyright{} 2005 Z RESEARCH, 
 @include permissions.texi
 
 @titlepage
- at title Gluster - GNU Clustering Meta Distribution version @value{VERSION}
+ at title Gluster - GNU Clustering Meta Distribution
+ at title Version @value{VERSION}
 @subtitle Introduction , @value{UPDATED}
 @author Harshavardhana @email{harsha@@80x25.org}
 
@@ -67,6 +69,8 @@ applications.
 
 @c @noindent Copyright @copyright{} 2005 Gluster Core Team.
 @menu
+Gluster Summary
+
 * Overview::                    What is gluster?.
 * Arch::                        Gluster Architecture.
 * Extensions::                  Gluster's Key Modularity.
@@ -76,6 +80,7 @@ applications.
 * Build Process::               Gluster Distro Build.
 * Portability::                 Porting Gluster.
 * Concept Index::               
+
 @end menu
 @end ifinfo
 
@@ -84,26 +89,23 @@ applications.
 Gluster is a GNU/Linux Live distribution, used to run clustering
 applications.
 Gluster is modular system, extended in Python.
-
 Few of the applications Gluster [will] run are:
- at itemsize @bullet
+ at itemize @bullet
 @item
 GInstaller - GInstaller is an application used to replicate a
 GNU/Linux installation on a cluster.
-
- at item 
+ at item
 Gluster-SSI/NUMA - SSI - Single System Image.
 ....fill more......
 
- at end itemsize
+ at end itemize
 @cindex What is Gluster?
 
 @node Arch, Extensions, Overview, Top
 @chapter Gluster Architecture
 
 Gluster Runtime has three stages of operation
-
- at itemsize @bullet
+ at itemize @bullet
 @item
 Stage 1 (Bootstrapping)
 
@@ -112,8 +114,7 @@ are loaded either from ISO, USB or Netwo
 
 The only goal of this stage is to load the kernel and initrd and boot
 the kernel.
-   
- at item
+ at item   
 Stage 2 (Probe for Stage 3)
 
 Gluster being modular, has all its features as extensions. These
@@ -122,13 +123,11 @@ be used from NFS mount etc.
 
 The goal of Stage 2 is to probe for the location of Stage 3 (extensions)
 and load the 'core' extension, which takes control thereof.
-
 @item
 Stage 3 (Applications and extensions)
 
 Applications, like GInstaller, GlusterSSI are part of Stage-3.
-
- at end itemsize
+ at end itemize
 @cindex Architecture
 
 
@@ -144,9 +143,12 @@ Gluster libraries, and an application lo
 Format of an Extension
 
 An extension to Gluster consist of two files -
-a) A specification file [filename.gex]
-b) A tarball [filename.tgz]
-
+ at itemize @bullet
+ at item
+ A specification file [filename.gex]
+ at item
+ A tarball [filename.tgz]
+ at end itemize
 The .gex file has meta information about the extension, like, what kind
 of extension this is (Application, simple package, tool, library), what it
 does, who is the maintainer, what is the .tgz corresponding to this
@@ -161,13 +163,18 @@ script, anything which can be executed.
 It is upto the `runme' script to do whatever it wants. Usually the things
 it might want to do are -
 
-a)If the extension provides a package, the runme would copy the .so files
+ at itemize @bullet
+ at item
+If the extension provides a package, the runme would copy the .so files
 to the system lib repository /usr/lib etc.
-b)Install other extension which it depends on.
-c)If the extension provides tools for Gluster, copy them to 
+ at item
+Install other extension which it depends on.
+ at item
+If the extension provides tools for Gluster, copy them to 
 /usr/share/gluster/extensions/<name>/<name>
 If another extension needs to use this tool, it should look for it
 in /usr/share/gluster/extensions/<toolname>/<toolname>
+ at end itemize
 
 So, the extensions `runme' decides the characteristic of an extension,
 and it is totally in the `runme's hands what an extension does, or doesnt.
@@ -206,16 +213,23 @@ Client nodes in Gluster can boot
 
 @cindex Boot Mechanism
 
- at node Build Process, Gluster License, Client Boot, Top
+ at node Build Process, Portability, Client Boot, Top
 @chapter Build Process
-
-1. Overview - Gluster build process generates a bootable Guster ISO, using which you
+ at itemize @bullet
+ at item
+Overview - Gluster build process generates a bootable Guster ISO, using which you
 boot the master node.
-2. Third party packages
-3. Native compile and Cross compile
-4. Stage 2 installs and Extension/Stage 3 installs
-5. Adding a new third party package
-6. Adding a new Extension
+ at item
+Third party packages
+ at item
+Native compile and Cross compile
+ at item
+Stage 2 installs and Extension/Stage 3 installs
+ at item
+Adding a new third party package
+ at item
+Adding a new Extension
+ at end itemize
 
 @cindex Building Gluster