linux-kernel - [PATCH] docs: core-api: cachetlb: Fix up invalidate_kernel_vmap

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>] [day] [month] [year] [list]

Message-Id: <20210516055601.2819-1-palmer@dabbelt.com>
Date:   Sat, 15 May 2021 22:56:01 -0700
From:   Palmer Dabbelt <palmer@...belt.com>
To:     corbet@....net
Cc:     akpm@...ux-foundation.org, npiggin@...il.com,
        Palmer Dabbelt <palmerdabbelt@...gle.com>,
        peterz@...radead.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, kernel-team@...roid.com
Subject: [PATCH] docs: core-api: cachetlb: Fix up invalidate_kernel_vmap_range()

From: Palmer Dabbelt <palmerdabbelt@...gle.com>

The first word of the function description ended up inside the function
prototype, likely during an ReST conversion.  I've fixed that up, the diff
looks big because I re-wrapped the whole paragraph.

Signed-off-by: Palmer Dabbelt <palmerdabbelt@...gle.com>
---
 Documentation/core-api/cachetlb.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/core-api/cachetlb.rst b/Documentation/core-api/cachetlb.rst
index fe4290e26729..548ae069ed9e 100644
--- a/Documentation/core-api/cachetlb.rst
+++ b/Documentation/core-api/cachetlb.rst
@@ -396,10 +396,10 @@ I/O and invalidating it after the I/O returns.
        Note that this API does *not* also flush the offset map alias
        of the area.
 
-  ``void invalidate_kernel_vmap_range(void *vaddr, int size) invalidates``
+  ``void invalidate_kernel_vmap_range(void *vaddr, int size)``
 
-       the cache for a given virtual address range in the vmap area
-       which prevents the processor from making the cache stale by
-       speculatively reading data while the I/O was occurring to the
-       physical pages.  This is only necessary for data reads into the
-       vmap area.
+       invalidates the cache for a given virtual address range in the
+       vmap area which prevents the processor from making the cache
+       stale by speculatively reading data while the I/O was occurring
+       to the physical pages.  This is only necessary for data reads
+       into the vmap area.
-- 
2.20.1