Updated the site to fix a few formatting issues.
Project: http://git-wip-us.apache.org/repos/asf/vxquery/repo Commit: http://git-wip-us.apache.org/repos/asf/vxquery/commit/2e68da45 Tree: http://git-wip-us.apache.org/repos/asf/vxquery/tree/2e68da45 Diff: http://git-wip-us.apache.org/repos/asf/vxquery/diff/2e68da45 Branch: refs/heads/site Commit: 2e68da45c2657f557f93501dd8b826540d845612 Parents: 94c242d Author: Preston Carman <[email protected]> Authored: Thu Feb 19 11:12:18 2015 -0800 Committer: Preston Carman <[email protected]> Committed: Thu Feb 19 11:12:18 2015 -0800 ---------------------------------------------------------------------- README | 31 +++++++++++++++------------- src/site/apt/development_benchmarks.apt | 4 ++++ src/site/apt/user_query.apt | 2 +- src/site/apt/user_running_tests.apt | 16 +++++++------- src/site/site.xml | 4 ++-- 5 files changed, 32 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/vxquery/blob/2e68da45/README ---------------------------------------------------------------------- diff --git a/README b/README index e709f00..9fb027c 100644 --- a/README +++ b/README @@ -1,17 +1,20 @@ -~~ 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. +<!-- + 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. +--> + VXQuery documentation can be found in src/main/site/apt. The folder contains documents that detail how to install VXQuery, http://git-wip-us.apache.org/repos/asf/vxquery/blob/2e68da45/src/site/apt/development_benchmarks.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/development_benchmarks.apt b/src/site/apt/development_benchmarks.apt index 3892fdb..40c02c7 100644 --- a/src/site/apt/development_benchmarks.apt +++ b/src/site/apt/development_benchmarks.apt @@ -17,4 +17,8 @@ Benchmarks * Weather Benchmark + Instructions will be added shortly. All the code can be found in the vxquery-benchmark project. + * XMark Benchmark + + Work in progress. http://git-wip-us.apache.org/repos/asf/vxquery/blob/2e68da45/src/site/apt/user_query.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/user_query.apt b/src/site/apt/user_query.apt index 7cb04b5..a022825 100644 --- a/src/site/apt/user_query.apt +++ b/src/site/apt/user_query.apt @@ -31,7 +31,7 @@ vxq.bat * Command Line Options -Command line options for all systems. + Command line options for all systems. ---------------------------------------- -O N : Optimization Level. Default: Full Optimization http://git-wip-us.apache.org/repos/asf/vxquery/blob/2e68da45/src/site/apt/user_running_tests.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/user_running_tests.apt b/src/site/apt/user_running_tests.apt index 32d5278..d87de9e 100644 --- a/src/site/apt/user_running_tests.apt +++ b/src/site/apt/user_running_tests.apt @@ -24,7 +24,7 @@ sh ./vxquery/vxquery-xtest/target/appassembler/bin/xtest * Command On Windows Based Systems -First navigate to "apache-vxquery-X.Y/vxquery-cli/target/appassembler/bin" and then run the following file. + First navigate to "apache-vxquery-X.Y/vxquery-cli/target/appassembler/bin" and then run the following file. ---------------------------------------- xtest.bat @@ -60,17 +60,17 @@ JAVA_OPTS="-Xmx1024m -Djava.util.logging.config.file=/path/to/logging.properties * VXQuery Test Suite - The VXQuery test suite focuses on parallel processing tests used in our weather benchmark. + The VXQuery test suite focuses on parallel processing tests used in our weather benchmark. ---------------------------------------- sh ./vxquery-xtest/target/appassembler/bin/xtest -catalog vxquery-xtest/src/test/resources/VXQueryCatalog.xml -htmlreport /tmp/full_report.html ---------------------------------------- * XQTS (XQuery Test Suite) - To run the complete XQTS on VXQuery. + To run the complete XQTS on VXQuery. * Create a folder to hold the XQTS. - If you use "vxquery-xtest/test-suite/xqts", then maven will utilize the XQTS to verify VXQuery's passing functions during the build process. + If you use "vxquery-xtest/test-suite/xqts", then maven will utilize the XQTS to verify VXQuery's passing functions during the build process. ---------------------------------------- $ mkdir -p vxquery-xtest/test-suite @@ -103,11 +103,11 @@ sh ./vxquery-xtest/target/appassembler/bin/xtest -catalog vxquery-xtest/test-sui * Add JAVA_OPTS for additional java parameters. * XQTS (XQuery Test Suite) Option 2 - The following command will run the XQTS for test that are known to pass in VXQuery. - The command is intend for developer to check their build and ensure all previous test continue to pass. - All the tests should pass. + The following command will run the XQTS for test that are known to pass in VXQuery. + The command is intend for developer to check their build and ensure all previous test continue to pass. + All the tests should pass. - * run the tests, and + * run the tests, and ---------------------------------------- sh ./vxquery-xtest/target/appassembler/bin/xtest -catalog vxquery-xtest/test-suite/xqts/XQTSCatalog.xml -htmlreport /tmp/previous_report.html -previous-test-results vxquery-xtest/results/xqts.txt http://git-wip-us.apache.org/repos/asf/vxquery/blob/2e68da45/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index e0c75a0..9f41540 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -69,8 +69,8 @@ limitations under the License. <menu name="For Developers"> <item - name="Data Basic Types" - href="development_basic_data_types.html" /> + name="Data Handling" + href="development_data_handling.html" /> <item name="Data XML and Node Types" href="development_xml_node_details.html" />
