Re: Patch for How-To documentation

"Ganesh Jayaraman" <[email protected]>
Newsgroups gmane.text.xml.xindice.devel
Message-ID <[email protected]> 
Thanks Vadim :)

Here is the patch for windows.xml to bring it up to version 1.2.

If I am preparing the patches in the correct format, I can keep
sending the patches in the simillar manner. Next I am planning to fix
the documentation and build.xml for the examples.

Regards,
Ganesh

On 9/26/07, Vadim Gritsenko <[email protected]> wrote:
> Ganesh Jayaraman wrote:
> > svn diff of xml-xindice/src/documentation/content/xdocs/community/howto/compilation/unix.xml
>
> Applied. Only modification I made is I replaced "host:{XINDICE_HOME}&gt;" with
> simple "$" for cleaner look. Now you need to patch windows.xml, so that these
> two pages stay in sync! :)
>
> Couple of tips:
>
>   * Easiest way to produce patch (for all modified files at once) is to use
>     svn command from xml-xindice directory:
>       svn diff > my.patch
>
>     Or for single file/directory:
>       svn diff path/to/file > my.patch
>
>
>   * Please send patches as attachments, otherwise mail clients can
>     wrap long lines and break the patch.
>
>
> Vadim
>
>
compile.patch (application/octet-stream, 6.8 KB) 
Index: src/documentation/content/xdocs/community/howto/compilation/windows.xml
===================================================================
--- src/documentation/content/xdocs/community/howto/compilation/windows.xml	(revision 580206)
+++ src/documentation/content/xdocs/community/howto/compilation/windows.xml	(working copy)
@@ -23,15 +23,16 @@
 
 <!--
   - Version: $Revision$ $Date$
+  - Author: Ganesh Babu J ([email protected])
   -->
 <howto>
   <header>
     <title>Compiling Xindice on Windows</title>
-    <version>1.0</version>
+    <version>1.2</version>
     <authors>
       <person name="Dave Viner" email="[email protected]"/>
     </authors>
-    <last-modified-content-date date="2002-11-21"/>
+    <last-modified-content-date date="2007-09-27"/>
   </header>
 
   <audience title="Intended audience">
@@ -39,7 +40,7 @@
   </audience>
   <purpose title="Purpose">
     <p>
-      Following the steps of this how-to should allow you to compile Xindice on windows.
+      Following the steps of this how-to should allow you to compile Xindice on Windows.
     </p>
   </purpose>
   <prerequisites title="Prerequisites">
@@ -52,6 +53,19 @@
       <p>Be sure to follow the <link href="prereqs.html">prerequisites.</link>
       </p>
     </section>
+	<section>
+      <title>Place holders used in the Steps</title>
+      <p>
+      </p>
+      <ul>
+        <li>
+        <code>{XINDICE_HOME}</code> - Directory where you have unzipped your Xindice source files.
+        </li>
+        <li>
+        <code>{JAVA_VERSION}</code> - Installed JDK Version.
+        </li>
+      </ul>
+    </section>    
     <section>
       <title>Verify your environment</title>
       <p>
@@ -62,109 +76,67 @@
         Make sure you have the JAVA_HOME environment variable set.
       </p>
       <source>
-  C:\&gt;echo %JAVA_HOME%
-  C:\j2sdk1.4.1_01
-
-  C:\&gt;
+  &gt; echo %JAVA_HOME%
+  C:\j2sdk{JAVA_VERSION}
       </source>
     </section>
     <section>
       <title>Compile</title>
-      <p>
-        Navigate to your the location where you unzipped your Xindice sources
-        and run the compile.
+       <p>Navigate to the location where you unzipped your Xindice sources
+        (or to your svn checkout of Xindice source code) and run the
+        <code>build</code> batch file. Your output will resemble:
       </p>
-      <note>
-        This example assumes that you unzip the Xindice sources into
-        D:\xindice\current. If you unzip the sources elsewhere, just
-        substitute that path for D:\xindice\current.</note>
       <source>
-  C:\&gt;d:
-
-  D:\&gt;cd xindice\current\xml-xindice
-  D:\xindice\current\xml-xindice&gt;dir
-  Volume in drive D is Data
-  Volume Serial Number is A3EB-9689
-
-  Directory of D:\xindice\current\xml-xindice
-
-  11/20/2002  08:40p      &lt;DIR&gt;          .
-  11/20/2002  08:40p      &lt;DIR&gt;          ..
-  10/29/2002  11:59a               1,507 .classpath
-  10/29/2002  11:59a                  64 .cvsignore
-  10/29/2002  11:59a                 387 .project
-  11/18/2002  01:41p      &lt;DIR&gt;          bin
-  11/20/2002  10:20a      &lt;DIR&gt;          build
-  12/06/2001  10:33a                 864 build.bat
-  10/26/2002  05:06p                 431 build.properties.sample
-  10/25/2002  01:18a                 753 build.sh
-  11/18/2002  01:41p              14,109 build.xml
-  11/20/2002  02:43p      &lt;DIR&gt;          classes
-  11/18/2002  01:41p      &lt;DIR&gt;          config
-  10/25/2002  12:33a                 348 contributor.properties.sample
-  10/25/2002  12:33a               2,268 contributor.xml
-  11/01/2002  03:53p      &lt;DIR&gt;          deploy
-  11/20/2002  03:51p      &lt;DIR&gt;          docs
-  11/20/2002  08:40p                  15 fclean.bat
-  11/01/2002  01:52p               1,026 forrest.properties
-  11/20/2002  03:51p      &lt;DIR&gt;          java
-  12/06/2001  11:22a               2,743 LICENSE
-  12/06/2001  10:33a                 230 README
-  11/18/2002  01:42p      &lt;DIR&gt;          src
-  11/01/2002  01:52p               3,668 status.xml
-  15 File(s)         28,797 bytes
-  12 Dir(s)   6,087,512,064 bytes free
-
-  D:\xindice\current\xml-xindice&gt;build
-
-  Xindice Build System
-
+  &gt; cd {XINDICE_HOME}
+  &gt; build
+  Using Java from C:\j2sdk{JAVA_VERSION}
   Buildfile: build.xml
 
   init:
+     [echo] Building with Java {JAVA_VERSION}
 
-  src-build:
+  compile-src:
+    [mkdir] Created dir: {XINDICE_HOME}\build\classes-dom
+    [javac] Compiling 4 source files to {XINDICE_HOME}\build\classes-dom
+    [mkdir] Created dir: {XINDICE_HOME}\build\classes
+    [javac] Compiling 287 source files to {XINDICE_HOME}\build\classes
 
-  test-build:
+  compile-test:
+    [mkdir] Created dir: {XINDICE_HOME}\build\classes-tests
+    [mkdir] Created dir: {XINDICE_HOME}\build\test-results
+    [javac] Compiling 62 source files to {XINDICE_HOME}\build\classes-tests
+     [copy] Copying 65 files to {XINDICE_HOME}\build\classes-tests
 
-  examples-build:
+  jar:
+      [jar] Building jar: {XINDICE_HOME}\xindice-1.2-dev.jar
+      [jar] Building jar: {XINDICE_HOME}\xindice-dom-1.2-dev.jar
 
-  build:
+  bin:
+    [mkdir] Created dir: {XINDICE_HOME}\build\bin
+     [copy] Copying 5 files to {XINDICE_HOME}\build\bin
 
-  jar-release:
+  war:
+     [copy] Copying 1 file to {XINDICE_HOME}
+      [war] Building war: {XINDICE_HOME}\xindice-1.2-dev.war
 
-  war-release:
-
-  examples-release:
-
-  release:
-
   BUILD SUCCESSFUL
-  Total time: 7 seconds
-
-  D:\xindice\current\xml-xindice&gt;
+  Total time: 13 seconds
       </source>
-      <note>
-        Your compile will probably show a few more lines reporting that some
-        files were compiled. I omitted those for brevity.
-      </note>
     </section>
     <section>
       <title>Verify the compilation</title>
       <p>If the compile was succeeded, you will find the output files in the current directory.</p>
       <source>
-  D:\xindice\current\xml-xindice&gt;dir
-  Volume in drive D is Data
-  Volume Serial Number is A3EB-9689
+  &gt; dir xindice-*
+  
+   Directory of {XINDICE_HOME}
 
-  Directory of D:\xindice\current\xml-xindice
-
-  11/18/2002  01:55p      &lt;DIR&gt;          .
-  11/18/2002  01:55p      &lt;DIR&gt;          ..
-  11/20/2002  03:57p             392,842 xindice-1.1b5-dev.jar
-  11/20/2002  03:57p           2,421,719 xindice-1.1b5-dev.war
-  11/20/2002  03:57p               1,748 xindice-1.1b5-dev.xml
-  11/20/2002  03:57p               6,503 xindice-dom-1.1b5-dev.jar
+  09/27/2007  09:24 PM           628,694 xindice-1.2-dev.jar
+  09/27/2007  09:24 PM         5,184,315 xindice-1.2-dev.war
+  09/27/2007  09:24 PM             1,791 xindice-1.2-dev.xml
+  09/27/2007  09:24 PM             6,535 xindice-dom-1.2-dev.jar
+               4 File(s)      5,821,335 bytes
+               0 Dir(s)   3,745,992,704 bytes free
       </source>
     </section>
     <section>
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.