From c999f0b04c526a85d061a7461c0e4211e94f9fb7 Mon Sep 17 00:00:00 2001 From: Eric Biggers Date: Sat, 9 Sep 2023 11:30:45 -0700 Subject: 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. --- crypto/crypto.go | 6 +++--- filesystem/filesystem.go | 4 ++-- 2 files changed, 5 insertions(+), 5 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) diff --git a/filesystem/filesystem.go b/filesystem/filesystem.go index 0e1f0c8..ee6c983 100644 --- a/filesystem/filesystem.go +++ b/filesystem/filesystem.go @@ -21,11 +21,11 @@ // Package filesystem deals with the structure of the files on disk used to // store the metadata for fscrypt. Specifically, this package includes: -// - mountpoint management (mountpoint.go) +// 1. mountpoint management (mountpoint.go) // - querying existing mounted filesystems // - getting filesystems from a UUID // - finding the filesystem for a specific path -// - metadata organization (filesystem.go) +// 2. metadata organization (filesystem.go) // - setting up a mounted filesystem for use with fscrypt // - adding/querying/deleting metadata // - making links to other filesystems' metadata -- cgit v1.2.3