aboutsummaryrefslogtreecommitdiff
path: root/crypto
diff options
context:
space:
mode:
authorEric Biggers <ebiggers@google.com>2023-09-09 11:30:45 -0700
committerEric Biggers <ebiggers@google.com>2023-09-09 11:30:45 -0700
commitc999f0b04c526a85d061a7461c0e4211e94f9fb7 (patch)
treef3808ae890728a0bc4c09065296682360e533e6c /crypto
parentf91f8e4fcb59d6db80e5150530a65fe39a836eb2 (diff)
Adjust nested lists to prevent gofmt from flattening them
The latest version of gofmt flattens the nested lists in comments in crypto.go and filesystem.go. According to https://go.dev/doc/comment#mistakes, "Go doc comments do not support nested lists". However, that page also mentions that a workaround is to use different list markers for each level. Do that.
Diffstat (limited to 'crypto')
-rw-r--r--crypto/crypto.go6
1 files changed, 3 insertions, 3 deletions
diff --git a/crypto/crypto.go b/crypto/crypto.go
index 1f64b38..edc4ed7 100644
--- a/crypto/crypto.go
+++ b/crypto/crypto.go
@@ -18,11 +18,11 @@
*/
// Package crypto manages all the cryptography for fscrypt. This includes:
-// - Key management (key.go)
+// 1. Key management (key.go)
// - Securely holding keys in memory
// - Making recovery keys
-// - Randomness (rand.go)
-// - Cryptographic algorithms (crypto.go)
+// 2. Randomness (rand.go)
+// 3. Cryptographic algorithms (crypto.go)
// - encryption (AES256-CTR)
// - authentication (SHA256-based HMAC)
// - key stretching (SHA256-based HKDF)