linux-kernel - Re: [PATCH] Documentation: exception-tables.rst: Fix the wrong steps referenced

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

Message-ID: <871q4at7ib.fsf@trenco.lwn.net>
Date: Wed, 03 Jul 2024 16:50:36 -0600
From: Jonathan Corbet <corbet@....net>
To: Li Zhijian <lizhijian@...itsu.com>, linux-doc@...r.kernel.org
Cc: tglx@...utronix.de, mingo@...hat.com, bp@...en8.de,
 dave.hansen@...ux.intel.com, x86@...nel.org, hpa@...or.com,
 linux-kernel@...r.kernel.org, Li Zhijian <lizhijian@...itsu.com>
Subject: Re: [PATCH] Documentation: exception-tables.rst: Fix the wrong
 steps referenced

Jonathan Corbet <corbet@....net> writes:

> Li Zhijian <lizhijian@...itsu.com> writes:
>
>> When it was in text format, it correctly hardcoded steps 8a to 8c.
>> However, after it was converted to RST, the sequence numbers were
>> auto-generated during rendering and became incorrect after some
>> steps were inserted.
>>
>> Change it to refer to steps a to c in a relative way.
>>
>> Signed-off-by: Li Zhijian <lizhijian@...itsu.com>
>> ---
>>  Documentation/arch/x86/exception-tables.rst | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/arch/x86/exception-tables.rst b/Documentation/arch/x86/exception-tables.rst
>> index efde1fef4fbd..562d1bc6d448 100644
>> --- a/Documentation/arch/x86/exception-tables.rst
>> +++ b/Documentation/arch/x86/exception-tables.rst
>> @@ -297,7 +297,7 @@ vma occurs?
>>     c) execution continues at local label 2 (address of the
>>        instruction immediately after the faulting user access).
>>  
>> -The steps 8a to 8c in a certain way emulate the faulting instruction.
>> +The steps a to c above in a certain way emulate the faulting instruction.
>>  
>
> Those steps render as 1, 2, and 3 ... where did "a to c" come from?

Ah, I see where my confusion came from.

The fix is obvious: indent the line that was changed so that it is a
part of the bulleted item it's talking about.  I've applied your patch
with that change.

Thanks,

jon