Repository: tinkerpop Updated Branches: refs/heads/master 97d585da2 -> 860764ebe
Minor doc updates. CTR. Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/dff68939 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/dff68939 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/dff68939 Branch: refs/heads/master Commit: dff68939dd922ad93464560a63e0ea7ccbaa5c91 Parents: 7858c53 Author: Jason Plurad <[email protected]> Authored: Mon Feb 6 14:53:12 2017 +0000 Committer: Jason Plurad <[email protected]> Committed: Mon Feb 6 14:53:12 2017 +0000 ---------------------------------------------------------------------- docs/src/dev/developer/development-environment.asciidoc | 8 +++++--- docs/src/dev/developer/release.asciidoc | 6 ++++-- docs/src/reference/the-traversal.asciidoc | 2 +- 3 files changed, 10 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/dff68939/docs/src/dev/developer/development-environment.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/developer/development-environment.asciidoc b/docs/src/dev/developer/development-environment.asciidoc index 01ef4bd..8897990 100644 --- a/docs/src/dev/developer/development-environment.asciidoc +++ b/docs/src/dev/developer/development-environment.asciidoc @@ -51,7 +51,7 @@ The documentation generation process is not Maven-based and uses shell scripts t scripts should work on Mac and Linux. To generate documentation, it is required that link:https://hadoop.apache.org[Hadoop 2.7.x] is running in -link:https://hadoop.apache.org/docs/r2.7.1/hadoop-project-dist/hadoop-common/SingleCluster.html#Pseudo-Distributed_Operation[pseudo-distributed] +link:https://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-common/SingleCluster.html#Pseudo-Distributed_Operation[pseudo-distributed] mode. Be sure to set the `HADOOP_GREMLIN_LIBS` environment variable as described in the link:http://tinkerpop.apache.org/docs/current/reference/#hadoop-gremlin[reference documentation]. It is also important to set the `CLASSPATH` to point at the directory containing the Hadoop configuration files, like `map-red-site.xml`. @@ -85,7 +85,8 @@ This section is only useful to TinkerPop release managers and describes prerequi release of TinkerPop. All Apache releases must be signed. Please see link:http://www.apache.org/dev/release-signing.html[this guide] in the Apache documentation for instructions on to set up gpg. Keys should be added to KEYS files in both the link:https://dist.apache.org/repos/dist/dev/tinkerpop/KEYS[development] and -link:https://dist.apache.org/repos/dist/release/tinkerpop/KEYS[release] distribution directories. +link:https://dist.apache.org/repos/dist/release/tinkerpop/KEYS[release] distribution directories and committed +using Apache Subversion (SVN). Uploading to pypi uses link:https://pypi.python.org/pypi/twine[twine] which is automatically installed by the build process in maven. Twine refers to `HOME/.pypirc` file for configuration on the pypi deploy environments and username @@ -109,7 +110,8 @@ username = <username> password = ---- -If the `password` is left blank then the deployment process in Maven will prompt for it at deployment time. +The release manager shall use the project's pypi credentials, which are available in the PMC repository. +The `password` should be left blank so the deployment process in Maven will prompt for it at deployment time. [[building-testing]] Building and Testing http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/dff68939/docs/src/dev/developer/release.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/developer/release.asciidoc b/docs/src/dev/developer/release.asciidoc index b78e860..0feeb07 100644 --- a/docs/src/dev/developer/release.asciidoc +++ b/docs/src/dev/developer/release.asciidoc @@ -54,14 +54,16 @@ For JVM-based artifacts, simply use the following command: mvn clean deploy and artifacts will be pushed to the link:http://repository.apache.org/snapshots/[Apache Snapshot Repository]. Python -development artifacts must be deployed separately with a separate command: +development artifacts must be generated and deployed separately with additional commands: [source,text] -mvn clean deploy -pl gremlin-python -Dpypi +mvn clean install -Pglv-python +mvn deploy -pl gremlin-python -Dpypi Python does not use the snapshot model that the JVM does, however, the build is smart in that it will dynamically generate a development version number for the Python artifacts when "-SNAPSHOT" is in the `pom.xml`. The previous command will push the development version to link:https://pypi.python.org/pypi/gremlinpython/[pypi] for distribution. +Use the `testpypi` test environment by updating the `gremlin-python/pom.xml` to verify the `mvn deploy` command works. IMPORTANT: The `clean` in the above commands is more important to the pypi deployment because the process will deploy anything found in the `target/python-packaged/dist` directory. Since the names of the artifacts are based on http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/dff68939/docs/src/reference/the-traversal.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc index 8a37a96..ed76a7a 100644 --- a/docs/src/reference/the-traversal.asciidoc +++ b/docs/src/reference/the-traversal.asciidoc @@ -1604,7 +1604,7 @@ Range Step As traversers propagate through the traversal, it is possible to only allow a certain number of them to pass through with `range()`-step (*filter*). When the low-end of the range is not met, objects are continued to be iterated. When -within the low and high range (both inclusive), traversers are emitted. Finally, when above the high range, the +within the low (inclusive) and high (exclusive) range, traversers are emitted. Finally, when above the high range, the traversal breaks out of iteration. [gremlin-groovy,modern]
