Clarify source of key index (3.9)

sylabs · Dec 10, 2021 · b871d84 · b871d84
1 parent 3908ad2
commit b871d84
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
   definition files (via dependency update).
 - Ensure a local build does not fail unnecessarily if a keyserver
   config cannot be retrieved from the remote endpoint.
+- Correct documentation for sign command r.e. source of key index.
 
 ## v3.9.1 \[2021-11-22\]
 

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -85,6 +85,7 @@ The following have contributed code and/or documentation to this repository.
 - Rafal Gumienny <rafal.gumienny@gmail.com>
 - Ralph Castain <rhc@open-mpi.org>
 - Rémy Dernat <remy.dernat@umontpellier.fr>
+- Richard Hattersley <richard.hattersley@metoffice.gov.uk>
 - Richard Neuboeck <hawk@tbi.univie.ac.at>
 - Sasha Yakovtseva <sasha@sylabs.io>, <sashayakovtseva@gmail.com>
 - Satish Chebrolu  <satish@sylabs.io>

diff --git a/cmd/internal/cli/sign.go b/cmd/internal/cli/sign.go
@@ -17,7 +17,7 @@ import (
 )
 
 var (
-	privKey int // -k encryption key (index from 'keys list') specification
+	privKey int // -k encryption key (index from 'key list --secret') specification
 	signAll bool
 )
 
@@ -68,7 +68,7 @@ var signKeyIdxFlag = cmdline.Flag{
 	DefaultValue: 0,
 	Name:         "keyidx",
 	ShortHand:    "k",
-	Usage:        "private key to use (index from 'key list')",
+	Usage:        "private key to use (index from 'key list --secret')",
 }
 
 // -a|--all (deprecated)