linux-kernel - [PATCH 5/5] Documentation: riscv: vector: Fix bullet list usage on sysctl section

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-6-bagasdotme@gmail.com>
Date:   Sun, 14 May 2023 16:04:32 +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 5/5] Documentation: riscv: vector: Fix bullet list usage on sysctl section

Prose sentences are better written as normal paragraph instead of
using bullet lists.

Also, use bullet list for list of riscv_v_default_allow values.

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

diff --git a/Documentation/riscv/vector.rst b/Documentation/riscv/vector.rst
index 4624e5b9bef4cc..f752826871b0e2 100644
--- a/Documentation/riscv/vector.rst
+++ b/Documentation/riscv/vector.rst
@@ -102,25 +102,24 @@ status for the use of Vector in userspace:
 2.  System runtime configuration (sysctl)
 -----------------------------------------
 
- * To mitigate the ABI impact of expansion of the signal stack, a
-   policy mechanism is provided to the administrators, distro maintainers, and
-   developers to control the default Vector enablement status for userspace
-   processes:
+To mitigate the ABI impact of expansion of the signal stack, a
+policy mechanism is provided to the administrators, distro maintainers, and
+developers to control the default Vector enablement status for userspace
+processes in form of sysctl knob:
 
-/proc/sys/abi/riscv_v_default_allow
+* /proc/sys/abi/riscv_v_default_allow
 
     Writing the text representation of 0 or 1 to this file sets the default
-    system enablement status for new starting userspace programs. A valid value
-    should be:
+    system enablement status for new starting userspace programs. Valid values
+    are:
 
-    0: Do not allow Vector code to be executed as the default for new processes.
-
-    1: Allow Vector code to be executed as the default for new processes.
+    * 0: Do not allow Vector code to be executed as the default for new processes.
+    * 1: Allow Vector code to be executed as the default for new processes.
 
     Reading this file returns the current system default enablement status.
 
-* At every execve() call, a new enablement status of the new process is set to
-  the system default, unless:
+    At every execve() call, a new enablement status of the new process is set to
+    the system default, unless:
 
       * PR_RISCV_V_VSTATE_CTRL_INHERIT is set for the calling process, and the
         setting in PR_RISCV_V_VSTATE_CTRL_NEXT_MASK is not
@@ -129,5 +128,5 @@ status for the use of Vector in userspace:
       * The setting in PR_RISCV_V_VSTATE_CTRL_NEXT_MASK is not
         PR_RISCV_V_VSTATE_CTRL_DEFAULT.
 
-* Modifying the system default enablement status does not affect the enablement
-  status of any existing process of thread that do not make an execve() call.
+    Modifying the system default enablement status does not affect the enablement
+    status of any existing process of thread that do not make an execve() call.
-- 
An old man doll... just what I always wanted! - Clara