From 4f491d1eef3586b1c77e4fca9fbc8c6d9fa58a44 Mon Sep 17 00:00:00 2001 From: Eric Schrock Date: Wed, 25 Sep 2019 17:29:09 -0400 Subject: [PATCH] add a few CLI references --- docs/src/cli/cli.rst | 2 +- docs/src/cli/cmd/checkout.rst | 22 +++++++++++++++++++++- docs/src/cli/cmd/commit.rst | 34 +++++++++++++++++++++++++++++++++- docs/src/cli/cmd/install.rst | 10 +++++++++- 4 files changed, 64 insertions(+), 4 deletions(-) diff --git a/docs/src/cli/cli.rst b/docs/src/cli/cli.rst index d1d79e37..a8b60e14 100644 --- a/docs/src/cli/cli.rst +++ b/docs/src/cli/cli.rst @@ -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 diff --git a/docs/src/cli/cmd/checkout.rst b/docs/src/cli/cmd/checkout.rst index 6a9b87bc..b133529d 100644 --- a/docs/src/cli/cmd/checkout.rst +++ b/docs/src/cli/cmd/checkout.rst @@ -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] + +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. diff --git a/docs/src/cli/cmd/commit.rst b/docs/src/cli/cmd/commit.rst index 2811f04f..0b2d8c7d 100644 --- a/docs/src/cli/cmd/commit.rst +++ b/docs/src/cli/cmd/commit.rst @@ -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 `` and +``git config --global user.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 `_ 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] + +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. diff --git a/docs/src/cli/cmd/install.rst b/docs/src/cli/cmd/install.rst index 33a0371e..187c0d37 100644 --- a/docs/src/cli/cmd/install.rst +++ b/docs/src/cli/cmd/install.rst @@ -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.