From 29855d7957d28a8e2aeef0d45fbba4b648072b30 Mon Sep 17 00:00:00 2001 From: tschettervictor <85497460+tschettervictor@users.noreply.github.com> Date: Thu, 20 Feb 2025 12:39:41 -0700 Subject: [PATCH] docs: Add upgrade subcommand --- docs/chapters/subcommands/upgrade.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/chapters/subcommands/upgrade.rst diff --git a/docs/chapters/subcommands/upgrade.rst b/docs/chapters/subcommands/upgrade.rst new file mode 100644 index 00000000..bbff8af4 --- /dev/null +++ b/docs/chapters/subcommands/upgrade.rst @@ -0,0 +1,16 @@ +======= +upgrade +======= + +The `upgrade` command targets a thick or thin jail. Thin jails will be updated by changing the +release mount point that it is based on. Thick jails will be upgraded normally. + +.. code-block:: shell + + ishmael ~ # bastille upgrade help + Usage: bastille upgrade [option(s)] TARGET [NEWRELEASE|install] + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -f | --force Force upgrade a jail. + -x | --debug Enable debug mode.