From 3e504e49b9bf752c76817f3916161d4e3d3227ee Mon Sep 17 00:00:00 2001 From: tschettervictor <85497460+tschettervictor@users.noreply.github.com> Date: Mon, 21 Apr 2025 18:45:58 -0600 Subject: [PATCH] docs: Clarify convert --- docs/chapters/subcommands/convert.rst | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/chapters/subcommands/convert.rst b/docs/chapters/subcommands/convert.rst index 8a4d6638..c20c4bae 100644 --- a/docs/chapters/subcommands/convert.rst +++ b/docs/chapters/subcommands/convert.rst @@ -1,15 +1,27 @@ convert ======= -Convert a thin jail to a thick jail. +Convert allows converting a thin jail to a thick jail. +It also allows converting a thick jail to a customized release. + +Converting a thin jail to a thick jail requires only the target jail. .. code-block:: shell ishmael ~ # bastille convert azkaban - [azkaban]: - ... -Syntax requires only the target jail to convert. +Converting a thick jail to a custom release requires a target jail as +well as custom release name. + +.. code-block:: shell + + ishmael ~ # bastille convert azkaban myrelease + +This release can then be used to create a thick jail using the ``--no-validate`` flag. + +.. code-block:: shell + + ishmael ~ # bastille create --no-validate customjail myrelease 10.0.0.1 .. code-block:: shell