diff --git a/crypto/keyring/doc.go b/crypto/keyring/doc.go index c5c17bf160..a3bc8d8824 100644 --- a/crypto/keyring/doc.go +++ b/crypto/keyring/doc.go @@ -1,9 +1,9 @@ -// Package keys provides common key management API. +// Package keyring provides common key management API. // // # The Keyring interface // // The Keyring interface defines the methods that a type needs to implement to be used -// as key storage backend. This package provides few implementations out-of-the-box. +// as key storage backend. This package provides a few implementations out-of-the-box. // // # NewInMemory // @@ -21,20 +21,20 @@ // // The backends: // -// os The instance returned by this constructor uses the operating system's default -// credentials store to handle keys storage operations securely. It should be noted -// that the keyring keyring may be kept unlocked for the whole duration of the user -// session. +// os The instance returned by this constructor uses the operating system's default +// credentials store to handle keys storage operations securely. It should be noted +// that the keyring may be kept unlocked for the whole duration of the user +// session. // file This backend more closely resembles the previous keyring storage used prior to -// v0.38.1. It stores the keyring encrypted within the app's configuration directory. -// This keyring will request a password each time it is accessed, which may occur -// multiple times in a single command resulting in repeated password prompts. +// v0.38.1. It stores the keyring encrypted within the app's configuration directory. +// This keyring will request a password each time it is accessed, which may occur +// multiple times in a single command resulting in repeated password prompts. // kwallet This backend uses KDE Wallet Manager as a credentials management application: -// https://github.com/KDE/kwallet +// https://github.com/KDE/kwallet // pass This backend uses the pass command line utility to store and retrieve keys: -// https://www.passwordstore.org/ +// https://www.passwordstore.org/ // test This backend stores keys insecurely to disk. It does not prompt for a password to -// be unlocked and it should be use only for testing purposes. +// be unlocked and it should be used only for testing purposes. // memory Same instance as returned by NewInMemory. This backend uses a transient storage. Keys -// are discarded when the process terminates or the type instance is garbage collected. +// are discarded when the process terminates or the type instance is garbage collected. package keyring