linux-kernel - Re: [PATCH] docs/vm: fix Unexpected indentation warns in page

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: <4036edad-fd8f-6499-96d1-2ae12ddb73e9@linuxfoundation.org>
Date:   Thu, 16 Dec 2021 11:10:44 -0700
From:   Shuah Khan <skhan@...uxfoundation.org>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     akpm@...ux-foundation.org, corbet@....net,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH] docs/vm: fix Unexpected indentation warns in page_owner

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