landlock: Various documentation improvements
authorGünther Noack <gnoack@google.com>
Mon, 15 Jul 2024 16:03:29 +0000 (16:03 +0000)
committerMickaël Salaün <mic@digikod.net>
Thu, 18 Jul 2024 06:27:47 +0000 (08:27 +0200)
commitf4b89d8ce5a835afa51404977ee7e3889c2b9722
treebfb24d98f3a226789b98de5ec1b20c3ee1c509f4
parent33c97e7c0338d921c2ae0c2e54bf17121007fb94
landlock: Various documentation improvements

* Fix some typos, incomplete or confusing phrases.
* Split paragraphs where appropriate.
* List the same error code multiple times,
  if it has multiple possible causes.
* Bring wording closer to the man page wording,
  which has undergone more thorough review
  (esp. for LANDLOCK_ACCESS_FS_WRITE_FILE).
* Small semantic clarifications
  * Call the ephemeral port range "ephemeral"
  * Clarify reasons for EFAULT in landlock_add_rule()
  * Clarify @rule_type doc for landlock_add_rule()

This is a collection of small fixes which I collected when preparing the
corresponding man pages [1].

Cc: Alejandro Colomar <alx@kernel.org>
Cc: Konstantin Meskhidze <konstantin.meskhidze@huawei.com>
Link: https://lore.kernel.org/r/20240715155554.2791018-1-gnoack@google.com
Signed-off-by: Günther Noack <gnoack@google.com>
Link: https://lore.kernel.org/r/20240715160328.2792835-2-gnoack@google.com
[mic: Add label to link, fix formatting spotted by make htmldocs,
synchronize userspace-api documentation's date]
Signed-off-by: Mickaël Salaün <mic@digikod.net>
Documentation/userspace-api/landlock.rst
include/uapi/linux/landlock.h
security/landlock/syscalls.c