mirror of https://github.com/apache/cassandra
We can disable saving of the history either via command-line parameter --disable-history, or by setting disabled = True in the history section of the cqlshrc. Both options will read existing history, and just won't save new commands. Update help and docs for cqlsh history. Add startup info logline whenr history logging is enabled. Add a fix for cqlshrc file path not correctly expanding. Includes the Backport of Allows users to change cqlsh history location using env variable patch by Stefan Miklosovic; reviewed by Brandon Williams for CASSANDRA-17448 patch by Ekaterina Dimitrova; reviewed by Mick Semb Wever for CASSANDRA-XXX Co-authored-by: Alex Ott alex.ott@datastax.com Co-authored-by: Jaroslaw Grabowski jaroslaw.grabowski@datastax.com |
||
|---|---|---|
| .. | ||
| cql3 | ||
| modules | ||
| scripts | ||
| Makefile | ||
| README.md | ||
| SASI.md | ||
| antora.yml | ||
| native_protocol_v3.spec | ||
| native_protocol_v4.spec | ||
| native_protocol_v5.spec | ||
README.md
Apache Cassandra documentation directory
This directory contains the documentation maintained in-tree for Apache Cassandra. This directory contains the following documents:
- The source of the official Cassandra documentation, in the
source/modulessubdirectory. See below for more details on how to edit/build that documentation. - The specification(s) for the supported versions of native transport protocol.
Official documentation
The source for the official documentation for Apache Cassandra can be found in
the modules/cassandra/pages subdirectory. The documentation uses antora
and is thus written in asciidoc.
To generate the asciidoc files for cassandra.yaml and the nodetool commands, run (from project root):
ant gen-asciidoc
or (from this directory):
make gen-asciidoc
(The following has not yet been implemented, for now see the build instructions in the cassandra-website repo.) To build the documentation, run (from project root):
ant gen-doc
or (from this directory):
make html