Re: [PATCH] docs/vm: fix Unexpected indentation warns in page_owner

From: Akira Yokosawa
Date: Thu Dec 16 2021 - 10:00:23 EST


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<------

Ditto for another output.

Hope this helps you!

Thanks, Akira
>
> thanks,
> -- Shuah
>