[PATCH 2/2] doc: Fix fs_context_parse_param description in mount_api.rst

From: Roberto Sassu
Date: Fri Dec 09 2022 - 03:45:23 EST


From: Roberto Sassu <roberto.sassu@xxxxxxxxxx>

Align with the description of fs_context_parse_param in lsm_hooks.h, which
seems the right one according to the code.

Signed-off-by: Roberto Sassu <roberto.sassu@xxxxxxxxxx>
---
Documentation/filesystems/mount_api.rst | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/Documentation/filesystems/mount_api.rst b/Documentation/filesystems/mount_api.rst
index eb358a00be27..fc3b12cb39d1 100644
--- a/Documentation/filesystems/mount_api.rst
+++ b/Documentation/filesystems/mount_api.rst
@@ -349,13 +349,12 @@ number of operations used by the new mount code for this purpose:
struct fs_parameter *param);

Called for each mount parameter, including the source. The arguments are
- as for the ->parse_param() method. It should return 0 to indicate that
- the parameter should be passed on to the filesystem, 1 to indicate that
- the parameter should be discarded or an error to indicate that the
- parameter should be rejected.
+ as for the ->parse_param() method. It might reject the mount parameter
+ with an error and might return 0, if the mount parameter is used by an LSM;
+ otherwise returns -ENOPARAM to pass it on to the filesystem.

The value pointed to by param may be modified (if a string) or stolen
- (provided the value pointer is NULL'd out). If it is stolen, 1 must be
+ (provided the value pointer is NULL'd out). If it is stolen, 0 must be
returned to prevent it being passed to the filesystem.

* ::
--
2.25.1