linux-kernel - [PATCH] doc: highlight structure fields using monospace format

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: <20200405210433.24791-1-federico.vaga@vaga.pv.it>
Date:   Sun,  5 Apr 2020 23:04:33 +0200
From:   Federico Vaga <federico.vaga@...a.pv.it>
To:     Jonathan Corbet <corbet@....net>
Cc:     linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
        Federico Vaga <federico.vaga@...a.pv.it>
Subject: [PATCH] doc: highlight structure fields using monospace format

The idea is to improve readability by highlighting structure fields
using a different format.

Signed-off-by: Federico Vaga <federico.vaga@...a.pv.it>
---
 Documentation/locking/rt-mutex-design.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/locking/rt-mutex-design.rst b/Documentation/locking/rt-mutex-design.rst
index 59c2a64efb21..bdd6b0013e02 100644
--- a/Documentation/locking/rt-mutex-design.rst
+++ b/Documentation/locking/rt-mutex-design.rst
@@ -199,7 +199,7 @@ Mutex Waiters Tree
 Every mutex keeps track of all the waiters that are blocked on itself. The
 mutex has a rbtree to store these waiters by priority.  This tree is protected
 by a spin lock that is located in the struct of the mutex. This lock is called
-wait_lock.
+``wait_lock``.
 
 
 Task PI Tree
@@ -216,9 +216,9 @@ inherited a priority, it will always be the priority of the task that is
 at the top of this tree.
 
 This tree is stored in the task structure of a process as a rbtree called
-pi_waiters.  It is protected by a spin lock also in the task structure,
-called pi_lock.  This lock may also be taken in interrupt context, so when
-locking the pi_lock, interrupts must be disabled.
+``pi_waiters``.  It is protected by a spin lock also in the task structure,
+called ``pi_lock``.  This lock may also be taken in interrupt context, so when
+locking the ``pi_lock``, interrupts must be disabled.
 
 
 Depth of the PI Chain
-- 
2.25.1