fscrypt: improve documentation for inline encryption
authorEric Biggers <ebiggers@google.com>
Thu, 16 Sep 2021 17:49:26 +0000 (10:49 -0700)
committerEric Biggers <ebiggers@google.com>
Tue, 21 Sep 2021 02:32:34 +0000 (19:32 -0700)
commitabb861fac0465de10f5d17190523182b2cb55e68
tree4ebb00f485d1cdff1d2c1982f2d1847973ea4fac
parentf262ca7db7b85cb11517f81d8a6690a9a4be1335
fscrypt: improve documentation for inline encryption

Currently the fscrypt inline encryption support is documented in the
"Implementation details" section, and it doesn't go into much detail.
It's really more than just an "implementation detail" though, as there
is a user-facing mount option.  Also, hardware-wrapped key support (an
upcoming feature) will depend on inline encryption and will affect the
on-disk format; by definition that's not just an implementation detail.

Therefore, move this documentation into its own section and expand it.

Link: https://lore.kernel.org/r/20210916174928.65529-4-ebiggers@kernel.org
Signed-off-by: Eric Biggers <ebiggers@google.com>
Documentation/block/inline-encryption.rst
Documentation/filesystems/fscrypt.rst