ostree-sign: Slightly clarify docs around --key-file
authorPhilip Withnall <pwithnall@gnome.org>
Mon, 3 Aug 2026 15:38:47 +0000 (16:38 +0100)
committerPhilip Withnall <pwithnall@gnome.org>
Tue, 4 Aug 2026 12:10:32 +0000 (13:10 +0100)
It wasn’t 100% clear to idiots like me that the key file is in a custom
format, rather than being a GPG keyring.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
man/ostree-sign.xml
src/ostree/ot-builtin-sign.c

index 8b645278e38c463112882c5134e5cc35a06ace6b..462169ceefaade3942f7a49736dd2589499f2a2e 100644 (file)
@@ -123,13 +123,13 @@ License along with this library. If not, see <https://www.gnu.org/licenses/>.
            <varlistentry>
                 <term><option>--keys-file</option></term>
                 <listitem><para>
-                    Read key(s) from file <filename>filename</filename>.
+                    Read keys from file <filename>filename</filename>.
                 </para></listitem>
 
                 <listitem><para>
                     Valid for <literal>ed25519</literal> and <literal>spki</literal> signature types.
-                    This file must contain <literal>base64</literal>-encoded
-                    secret key(s) (for signing) or public key(s) (for verifying) per line.
+                    This file must contain one <literal>base64</literal>-encoded key per line.
+                    Each key may be a secret key (for signing) or a public key (for verifying).
                 </para></listitem>
             </varlistentry>
             <varlistentry>
index 5016794d182f760ee16f2d5c6c6645781eda9f75..6d89a2fbee7fd7ab507bcb5b3bd6f4b2a736f984 100644 (file)
@@ -48,7 +48,7 @@ static GOptionEntry options[]
         { "sign-type", 's', 0, G_OPTION_ARG_STRING, &opt_sign_name,
           "Signature type to use (defaults to 'ed25519')", "NAME" },
 #if defined(HAVE_ED25519)
-        { "keys-file", 0, 0, G_OPTION_ARG_STRING, &opt_filename, "Read key(s) from file", "NAME" },
+        { "keys-file", 0, 0, G_OPTION_ARG_STRING, &opt_filename, "Read keys from file", "NAME" },
         { "keys-dir", 0, 0, G_OPTION_ARG_STRING, &opt_keysdir,
           "Redefine system-wide directories with public and revoked keys for verification",
           "NAME" },