From 8a8948cd12dbf8ca779b0099bdae509d8a9b14f4 Mon Sep 17 00:00:00 2001 From: Katrina Prosise Date: Thu, 10 Aug 2023 12:03:16 -0400 Subject: [PATCH] Fix indentation error for gen-rst A newline was added before each list in command documentation across three commands. This should fix the issue where the output is used in sphinx and an indentation error causes a failure in the doc build. Docs built without issue when changes were applied. No related issue to link. Signed-off-by: Katrina Prosise --- subcommands/keys/tuf_updates_delete_offline_key.go | 2 ++ subcommands/keys/tuf_updates_rotate_offline_key.go | 1 + subcommands/keys/tuf_updates_sign_prod_targets.go | 1 + 3 files changed, 4 insertions(+) diff --git a/subcommands/keys/tuf_updates_delete_offline_key.go b/subcommands/keys/tuf_updates_delete_offline_key.go index 948b18e7..137f012e 100644 --- a/subcommands/keys/tuf_updates_delete_offline_key.go +++ b/subcommands/keys/tuf_updates_delete_offline_key.go @@ -20,11 +20,13 @@ func init() { Long: `Stage deletion of the offline TUF signing key for the Factory. There are two ways to delete the offline TUF signing key: + - If you own the keys file - you can delete your key by providing your keys file. Fioctl will search through your keys file for an appropriate key to delete. - You can also provide an exact key ID to delete. When you delete the TUF targets offline signing key: + - if there are production targets in your factory, corresponding signatures are also deleted. if any production targets lack enough signatures - you need to sign them using the "sign-prod-targets" command. - if there is an active wave in your factory, the TUF targets key deletion is not allowed.`, diff --git a/subcommands/keys/tuf_updates_rotate_offline_key.go b/subcommands/keys/tuf_updates_rotate_offline_key.go index 8ebefcf2..5ae12b89 100644 --- a/subcommands/keys/tuf_updates_rotate_offline_key.go +++ b/subcommands/keys/tuf_updates_rotate_offline_key.go @@ -23,6 +23,7 @@ func init() { The new offline signing key will be used in both CI and production TUF root. When you rotate the TUF targets offline signing key: + - If there are production targets in your factory, they are re-signed using the new key. This only applies to those production targets that were signed by a key you rotate. - If there is an active wave in your factory, the TUF targets rotation is not allowed.`, diff --git a/subcommands/keys/tuf_updates_sign_prod_targets.go b/subcommands/keys/tuf_updates_sign_prod_targets.go index be8a468a..8b494eb2 100644 --- a/subcommands/keys/tuf_updates_sign_prod_targets.go +++ b/subcommands/keys/tuf_updates_sign_prod_targets.go @@ -21,6 +21,7 @@ func init() { New signatures are staged for commit along with TUF root modifications. There are 3 use cases when this command comes handy: + - You want to sign your Factory's production targets with a newly added offline TUF Targets key. - You increase the TUF targets signature threshold and need to sign your production targets with an additional key.