[
https://issues.apache.org/jira/browse/CASSANDRA-17534?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Brad Schoening updated CASSANDRA-17534:
---------------------------------------
Description:
CQLSH help topics opens a generic CQL page, not the specific topic. This
happens when docs are not installed locally, and it tries to open the online
version.
The file cqlsh.py has:
{{ # default location of local CQL.html}}
{{ if os.path.exists(CASSANDRA_PATH + '/doc/cql3/CQL.html'):}}
{{ ....}}
{{ else:}}
{{ # fallback to online version}}
{{ CASSANDRA_CQL_HTML = CASSANDRA_CQL_HTML_FALLBACK}}
For example,
{{cqlsh> help truncate;}}
opens the page:
[https://cassandra.apache.org/doc/latest/cassandra/cql/index.html#truncateStmt]
but there is no information about 'truncate' on that page and the anchor
#truncateStmt doesn't exist.
the correct page anchor is:
[https://cassandra.apache.org/doc/latest/cassandra/cql/ddl.html#truncate-statement]
The local file anchors appear they may be incorrect as well:
[https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile#truncate]
To reproduce this, 'pip install cqlsh' on a machine without a Cassandra package
install.
was:
CQLSH help topics opens a generic CQL page, not the specific topic. This
happens when docs are not installed locally, and it tries to open the online
version.
The file cqlsh.py has:
{{ # default location of local CQL.html}}
{{ if os.path.exists(CASSANDRA_PATH + '/doc/cql3/CQL.html'):}}
{{ ....}}
{{ else:}}
{{ # fallback to online version}}
{{ CASSANDRA_CQL_HTML = CASSANDRA_CQL_HTML_FALLBACK}}
For example,
{{cqlsh> help truncate;}}
opens the page:
[https://cassandra.apache.org/doc/latest/cassandra/cql/index.html#truncateStmt]
but there is no information about 'truncate' on that page and the anchor
#truncateStmt doesn't exist.
the correct page anchor is:
[https://cassandra.apache.org/doc/latest/cassandra/cql/ddl.html#truncate-statement]
The local file anchors appear they may be incorrect as well:
https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile#truncate
> CQLSH help topics appear broken with online version
> ---------------------------------------------------
>
> Key: CASSANDRA-17534
> URL: https://issues.apache.org/jira/browse/CASSANDRA-17534
> Project: Cassandra
> Issue Type: Bug
> Components: CQL/Interpreter
> Reporter: Brad Schoening
> Priority: Normal
>
> CQLSH help topics opens a generic CQL page, not the specific topic. This
> happens when docs are not installed locally, and it tries to open the online
> version.
> The file cqlsh.py has:
> {{ # default location of local CQL.html}}
> {{ if os.path.exists(CASSANDRA_PATH + '/doc/cql3/CQL.html'):}}
> {{ ....}}
> {{ else:}}
> {{ # fallback to online version}}
> {{ CASSANDRA_CQL_HTML = CASSANDRA_CQL_HTML_FALLBACK}}
> For example,
> {{cqlsh> help truncate;}}
> opens the page:
> [https://cassandra.apache.org/doc/latest/cassandra/cql/index.html#truncateStmt]
> but there is no information about 'truncate' on that page and the anchor
> #truncateStmt doesn't exist.
> the correct page anchor is:
> [https://cassandra.apache.org/doc/latest/cassandra/cql/ddl.html#truncate-statement]
> The local file anchors appear they may be incorrect as well:
> [https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile#truncate]
> To reproduce this, 'pip install cqlsh' on a machine without a Cassandra
> package install.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
