You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vxquery.apache.org by ti...@apache.org on 2013/11/25 08:18:11 UTC
svn commit: r1545165 - in /incubator/vxquery/trunk/vxquery/src/site:
apt/user_installation.apt apt/user_query.apt apt/user_running_tests.apt
site.xml
Author: tillw
Date: Mon Nov 25 07:18:10 2013
New Revision: 1545165
URL: http://svn.apache.org/r1545165
Log:
add download link
sightly update user docs
Modified:
incubator/vxquery/trunk/vxquery/src/site/apt/user_installation.apt
incubator/vxquery/trunk/vxquery/src/site/apt/user_query.apt
incubator/vxquery/trunk/vxquery/src/site/apt/user_running_tests.apt
incubator/vxquery/trunk/vxquery/src/site/site.xml
Modified: incubator/vxquery/trunk/vxquery/src/site/apt/user_installation.apt
URL: http://svn.apache.org/viewvc/incubator/vxquery/trunk/vxquery/src/site/apt/user_installation.apt?rev=1545165&r1=1545164&r2=1545165&view=diff
==============================================================================
--- incubator/vxquery/trunk/vxquery/src/site/apt/user_installation.apt (original)
+++ incubator/vxquery/trunk/vxquery/src/site/apt/user_installation.apt Mon Nov 25 07:18:10 2013
@@ -15,5 +15,19 @@
Installation
+* Requirements
- Install instructions can be found in the {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/docs/README}README file}}.
+ * Apache VXQuery source archive (apache-vxquery-X.Y-incubating-source-release.zip)
+
+ * JDK >= 1.7
+
+ * Apache Maven >= 3.2
+
+* Steps
+
+---
+$ unzip apache-vxquery-X.Y-incubating-source-release.zip
+$ cd apache-vxquery-X.Y-incubating
+$ mvn package -DskipTests
+$ cd ..
+---
Modified: incubator/vxquery/trunk/vxquery/src/site/apt/user_query.apt
URL: http://svn.apache.org/viewvc/incubator/vxquery/trunk/vxquery/src/site/apt/user_query.apt?rev=1545165&r1=1545164&r2=1545165&view=diff
==============================================================================
--- incubator/vxquery/trunk/vxquery/src/site/apt/user_query.apt (original)
+++ incubator/vxquery/trunk/vxquery/src/site/apt/user_query.apt Mon Nov 25 07:18:10 2013
@@ -19,7 +19,7 @@ Executing a Query
* Command
----------------------------------------
-sh ./apache_vxquery_incubating/vxquery/vxquery-cli/target/appassembler/bin/vxq
+sh ./apache-vxquery-X.Y-incubating/vxquery-cli/target/appassembler/bin/vxq
----------------------------------------
* Command Line Options
@@ -61,5 +61,5 @@ return $x/title
[[i]] Command line
----------------------------------------
-JAVA_OPTS="-Xmx1024m" sh apache_vxquery_incubating/vxquery/vxquery-cli/target/appassembler/bin/vxq test.xq
-----------------------------------------
\ No newline at end of file
+JAVA_OPTS="-Xmx1024m" sh ./apache-vxquery-X.Y-incubating/vxquery-cli/target/appassembler/bin/vxq test.xq
+----------------------------------------
Modified: incubator/vxquery/trunk/vxquery/src/site/apt/user_running_tests.apt
URL: http://svn.apache.org/viewvc/incubator/vxquery/trunk/vxquery/src/site/apt/user_running_tests.apt?rev=1545165&r1=1545164&r2=1545165&view=diff
==============================================================================
--- incubator/vxquery/trunk/vxquery/src/site/apt/user_running_tests.apt (original)
+++ incubator/vxquery/trunk/vxquery/src/site/apt/user_running_tests.apt Mon Nov 25 07:18:10 2013
@@ -19,7 +19,7 @@ Running the Test Suite
* Command
----------------------------------------
-sh ./apache_vxquery_incubating/vxquery/vxquery-xtest/target/appassembler/bin/xtest
+sh ./apache-vxquery-X.Y-incubating/vxquery/vxquery-xtest/target/appassembler/bin/xtest
----------------------------------------
* Command Line Options
@@ -50,8 +50,27 @@ JAVA_OPTS="-Xmx1024m -Djava.util.logging
* Example
+ To run the XQTS testsuite
+
+ * get the archive {{{http://dev.w3.org/2006/xquery-test-suite/PublicPagesStagingArea/XQTS_1_0_3.zip}XQTS_1_0_3.zip}} (e.g. using wget),
+
+----------------------------------------
+$ wget http://dev.w3.org/2006/xquery-test-suite/PublicPagesStagingArea/XQTS_1_0_3.zip
+----------------------------------------
+
+ * unpack it,
+
+----------------------------------------
+$ mkdir xqts
+$ cd xqts
+$ unzip ../XQTS_1_0_3.zip
+$ cd ..
+----------------------------------------
+
+ * run the tests, and
+
----------------------------------------
-JAVA_OPTS="-Xmx1024m -Djava.util.logging.config.file=/path/to/logging.properties" sh apache_vxquery_incubating/vxquery/vxquery-xtest/target/appassembler/bin/xtest -xqtsbase apache_vxquery_incubating/testsuites/XQTS/ -htmlreport /tmp/full_report.html
+JAVA_OPTS="-Xmx1024m -Djava.util.logging.config.file=/path/to/logging.properties" sh ./apache-vxquery-X.Y-incubating/vxquery-xtest/target/appassembler/bin/xtest -xqtsbase xqts -htmlreport /tmp/full_report.html
----------------------------------------
- View the results at {{{file:///tmp/full_report.html}file:///tmp/full_report.html}}.
\ No newline at end of file
+ * view the results at {{{file:///tmp/full_report.html}file:///tmp/full_report.html}}.
Modified: incubator/vxquery/trunk/vxquery/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/vxquery/trunk/vxquery/src/site/site.xml?rev=1545165&r1=1545164&r2=1545165&view=diff
==============================================================================
--- incubator/vxquery/trunk/vxquery/src/site/site.xml (original)
+++ incubator/vxquery/trunk/vxquery/src/site/site.xml Mon Nov 25 07:18:10 2013
@@ -15,40 +15,43 @@ See the License for the specific languag
limitations under the License.
-->
<project name="VXQuery">
- <bannerLeft>
- <name>VXQuery</name>
- <src>images/VXQuery.png</src>
- <href>http://incubator.apache.org/vxquery/</href>
- </bannerLeft>
-
- <bannerRight>
- <name>Apache Incubator</name>
- <src>images/apache-incubator-logo.png</src>
- <href>http://incubator.apache.org/</href>
- </bannerRight>
-
- <skin>
- <groupId>org.apache.maven.skins</groupId>
- <artifactId>maven-fluido-skin</artifactId>
- <version>1.3.0</version>
- </skin>
-
- <body>
- <menu ref="reports"/>
- <menu ref="modules"/>
+ <bannerLeft>
+ <name>VXQuery</name>
+ <src>images/VXQuery.png</src>
+ <href>http://incubator.apache.org/vxquery/</href>
+ </bannerLeft>
+
+ <bannerRight>
+ <name>Apache Incubator</name>
+ <src>images/apache-incubator-logo.png</src>
+ <href>http://incubator.apache.org/</href>
+ </bannerRight>
+
+ <skin>
+ <groupId>org.apache.maven.skins</groupId>
+ <artifactId>maven-fluido-skin</artifactId>
+ <version>1.3.0</version>
+ </skin>
+
+ <body>
+ <menu name="Get VXQuery">
+ <item name="Download" href="http://www.apache.org/dyn/closer.cgi/incubator/vxquery/" />
+ </menu>
- <menu name="For Developers">
- <item name="Data Basic Types" href="development_tips.html"/>
- <item name="Data XML and Node Types" href="development_xml_node_details.html"/>
- <item name="Eclipse Setup" href="development_eclipse_setup.html"/>
- </menu>
-
- <menu name="For Users">
- <item name="Installation" href="user_installation.html"/>
- <item name="Executing a Query" href="user_query.html"/>
- <item name="Running the Test Suite" href="user_running_tests.html"/>
- </menu>
-
- </body>
+ <menu name="For Users">
+ <item name="Installation" href="user_installation.html"/>
+ <item name="Executing a Query" href="user_query.html"/>
+ <item name="Running the Test Suite" href="user_running_tests.html"/>
+ </menu>
+
+ <menu name="For Developers">
+ <item name="Data Basic Types" href="development_tips.html"/>
+ <item name="Data XML and Node Types" href="development_xml_node_details.html"/>
+ <item name="Eclipse Setup" href="development_eclipse_setup.html"/>
+ </menu>
+
+ <menu ref="reports"/>
+ <menu ref="modules"/>
+ </body>
</project>