Skip to contentSkip to conversation

docs/vm: fix Unexpected indentation warns in page_owner

PATCH Applied Shuah Khan 2 participants 6 messages Dec 15, 2021 – Dec 16, 2021 Documentation

lore
Share & tools
lore

Shuah Khan

author reviewer
#0 lore raw

PATCH 1/1 docs/vm: fix Unexpected indentation warns in page_owner

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.

---
 Documentation/vm/page_owner.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/vm/page_owner.rst +3 -3
index 9837fc8147dd..9a3af6aafa09 100644
@@ -89,11 +89,11 @@ Usage
 
 	Page allocated via order XXX, ...
 	PFN XXX ...
-	 // Detailed stack
+	// Detailed stack
 
 	Page allocated via order XXX, ...
 	PFN XXX ...
-	 // Detailed stack
+	// Detailed stack
 
    The ``page_owner_sort`` tool ignores ``PFN`` rows, puts the remaining rows
    in buf, uses regexp to extract the page order value, counts the times
@@ -104,7 +104,7 @@ Usage
 
 	XXX times, XXX pages:
 	Page allocated via order XXX, ...
-	 // Detailed stack
+	// Detailed stack
 
    By default, ``page_owner_sort`` is sorted according to the times of buf.
    If you want to sort by the pages nums of buf, use the ``-m`` parameter.
Signature · 1 line
2.32.0
#1 lore raw

Hi,

Quoted 5 lines · Shuah Khan

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.

Thanks, Akira

Quoted 35 lines
---
 Documentation/vm/page_owner.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/vm/page_owner.rst +3 -3
index 9837fc8147dd..9a3af6aafa09 100644
@@ -89,11 +89,11 @@ Usage
 
 	Page allocated via order XXX, ...
 	PFN XXX ...
-	 // Detailed stack
+	// Detailed stack
 
 	Page allocated via order XXX, ...
 	PFN XXX ...
-	 // Detailed stack
+	// Detailed stack
 
    The ``page_owner_sort`` tool ignores ``PFN`` rows, puts the remaining rows
    in buf, uses regexp to extract the page order value, counts the times
@@ -104,7 +104,7 @@ Usage
 
 	XXX times, XXX pages:
 	Page allocated via order XXX, ...
-	 // Detailed stack
+	// Detailed stack
 
    By default, ``page_owner_sort`` is sorted according to the times of buf.
    If you want to sort by the pages nums of buf, use the ``-m`` parameter.
Signature · 1 line
2.32.0
author reviewer
#2 lore raw
Quoted 11 lines · Akira Yokosawa

Hi,

Quoted 5 lines · Shuah Khan

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.

thanks,
-- Shuah

author reviewer
#3 lore raw
Quoted 6 lines · Shuah Khan
Quoted 5 lines · Akira Yokosawa

Hi,

Quoted 2 lines · Shuah Khan

Fix Unexpected indentation warns in page_owner:

Quoted 9 lines
Quoted 6 lines
Quoted 3 lines

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.

thanks,
-- Shuah

#4 lore raw
Quoted 11 lines · Shuah Khan
Quoted 10 lines · Shuah Khan
Quoted 9 lines · Akira Yokosawa

Hi,

Quoted 5 lines · Shuah Khan

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.

Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

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

Quoted 4 lines

thanks,
-- Shuah

author reviewer
#5 lore raw
Quoted 33 lines · Akira Yokosawa
Quoted 11 lines · Shuah Khan
Quoted 10 lines · Shuah Khan
Quoted 9 lines · Akira Yokosawa

Hi,

Quoted 5 lines · Shuah Khan

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.

Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

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 "::".

Quoted 9 lines
	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