linux-kernel - [PATCH 4/5] Documentation: riscv: vector: Use bullet lists for prctl() return values

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20230514090432.78217-5-bagasdotme@gmail.com>
Date:   Sun, 14 May 2023 16:04:31 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Linux Documentation <linux-doc@...r.kernel.org>,
        Linux RISC-V <linux-riscv@...ts.infradead.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Cc:     Jonathan Corbet <corbet@....net>,
        Paul Walmsley <paul.walmsley@...ive.com>,
        Palmer Dabbelt <palmer@...belt.com>,
        Albert Ou <aou@...s.berkeley.edu>,
        Bagas Sanjaya <bagasdotme@...il.com>,
        Vincent Chen <vincent.chen@...ive.com>,
        Andy Chiu <andy.chiu@...ive.com>,
        Greentime Hu <greentime.hu@...ive.com>
Subject: [PATCH 4/5] Documentation: riscv: vector: Use bullet lists for prctl() return values

Use bullet lists on return values of prctl() calls to follow other
listings (bit lists and enablement status). This should convey purposes
of listing things.

Fixes: 412c68cfeeb178 ("riscv: Add documentation for Vector")
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/riscv/vector.rst | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/Documentation/riscv/vector.rst b/Documentation/riscv/vector.rst
index c7bd701c7963b6..4624e5b9bef4cc 100644
--- a/Documentation/riscv/vector.rst
+++ b/Documentation/riscv/vector.rst
@@ -74,11 +74,12 @@ status for the use of Vector in userspace:
           PR_RISCV_V_VSTATE_CTRL_NEXT_MASK and PR_RISCV_V_VSTATE_CTRL_INHERIT.
           This setting persists across changes in the system-wide default value.
 
-    Return value: return 0 on success, or a negative error value:
-        EINVAL: Vector not supported, invalid enablement status for current or
-                next mask
-        EPERM: Turning off Vector in PR_RISCV_V_VSTATE_CTRL_CUR_MASK if Vector
-                was enabled for the calling thread.
+    Return value:
+        * 0 on success;
+        * EINVAL: Vector not supported, invalid enablement status for current or
+          next mask;
+        * EPERM: Turning off Vector in PR_RISCV_V_VSTATE_CTRL_CUR_MASK if Vector
+          was enabled for the calling thread.
 
     On success:
         * A valid setting for PR_RISCV_V_VSTATE_CTRL_CUR_MASK takes place
@@ -94,8 +95,9 @@ status for the use of Vector in userspace:
     Gets the same Vector enablement status for the calling thread. Setting for
     next execve() call and the inheritance bit are all OR-ed together.
 
-    Return value: a nonnegative value on success, or a negative error value:
-        EINVAL: Vector not supported.
+    Return value:
+        * a nonnegative value on success;
+        * EINVAL: Vector not supported.
 
 2.  System runtime configuration (sysctl)
 -----------------------------------------
-- 
An old man doll... just what I always wanted! - Clara