From: Akira Yokosawa <akiyks@gmail.com>
To: leitao@debian.org
Cc: akpm@linux-foundation.org, corbet@lwn.net, kernel-team@meta.com,
linmiaohe@huawei.com, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-mm@kvack.org,
nao.horiguchi@gmail.com, rdunlap@infradead.org,
skhan@linuxfoundation.org
Subject: Re: [PATCH 2/2] Documentation: document panic_on_unrecoverable_memory_failure sysctl
Date: Tue, 24 Mar 2026 20:48:55 +0900 [thread overview]
Message-ID: <2ceb291b-3b18-43a7-9d51-5c752f1eebf4@gmail.com> (raw)
In-Reply-To: <acJh0Sk4UdjaTFLh@gmail.com>
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@debian.org>
>> > ---
>> > 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
next prev parent reply other threads:[~2026-03-24 11:49 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-23 15:29 [PATCH 0/2] mm/memory-failure: add panic option for unrecoverable pages Breno Leitao
2026-03-23 15:29 ` [PATCH 1/2] mm/memory-failure: add panic_on_unrecoverable_memory_failure sysctl Breno Leitao
2026-03-23 15:29 ` [PATCH 2/2] Documentation: document " Breno Leitao
2026-03-23 16:51 ` Randy Dunlap
2026-03-24 10:09 ` Breno Leitao
2026-03-24 11:48 ` Akira Yokosawa [this message]
2026-03-24 16:27 ` Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2ceb291b-3b18-43a7-9d51-5c752f1eebf4@gmail.com \
--to=akiyks@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=kernel-team@meta.com \
--cc=leitao@debian.org \
--cc=linmiaohe@huawei.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=nao.horiguchi@gmail.com \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox