You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2016/02/13 13:31:05 UTC

[18/37] incubator-tinkerpop git commit: A note about speeding up doc generation for a single file CTR

A note about speeding up doc generation for a single file CTR


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/e1575146
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/e1575146
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/e1575146

Branch: refs/heads/master
Commit: e1575146355c79717f2838ce6aa5247bf27407e0
Parents: 4a6f9a2
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Feb 12 06:37:17 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Feb 12 06:37:17 2016 -0500

----------------------------------------------------------------------
 docs/src/dev/developer/contributing.asciidoc | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/e1575146/docs/src/dev/developer/contributing.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/developer/contributing.asciidoc b/docs/src/dev/developer/contributing.asciidoc
index 8e65ed5..b78af98 100644
--- a/docs/src/dev/developer/contributing.asciidoc
+++ b/docs/src/dev/developer/contributing.asciidoc
@@ -47,7 +47,8 @@ generate the docs to validate formatting by just doing `bin/process-docs.sh --dr
 please be sure to have Zookeeper and Hadoop running when doing a `bin/process-docs.sh`.  If no code changes were made,
 one can also use the `--noClean` option. This will prevent the processor from cleaning up the local Grapes directory and
 the Hadoop Gremlin Libs directory in HDFS, resulting in a slightly faster execution time. The documentation is generated
-to `/target/docs/htmlsingle`.
+to `/target/docs/htmlsingle`. Once a full run of the documentation is executed, it is possible to run just one file by
+deleting the file to regenerated from `target/postprocess-asciidoc` then re-executing `bin/process-docs.sh`.
 . If necessary, run the integration tests.  For example, if the changes affect serialization or Gremlin Server/Driver
 operations then running the integration tests assures in addition to unit tests will definitely be necessary. After
 a successful `mvn clean install`, do `mvn verify -DskipIntegrationTests=false -pl gremlin-server`.