Mtawa002/documentation

doap.rdf

@@ -38,8 +38,8 @@
     <release>
       <Version>
         <name>Apache VXQuery</name>
-        <created>2015-03-05</created>
-        <revision>0.5</revision>
+        <created>2014-09-07</created>
+        <revision>0.4</revision>
       </Version>
     </release>
     <repository>
@@ -55,9 +55,9 @@
       </foaf:Person>
     </maintainer>
     <asfext:implements><asfext:Standard>
-      <asfext:title>XQuery 1.0: An XML Query Language</asfext:title>
+      <asfext:title>XQuery 1.0</asfext:title>
       <asfext:body>W3C</asfext:body>
-      <asfext:id>XQuery 1.0</asfext:id>
+      <asfext:id></asfext:id>
       <asfext:url rdf:resource="http://www.w3.org/TR/xquery/"/>
     </asfext:Standard></asfext:implements>
   </Project>

pom.xml

@@ -26,7 +26,7 @@
 
     <groupId>org.apache.vxquery</groupId>
     <artifactId>apache-vxquery</artifactId>
-    <version>0.6-SNAPSHOT</version>
+    <version>0.5</version>
     <packaging>pom</packaging>
     <name>VXQuery</name>
     <description>A Versatile XQuery Processor</description>
@@ -50,7 +50,7 @@
         <connection>scm:git:https://git-wip-us.apache.org/repos/asf/vxquery.git</connection>
         <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/vxquery.git</developerConnection>
         <url>https://git-wip-us.apache.org/repos/asf/vxquery.git</url>
-        <tag>HEAD</tag>
+        <tag>apache-vxquery-0.5</tag>
     </scm>
 
     <issueManagement>
@@ -187,31 +187,31 @@
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>hyracks-client</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>hyracks-control-common</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>hyracks-control-cc</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>hyracks-control-nc</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>algebricks-compiler</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
@@ -223,55 +223,55 @@
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>algebricks-common</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>algebricks-core</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>algebricks-data</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>algebricks-rewriter</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>algebricks-runtime</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>hyracks-api</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>hyracks-data-std</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>hyracks-dataflow-common</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
 
             <dependency>
-                <groupId>org.apache.hyracks</groupId>
+                <groupId>edu.uci.ics.hyracks</groupId>
                 <artifactId>hyracks-dataflow-std</artifactId>
                 <version>${hyracks.version}</version>
             </dependency>
@@ -375,8 +375,8 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <source>1.6</source>
+                    <target>1.6</target>
                 </configuration>
             </plugin>
             <plugin>
@@ -388,6 +388,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-release-plugin</artifactId>
+                <version>2.4.2</version>
                 <dependencies>
                     <dependency>
                         <groupId>org.apache.maven.scm</groupId>
@@ -458,15 +459,15 @@
             </plugin>
           </reportPlugins>
         </configuration>
-        <executions>
-          <execution>
+        <executions> 
+          <execution> 
             <id>attach-site</id>
             <phase>prepare-package</phase>
             <goals>
               <goal>jar</goal>
-            </goals>
-          </execution>
-        </executions>
+            </goals> 
+          </execution> 
+        </executions> 
       </plugin>
       -->
             <plugin>
@@ -529,7 +530,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <hyracks.version>0.2.16-incubating</hyracks.version>
+        <hyracks.version>0.2.15</hyracks.version>
         <apache-rat-plugin.version>0.11</apache-rat-plugin.version>
     </properties>
 

src/site/apt/developer_get_started.apt

@@ -21,9 +21,9 @@ Get Started as a VXQuery Developer
   * Go through the community member steps.
 
     * {{{http://vxquery.apache.org/user_get_started.html}Community steps}}.
-
+ 
   * Setup your eclipse development environment.
-
+ 
     * {{{http://vxquery.apache.org/development_eclipse_setup.html}Setup instructions}}.
 
   * XQuery has a test suite to verify XQuery specifications.
@@ -34,8 +34,8 @@ Get Started as a VXQuery Developer
 
     * Review the test structure.
 
-      * Code is found in the "VXQuery XTest" module.
+      * Code is found in the "VXQuery XTest" module. 
 
   * Review open issues for the project.
-
+ 
     * {{{http://vxquery.apache.org/issue-tracking.html}Issues list}}.

src/site/apt/development_eclipse_setup.apt

@@ -62,7 +62,9 @@ $ mvn install
 $ cd ..
 ----------------------------------------
 
-    The mvn "-DskipTests" option can be used to save about 20 minutes, but will skip the verification tests.
+    Note: On Windows based machines, it is likely that the post-installation verification tests will fail.
+
+    Therefore, the mvn "-DskipTests" option can be used to save about 20 minutes, but will skip the verification tests.
 
     Finally, from Eclipse's File menu "import" the Maven Hyracks project you have just downloaded through git.
 

src/site/apt/index.apt

@@ -22,7 +22,6 @@ Apache VXQuery
 
   There are lots of large collections of relatively small documents like e.g. the {{{http://www.sec.gov/info/edgar/ednews/dissemin.htm}EDGAR dataset}} or the {{{http://wiki.openstreetmap.org/wiki/Download}OpenStreetMap dataset}}.
   However there are no XQuery processors available today that are capable of processing these datasets in parallel and making the contained information accessible.
+
 
-
-[images/vxquery_stack.png] VXQuery Stack Diagram
-
+

src/site/apt/user_cluster_installation.apt

@@ -15,18 +15,6 @@
 
 Cluster Installation
 
-* Architecture
-
-  The VXQuery cluster is made up of two parts: a single cluster controller (cc) and many node controllers (nc).
-  The VXQuery CLI is used to parse the query and compile the job for the VXQuery cluster to process.
-  The CLI passes the job to the cc which manages the job and returns the result to the CLI.
-  The following diagram depicts the cluster layout.
-
-[images/vxquery_cluster.png] VXQuery Cluster Diagram
-
-  The XML document are distributed between the ncs.
-  The query's collection function will identify XML file path for the ncs.
-
 
 * Requirements
 
@@ -40,15 +28,15 @@ Cluster Installation
 * Steps
 
   * <<Export JAVA_HOME>>
-
+  
 ---
 $ export JAVA_HOME=/usr/java/latest
 ---
 
 
   * <<Unzip and build VXQuery>>
 
----
+--- 
 $ unzip apache-vxquery-X.Y-source-release.zip
 $ cd apache-vxquery-X.Y
 $ mvn package -DskipTests
@@ -57,7 +45,7 @@ $ cd ..
 
 
   * <<Create configuration file>>
-
+    
     Create a configuration xml file containing the information of the vxquery cluster.Here is an example of a VXQuery configuration file for a cluster with 1 master and 3 slaves.
 
 ---
@@ -87,7 +75,7 @@ $ cd ..
     * Fields that are required:
 
       * name : name of the cluster
-
+      
       * username : user that will execute commands in all the machines of the cluster. Preferably a user that has passwordless ssh access to the machines.
 
       * id : hostname of the node
@@ -106,12 +94,12 @@ $ cd ..
   * <<Deploy cluster>>
 
     To deploy the cluster you need to execute this command in the vxquery installation directory
-
+    
 ---
 $python cluster_cli.py -c ../conf/cluster.xml -a deploy -d /apache-vxquery/vxquery-server
 ---
 
-    * Arguments:
+    * Arguments: 
 
       * -c : path to the configuration file you created
 
@@ -122,16 +110,16 @@ $python cluster_cli.py -c ../conf/cluster.xml -a deploy -d /apache-vxquery/vxque
 
   * <<Start cluster>>
 
-    The command to start the cluster is
+    The command to start the cluster is 
 
 ---
 $python cluster_cli.py -c ../conf/cluster.xml -a start
 ---
-
+  
 
   * <<Stop cluster>>
 
-    The command to stop the cluster is
+    The command to stop the cluster is 
 
 ---
 $python cluster_cli.py -c ../conf/cluster.xml -a stop

src/site/apt/user_query.apt

@@ -23,10 +23,13 @@ sh ./apache-vxquery-X.Y/vxquery-cli/target/appassembler/bin/vxq
 ----------------------------------------
 
 * Commands On Windows Based Systems
-
+  
 ----------------------------------------
-cd apache-vxquery-X.Y/vxquery-cli/target/appassembler/bin
-vxq.bat
+set JAVA_OPTS=-Xmx1024m
+
+set PATH=%PATH%;"path-to"\apache-vxquery-X.Y\vxquery-cli\target\appassembler\bin\
+
+vxq "path-to"\test.xq
 ----------------------------------------
 
 * Command Line Options
@@ -76,3 +79,5 @@ return $x/title
 ----------------------------------------
 JAVA_OPTS="-Xmx1024m" sh ./apache-vxquery-X.Y/vxquery-cli/target/appassembler/bin/vxq test.xq
 ----------------------------------------
+
+

src/src/main/assembly/source.xml

@@ -0,0 +1,45 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
+  <id>source-release</id>
+  <formats>
+    <format>zip</format>
+  </formats>
+  <fileSets>
+    <fileSet>
+      <directory>${project.basedir}</directory>
+      <outputDirectory>/</outputDirectory>
+      <useDefaultExcludes>true</useDefaultExcludes>
+      <includes>
+        <include>**/DISCLAIMER</include>
+        <include>**/LICENSE</include>
+        <include>**/NOTICE</include>
+        <include>**/README</include>
+        <include>**/src/**</include>
+        <include>**/results/**</include>
+        <include>**/pom.xml</include>
+        <include>**/build*.xml</include>
+        <include>**/findbugs*.xml</include>
+      </includes>
+      <excludes>
+        <exclude>**/${project.build.directory}/**</exclude>
+      </excludes>      
+    </fileSet>
+  </fileSets>
+</assembly>