From: Shuah Khan <skhan@linuxfoundation.org>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: akpm@linux-foundation.org, corbet@lwn.net,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: [PATCH] docs/vm: fix Unexpected indentation warns in page_owner
Date: Thu, 16 Dec 2021 11:10:44 -0700 [thread overview]
Message-ID: <4036edad-fd8f-6499-96d1-2ae12ddb73e9@linuxfoundation.org> (raw)
In-Reply-To: <049f7d02-932c-b49c-4af3-10d0f3e8fdb7@gmail.com>
On 12/16/21 8:00 AM, Akira Yokosawa wrote:
> On Thu, 16 Dec 2021 07:45:50 -0700, Shuah Khan wrote:
>> On 12/15/21 8:10 AM, Shuah Khan wrote:
>>> On 12/14/21 6:05 PM, Akira Yokosawa wrote:
>>>> Hi,
>>>>
>>>> On Tue, 14 Dec 2021 17:19:29 -0700, Shuah Khan wrote:
>>>>> Fix Unexpected indentation warns in page_owner:
>>>>>
>>>>> Documentation/vm/page_owner.rst:92: WARNING: Unexpected indentation.
>>>>> Documentation/vm/page_owner.rst:96: WARNING: Unexpected indentation.
>>>>> Documentation/vm/page_owner.rst:107: WARNING: Unexpected indentation.
>>>>
>>>> I guess these outputs should have been literal blocks.
>>>> Then Sphinx wouldn't complain about indentations.
>>>
>>> Good point. I will take a look and send v2.
>>>
>>
>> This is already in a literal block. A few of the lines in a literal block
>> are missing indentations - this patch is good as is.
>
> Well, to show the context, embedding from current page_owner.rst.
> My comment is on the line starting with "#".
>
> -----8<------
> 4) Analyze information from page owner::
>
> cat /sys/kernel/debug/page_owner > page_owner_full.txt
> ./page_owner_sort page_owner_full.txt sorted_page_owner.txt
>
> The general output of ``page_owner_full.txt`` is as follows:
> # ^^^ this unindent to the level of "Analyze" above ends the literal block,
> # so the final ":" needs to be "::".
> Page allocated via order XXX, ...
> PFN XXX ...
> // Detailed stack
>
> Page allocated via order XXX, ...
> PFN XXX ...
> // Detailed stack
> -----8<------
>
Yes. I understood you comment and made the exact change. What I wasn't
sure about is the flow of the text in the document and if the literal
block was just missed or the entire text is supposed to be in a single
block.
I now have a real example text from /sys/kernel/debug/page_owner to
use a real example and fix the warn at the same time.
thanks,
-- Shuah
prev parent reply other threads:[~2021-12-16 18:10 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-15 0:19 [PATCH] docs/vm: fix Unexpected indentation warns in page_owner Shuah Khan
2021-12-15 1:05 ` Akira Yokosawa
2021-12-15 15:10 ` Shuah Khan
2021-12-16 14:45 ` Shuah Khan
2021-12-16 15:00 ` Akira Yokosawa
2021-12-16 18:10 ` Shuah Khan [this message]
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=4036edad-fd8f-6499-96d1-2ae12ddb73e9@linuxfoundation.org \
--to=skhan@linuxfoundation.org \
--cc=akiyks@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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;
as well as URLs for NNTP newsgroup(s).