Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs for a few CLI commands #21

Merged
merged 1 commit into from
Sep 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/cli/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ global options as well::

titan --help

The following options are supported.
The following options are supported:

--version Display the titan version and exit.
--help, -h Display available subcommands
Expand Down
22 changes: 21 additions & 1 deletion docs/src/cli/cmd/checkout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,24 @@
titan checkout
==============

Coming soon!
Checks out a previous commit into the current container. The commit must be
present in `titan log`. For more general information on managing local
commits, see the :ref:`local_commit` section. For more information on how to
pull commits from remote repositories, see the :ref:`remote` section.

.. warning::

This will stop and start the associated docker container if it is already
running. This will interrupt any active connections, and may require
client-specific actions to reconnect.

::

titan checkout [-c commit] <repository>

The following options are supported:

-c, --commit Optional. Specify the commit ID to checkout. Must be a known
commit in `titan log` for the given repository. If not
specified, then the latest commit (based on commit timestamp)
will be used.
34 changes: 33 additions & 1 deletion docs/src/cli/cmd/commit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,36 @@
titan commit
============

Coming soon!
Commits the current data state of the container. When creating commits, titan
will use your git configuration to determine the name and email address to use
by running ``git config user.name`` and ```git config user.email``. If
you have not configured git before, you can run
``git config --global user.name <name>`` and
``git config --global user.email <email>`` to set these values.

.. note::

If you are not a git user and don't want to have to install it to use Titan,
join the `Community <https://titan-data.io/community>`_ to help
design and implement an alternative.

.. warning::

Titan assumes that it is safe to snapshot the current state of the data
while the container is running, and that starting the container with
data in such a state will automatically recover. This would necessarily be
true for any data store that can survive an unexpected outage. If you
are working with a container that first must be manually quiesced, you
should `titan stop` the container prior to committing state, and
`titan start` it afterwards.

::

titan commit [-m message] <repository>

The following options are supported:

-m, --message Specify a human-readable message associated with the commit.
This message, along with author information, will be visible
in ``titan log`` output and propagate with the commit when
pushed to, or pulled from, remote repositories.
10 changes: 9 additions & 1 deletion docs/src/cli/cmd/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,12 @@
titan install
=============

Coming soon!
Installs required titan infrastructure. Must be run prior to any other titan
commands. For more information on how to install titan and what's required, see
the :ref:`start_install` section.

::

titan install

This command has no additional options.