Re: [PATCH 2/2] Documentation: document panic_on_unrecoverable_memory_failure sysctl

[Randy Dunlap]

On 3/24/26 4:48 AM, Akira Yokosawa wrote:
> Hi,
> 
> On Tue, 24 Mar 2026 03:09:25 -0700, Breno Leitao wrote:
>> Hello Randy,
>>
>> On Mon, Mar 23, 2026 at 09:51:55AM -0700, Randy Dunlap wrote:
>>> On 3/23/26 8:29 AM, Breno Leitao wrote:
>>>> Document the new vm.panic_on_unrecoverable_memory_failure sysctl in the
>>>> admin guide, following the same format as panic_on_unrecovered_nmi.
>>>>
>>>> Signed-off-by: Breno Leitao <leitao@xxxxxxxxxx>
>>>> ---
>>>>  Documentation/admin-guide/sysctl/vm.rst | 27 +++++++++++++++++++++++++++
>>>>  1 file changed, 27 insertions(+)
>>>>
>>>> diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst
>>>> index 97e12359775c9..3310fb8272fb9 100644
>>>> --- a/Documentation/admin-guide/sysctl/vm.rst
>>>> +++ b/Documentation/admin-guide/sysctl/vm.rst
>>>
>>>
>>>> +
>>>> += ===================================================================
>>>> +0 Try to continue operation (default).
>>>> +1 Panic immediately.  If the ``panic`` sysctl is also non-zero then the
>>>> +  machine will be rebooted.
>>>> += ===================================================================
>>>
>>> The table begin and end lines must be at least as long as the text (may be
>>> longer). Please extend the =========== lines by a few characters.
>>
>> The HTML renders correctly in Sphinx (likely due to automatic column
>> expansion), but I agree the raw table format should be properly
>> structured.
> 
> Just to be clear, Sphinx is behaving as expected here.
> 
> The table is in the form of so-called "simple tables" in the reST
> (or docutils) parlance.  The rightmost column can exceed the width
> indicated by "==========".
> 
> Quote from [1]:
> 
>    The rightmost column is unbounded; text may continue past the
>    edge of the table (as indicated by the table borders). However,
>    it is recommended that borders be made long enough to contain
>    the entire text.
> 
> [1]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#simple-tables
> 
> So, it's just a recommendation, rather than a requirement.
> 
> "Grid tables" have a stricter rule.
> 
> Hope this helps.
> 
> Regards,
> Akira
> 
>>
>> I'll send v2 with this corrected.
>>
>> Thanks for the review,
>> --breno

Thanks to both of you for the edumcation.

-- 
~Randy