linux-kernel - [PATCH] doc: filesystems: format tables in locking properly

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: <20200526064159.11361-1-lukas.bulwahn@gmail.com>
Date:   Tue, 26 May 2020 08:41:59 +0200
From:   Lukas Bulwahn <lukas.bulwahn@...il.com>
To:     Michel Lespinasse <walken@...gle.com>,
        Vlastimil Babka <vbabka@...e.cz>,
        Andrew Morton <akpm@...ux-foundation.org>,
        linux-mm <linux-mm@...ck.org>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: [PATCH] doc: filesystems: format tables in locking properly

Commit 28df3d1539de ("nfsd: clients don't need to break their own
delegations") introduced lm_breaker_owns_lease and documented that in the
according table. Commit 43dbd0e7e62b ("mmap locking API: convert mmap_sem
comments") renamed mmap_sem to mmap_lock in another table. Both changes
created a table entry longer than the content before, but did not adjust
the tables. Hence, make htmldocs warns about malformed tables.

Adjust the tables to address the warning.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@...il.com>
---
Michel, Vlastimil, please ack this patch.

Andrew, please pick this minor doc fix patch into your -next tree, where
patch "mmap locking API: convert mmap_sem comments" has been applied.


 Documentation/filesystems/locking.rst | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/Documentation/filesystems/locking.rst b/Documentation/filesystems/locking.rst
index 318605de83f3..faf7f4abd54d 100644
--- a/Documentation/filesystems/locking.rst
+++ b/Documentation/filesystems/locking.rst
@@ -433,15 +433,15 @@ prototypes::
 
 locking rules:
 
-==========		=============	=================	=========
-ops			inode->i_lock	blocked_lock_lock	may block
-==========		=============	=================	=========
-lm_notify:		yes		yes			no
-lm_grant:		no		no			no
-lm_break:		yes		no			no
-lm_change		yes		no			no
-lm_breaker_owns_lease:	no		no			no
-==========		=============	=================	=========
+======================		=============	=================	=========
+ops				inode->i_lock	blocked_lock_lock	may block
+======================		=============	=================	=========
+lm_notify:			yes		yes			no
+lm_grant:			no		no			no
+lm_break:			yes		no			no
+lm_change			yes		no			no
+lm_breaker_owns_lease:		no		no			no
+======================		=============	=================	=========
 
 buffer_head
 ===========
@@ -616,9 +616,9 @@ prototypes::
 
 locking rules:
 
-=============	========	===========================
+=============	=========	===========================
 ops		mmap_lock	PageLocked(page)
-=============	========	===========================
+=============	=========	===========================
 open:		yes
 close:		yes
 fault:		yes		can return with page locked
@@ -626,7 +626,7 @@ map_pages:	yes
 page_mkwrite:	yes		can return with page locked
 pfn_mkwrite:	yes
 access:		yes
-=============	========	===========================
+=============	=========	===========================
 
 ->fault() is called when a previously not present pte is about
 to be faulted in. The filesystem must find and return the page associated
-- 
2.17.1