You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tinkerpop.apache.org by "Daniel Kuppitz (JIRA)" <ji...@apache.org> on 2016/05/28 10:01:12 UTC
[jira] [Updated] (TINKERPOP-1314) Improve error detection in docs
preprocessor
[ https://issues.apache.org/jira/browse/TINKERPOP-1314?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Daniel Kuppitz updated TINKERPOP-1314:
--------------------------------------
Description:
Just recently a bug slipped through, because the docs preprocessor did not recognize an error. In order to make the error detection more robust, asciidoc files should all end with a common line (something like {{// LAST LINE}}).
If that line doesn't appear in the output file, we can be sure that something went wrong.
This commit can be used to test the approach: https://github.com/apache/incubator-tinkerpop/commit/b72ea666ce18920a8dd7d1d4c30bbe029fe4ae80
{{bin/process-docs.sh -f docs/src/reference/implementations-hadoop.asciidoc}}
{{bin/process-docs.sh}} should have a non-0 exit code.
was:
Just recently a bug slipped through, because the docs preprocessor did not recognize an error. In order to make the error detection more robust, asciidoc files should all end with a common line (something like {{// LAST LINE}}).
If that line doesn't appear in the output file, we can be sure that something went wrong.
This commit can be used to test the approach: https://github.com/apache/incubator-tinkerpop/commit/b72ea666ce18920a8dd7d1d4c30bbe029fe4ae80
{{bin/process-docs.sh -f docs/src/reference/implementations-hadoop.asciidoc}}
> Improve error detection in docs preprocessor
> --------------------------------------------
>
> Key: TINKERPOP-1314
> URL: https://issues.apache.org/jira/browse/TINKERPOP-1314
> Project: TinkerPop
> Issue Type: Improvement
> Components: documentation
> Reporter: Daniel Kuppitz
> Assignee: Daniel Kuppitz
> Fix For: 3.2.1
>
>
> Just recently a bug slipped through, because the docs preprocessor did not recognize an error. In order to make the error detection more robust, asciidoc files should all end with a common line (something like {{// LAST LINE}}).
> If that line doesn't appear in the output file, we can be sure that something went wrong.
> This commit can be used to test the approach: https://github.com/apache/incubator-tinkerpop/commit/b72ea666ce18920a8dd7d1d4c30bbe029fe4ae80
> {{bin/process-docs.sh -f docs/src/reference/implementations-hadoop.asciidoc}}
> {{bin/process-docs.sh}} should have a non-0 exit code.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)