Repository: vxquery Updated Branches: refs/heads/site da03800b8 -> a506d0512
XMark query status documentation. Project: http://git-wip-us.apache.org/repos/asf/vxquery/repo Commit: http://git-wip-us.apache.org/repos/asf/vxquery/commit/a506d051 Tree: http://git-wip-us.apache.org/repos/asf/vxquery/tree/a506d051 Diff: http://git-wip-us.apache.org/repos/asf/vxquery/diff/a506d051 Branch: refs/heads/site Commit: a506d0512aa9634c00b094ba0e8efb673e2756de Parents: da03800 Author: Preston Carman <[email protected]> Authored: Tue Aug 18 19:32:02 2015 -0700 Committer: Preston Carman <[email protected]> Committed: Tue Aug 18 19:32:02 2015 -0700 ---------------------------------------------------------------------- src/site/apt/development_site_update.apt | 46 ++++++++++++++++ src/site/apt/development_xmark_status.apt | 76 ++++++++++++++++++++++++++ src/site/site.xml | 39 +++++-------- 3 files changed, 136 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/vxquery/blob/a506d051/src/site/apt/development_site_update.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/development_site_update.apt b/src/site/apt/development_site_update.apt index 240de25..7358cdb 100644 --- a/src/site/apt/development_site_update.apt +++ b/src/site/apt/development_site_update.apt @@ -15,8 +15,54 @@ Updating the Apache VXQuery\x99 site +* One time steps + + * set up directory structure + + There usually are 2 directories at the same level + + * the source directory <<<vxquery>>>, + + * the <<<site>>> directory, and + + The source directory is version-controlled by <<<git>>>, the other is + version controlled by <<<svn>>>. + While the source directory can have an arbitrary name and location, + the <<<site>>> directory has to be called <<<site>>> and it needs to + be at the same level as the source directory to enable site deployment. + + Assuming that the source directory is available one can create the + directory structure by going to the directory that contains the + source directory and checking out the distribution and site + directories: + +--- +$ svn co https://dist.apache.org/repos/dist/release/vxquery dist +$ svn co https://svn.apache.org/repos/asf/vxquery/site +--- + +* For each update + * update the <<<site>>> branch in git + * New release steps + + Please switch to the {{{http://vxquery.apache.org/development_release.html}release steps}} + and follow their directions. + + * Incremental site update + + When pushing changes to the site without a code release, the following git + commands will create a patch of only differences within the src/site folder. + Please verify the patch before applying it the site + +----- +git checkout master +git diff site src/site/ > ../site.patch" +git checkout site +git apply ../site.patch +---- + * build a new site and deploy it to <<<../site>>> --- http://git-wip-us.apache.org/repos/asf/vxquery/blob/a506d051/src/site/apt/development_xmark_status.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/development_xmark_status.apt b/src/site/apt/development_xmark_status.apt new file mode 100644 index 0000000..a7a6f6c --- /dev/null +++ b/src/site/apt/development_xmark_status.apt @@ -0,0 +1,76 @@ +~~ 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. + + +XMark Benchmark Documentation + + In the following table, XMark queries are listed to show the current status of + each query in VXQuery. The <Query Number> column represents the XMark query + number. <Original Query> column represents the original XMark query from the XMark Benchmark site. Original query + works if it has a <Working> status in the column. If the original query does not work, then + the column displays the error type. <Optimized Query> column represents + the parallel optimized version for the original XMark query. The optimized version of the query + has been written to increase performance. Optimized query + works if it has a <Working> status in the column. If the optimized query does not work, then + the column displays the error or displays <Same Error as Original Query>. + <Frame Size> column represents the frame size that VXQuery needs to run the query. + The <Issues> column represents the JIRA issues for the query or are related to the query. + All queries that do not work with the default frame size + are related to {{{https://issues.apache.org/jira/browse/VXQUERY-167} VXQuery Issue 167 }}. + + +*------------------+--------------------+---------------------+-----------------+-----------+ +| <<Query Number>> | <<Original Query>> | <<Optimized Query>> | <<Frame Size>> | <<Issues>> | +*------------------+--------------------+---------------------+-----------------+-----------: +| 1 | Working | Working | Working with default size | None | +*------------------+--------------------+---------------------+-----------------+-----------: +| 2 | Working | Working | Working with default size | None | +*------------------+--------------------+---------------------+-----------------+-----------: +| 3 | Working | Working | Working with default size | None | +*------------------+--------------------+---------------------+-----------------+-----------: +| 4 | Working | Working| Working with default size | None | +*------------------+--------------------+---------------------+-----------------+-----------: +| 5 | Working | Working | Working with default size | None | +*------------------+--------------------+---------------------+-----------------+-----------: +| 6 | Error in the Query Plan | Same Error as Original Query | Cannot be determined | {{{https://issues.apache.org/jira/browse/VXQUERY-170} VXQuery Issue 170 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 7 | Error in the Query Plan | Same Error as Original Query | Cannot be determined | {{{https://issues.apache.org/jira/browse/VXQUERY-170} VXQuery Issue 170 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 8 | Working | Working | Working with default size | {{{https://issues.apache.org/jira/browse/VXQUERY-171} VXQuery Issue 171 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 9 | Array Out Of bounds Exception | Same Error as Original Query | Cannot be determined | {{{https://issues.apache.org/jira/browse/VXQUERY-173} VXQuery Issue 173 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 10 | Times out while execution | Same Error as Original Query | Cannot be determined | {{{https://issues.apache.org/jira/browse/VXQUERY-176} VXQuery Issue 176 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 11 | Working | Working | Working with default size | {{{https://issues.apache.org/jira/browse/VXQUERY-171} VXQuery Issue 171 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 12 | Working | Working |Working with default size | {{{https://issues.apache.org/jira/browse/VXQUERY-172} VXQuery Issue 172 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 13 | Working | Working |Working with default size | None | +*------------------+--------------------+---------------------+-----------------+-----------: +| 14 | Working | Working |Working with max size | None | +*------------------+--------------------+---------------------+-----------------+-----------: +| 15 | Working | Working | Working with max size | {{{https://issues.apache.org/jira/browse/VXQUERY-174} VXQuery Issue 174 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 16 | Working | Working |Working with max size | None | +*------------------+--------------------+---------------------+-----------------+-----------: +| 17 | Working | Working | Working with default size | {{{https://issues.apache.org/jira/browse/VXQUERY-171} VXQuery Issue 171 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 18 | Use defined functions | Same Error as Original Query | Cannot be determined | {{{https://issues.apache.org/jira/browse/VXQUERY-154} VXQuery Issue 154 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 19 | Working | Working | Working with default size | {{{https://issues.apache.org/jira/browse/VXQUERY-172} VXQuery Issue 172 }} | +*------------------+--------------------+---------------------+-----------------+-----------: +| 20 | Empty results | Same Error as Original Query | Working with frame size | {{{https://issues.apache.org/jira/browse/VXQUERY-175} VXQuery Issue 175 }} | +*------------------+--------------------+---------------------+-----------------+-----------: \ No newline at end of file http://git-wip-us.apache.org/repos/asf/vxquery/blob/a506d051/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 6758899..b9612c1 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -20,19 +20,16 @@ limitations under the License. <src>images/VXQuery.png</src> <href>http://vxquery.apache.org/</href> </bannerLeft> - <bannerRight> <name>Apache Software Foundation</name> <src>images/asf_logo_wide.png</src> <href>http://www.apache.org/</href> </bannerRight> - <skin> <groupId>org.apache.maven.skins</groupId> <artifactId>maven-fluido-skin</artifactId> <version>1.3.1</version> </skin> - <body> <menu name="Apache Software Foundation"> <item @@ -48,13 +45,11 @@ limitations under the License. name="Security" href="http://www.apache.org/security/"; /> </menu> - <menu name="Get VXQuery"> <item name="Download" href="http://www.apache.org/dyn/closer.cgi/vxquery/"; /> </menu> - <menu name="For Users"> <item name="Get Started" @@ -72,7 +67,6 @@ limitations under the License. name="Running the Test Suite" href="user_running_tests.html" /> </menu> - <menu name="For Developers"> <item name="Get Started" @@ -84,12 +78,6 @@ limitations under the License. name="Data Handling" href="development_data_handling.html" /> <item - name="XML Data and Node Types" - href="development_xml_node_details.html" /> - <item - name="XML Data Model Example" - href="development_xml_document.html" /> - <item name="Eclipse Setup" href="development_eclipse_setup.html" /> <item @@ -101,23 +89,24 @@ limitations under the License. <item name="Update Local Git XQTS Results" href="development_update_xqts_results.html" /> - <!-- <item - name="XQuery Benchmarks" - href="development_benchmarks.html" /> --> + <item + name="XMark Benchmark Status" + href="development_xmark_status.html" /> + <item + name="XML Data and Node Types" + href="development_xml_node_details.html" /> + <item + name="XML Data Model Example" + href="development_xml_document.html" /> </menu> - <menu ref="reports" /> <menu ref="modules" /> - <footer> - <div class="row-fluid">Apache VXQuery, VXQuery, Apache, the Apache - feather logo, and the Apache VXQuery project logo are either - registered trademarks or trademarks of The Apache Software - Foundation in the United States and other countries. - All other marks mentioned may be trademarks or registered - trademarks of their respective owners. + <div class="row-fluid">Apache VXQuery, VXQuery, Apache, the Apache feather logo, and the Apache VXQuery project logo + are either registered trademarks or trademarks of The Apache Software Foundation in the United States + and other countries. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. </div> </footer> </body> -</project> - +</project> \ No newline at end of file
