[PATCH] docs: automarkup.py: add skipidentifiers

Manuel Ebner posted 1 patch 1 month ago
Documentation/sphinx/automarkup.py | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
[PATCH] docs: automarkup.py: add skipidentifiers
Posted by Manuel Ebner 1 month ago
Add skipidentifiers to reduce wrongfully high-lighted (bold) words.

Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
---
Pre-patch discussion:
 https://lore.kernel.org/all/bba57d51c72d9387ccef2b5979fa618e980c3ebf.camel@mailbox.org/
---
 Documentation/sphinx/automarkup.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py
index c2227ab0a..8a6174950 100644
--- a/Documentation/sphinx/automarkup.py
+++ b/Documentation/sphinx/automarkup.py
@@ -51,7 +51,10 @@ Skipnames = [ 'for', 'if', 'register', 'sizeof', 'struct', 'unsigned' ]
 # when following struct/union/enum/typedef keywords.
 # Example: "a simple struct that" in workqueue.rst should not be marked as code.
 #
-Skipidentifiers = [ 'that', 'which', 'where', 'whose' ]
+Skipidentifiers = [ 'and', 'are', 'as', 'containing', 'in', 'including',
+                    'is', 'name', 'needs', 'of', 'or',  'pages',
+                    'passed', 'randomization', 'request', 'that',
+                    'to', 'where', 'which', 'whose', 'will' ]
 
 #
 # Many places in the docs refer to common system calls.  It is
-- 
2.54.0
Re: [PATCH] docs: automarkup.py: add skipidentifiers
Posted by Randy Dunlap 1 month ago
Hi,

On 8/24/26 12:03 AM, Manuel Ebner wrote:
> Add skipidentifiers to reduce wrongfully high-lighted (bold) words.
> 
> Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>

whac-a-mole alert:
"struct request" here is no longer highlighted:
Documentation/block/blk-mq.rst:will then build a new structure from it, the struct request that will


For most of the other words here, I'm OK with this patch.

> ---
> Pre-patch discussion:
>  https://lore.kernel.org/all/bba57d51c72d9387ccef2b5979fa618e980c3ebf.camel@mailbox.org/
> ---
>  Documentation/sphinx/automarkup.py | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py
> index c2227ab0a..8a6174950 100644
> --- a/Documentation/sphinx/automarkup.py
> +++ b/Documentation/sphinx/automarkup.py
> @@ -51,7 +51,10 @@ Skipnames = [ 'for', 'if', 'register', 'sizeof', 'struct', 'unsigned' ]
>  # when following struct/union/enum/typedef keywords.
>  # Example: "a simple struct that" in workqueue.rst should not be marked as code.
>  #
> -Skipidentifiers = [ 'that', 'which', 'where', 'whose' ]
> +Skipidentifiers = [ 'and', 'are', 'as', 'containing', 'in', 'including',
> +                    'is', 'name', 'needs', 'of', 'or',  'pages',
> +                    'passed', 'randomization', 'request', 'that',
> +                    'to', 'where', 'which', 'whose', 'will' ]
>  
>  #
>  # Many places in the docs refer to common system calls.  It is

-- 
~Randy