From: Mike Rapoport <rppt@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>,
Andrew Morton <akpm@linux-foundation.org>
Cc: Linux MM <linux-mm@kvack.org>,
LKML <linux-kernel@vger.kernel.org>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Anshuman Khandual <anshuman.khandual@arm.com>,
"linux-arch@vger.kernel.org" <linux-arch@vger.kernel.org>
Subject: Re: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers
Date: Wed, 8 Jul 2020 09:43:32 +0300 [thread overview]
Message-ID: <20200708064332.GD128651@kernel.org> (raw)
In-Reply-To: <02ee60d0-e836-2237-4881-5c57ccac5551@infradead.org>
Hi Randy,
On Tue, Jul 07, 2020 at 06:07:40PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Make the tables be presented as tables in the generated output files
> (the line drawing did not present well).
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: Anshuman Khandual <anshuman.khandual@arm.com>
> Cc: Mike Rapoport <rppt@kernel.org>
> Cc: linux-arch@vger.kernel.org
> Cc: linux-mm@kvack.org
> Cc: Andrew Morton <akpm@linux-foundation.org>
> ---
> Documentation/vm/arch_pgtable_helpers.rst | 333 ++++++--------------
> 1 file changed, 116 insertions(+), 217 deletions(-)
>
> --- linux-next-20200707.orig/Documentation/vm/arch_pgtable_helpers.rst
> +++ linux-next-20200707/Documentation/vm/arch_pgtable_helpers.rst
> @@ -17,242 +17,141 @@ test need to be in sync.
> PTE Page Table Helpers
> ======================
>
> ---------------------------------------------------------------------------------
> -| pte_same | Tests whether both PTE entries are the same |
> ---------------------------------------------------------------------------------
According to ReST docs [1] we can use +---+---+ as row delimiter and
than we can keep | as column delimiter.
@Andrew, can you please fold the below patch into Anshuman's original
patch?
[1] https://docutils.sourceforge.io/docs/user/rst/quickref.html#tables
diff --git a/Documentation/vm/arch_pgtable_helpers.rst b/Documentation/vm/arch_pgtable_helpers.rst
index cd7609b05446..b106a1e9ef30 100644
--- a/Documentation/vm/arch_pgtable_helpers.rst
+++ b/Documentation/vm/arch_pgtable_helpers.rst
@@ -17,242 +17,242 @@ test need to be in sync.
PTE Page Table Helpers
======================
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_same | Tests whether both PTE entries are the same |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_bad | Tests a non-table mapped PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_present | Tests a valid mapped PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_young | Tests a young PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_dirty | Tests a dirty PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_write | Tests a writable PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_special | Tests a special PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_protnone | Tests a PROT_NONE PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_devmap | Tests a ZONE_DEVICE mapped PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_soft_dirty | Tests a soft dirty PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_swp_soft_dirty | Tests a soft dirty swapped PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkyoung | Creates a young PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkold | Creates an old PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkdirty | Creates a dirty PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkclean | Creates a clean PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkwrite | Creates a writable PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkwrprotect | Creates a write protected PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkspecial | Creates a special PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkdevmap | Creates a ZONE_DEVICE mapped PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mksoft_dirty | Creates a soft dirty PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_clear_soft_dirty | Clears a soft dirty PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_swp_mksoft_dirty | Creates a soft dirty swapped PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_swp_clear_soft_dirty | Clears a soft dirty swapped PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mknotpresent | Invalidates a mapped PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| ptep_get_and_clear | Clears a PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| ptep_get_and_clear_full | Clears a PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| ptep_test_and_clear_young | Clears young from a PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| ptep_set_wrprotect | Converts into a write protected PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| ptep_set_access_flags | Converts into a more permissive PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
======================
PMD Page Table Helpers
======================
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_same | Tests whether both PMD entries are the same |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_bad | Tests a non-table mapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_leaf | Tests a leaf mapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_huge | Tests a HugeTLB mapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_trans_huge | Tests a Transparent Huge Page (THP) at PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_present | Tests a valid mapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_young | Tests a young PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_dirty | Tests a dirty PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_write | Tests a writable PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_special | Tests a special PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_protnone | Tests a PROT_NONE PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_devmap | Tests a ZONE_DEVICE mapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_soft_dirty | Tests a soft dirty PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_swp_soft_dirty | Tests a soft dirty swapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkyoung | Creates a young PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkold | Creates an old PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkdirty | Creates a dirty PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkclean | Creates a clean PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkwrite | Creates a writable PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkwrprotect | Creates a write protected PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkspecial | Creates a special PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkdevmap | Creates a ZONE_DEVICE mapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mksoft_dirty | Creates a soft dirty PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_clear_soft_dirty | Clears a soft dirty PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_swp_mksoft_dirty | Creates a soft dirty swapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_swp_clear_soft_dirty | Clears a soft dirty swapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_mkinvalid | Invalidates a mapped PMD [1] |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_set_huge | Creates a PMD huge mapping |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmd_clear_huge | Clears a PMD huge mapping |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmdp_get_and_clear | Clears a PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmdp_get_and_clear_full | Clears a PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmdp_test_and_clear_young | Clears young from a PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmdp_set_wrprotect | Converts into a write protected PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pmdp_set_access_flags | Converts into a more permissive PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
======================
PUD Page Table Helpers
======================
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_same | Tests whether both PUD entries are the same |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_bad | Tests a non-table mapped PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_leaf | Tests a leaf mapped PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_huge | Tests a HugeTLB mapped PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_trans_huge | Tests a Transparent Huge Page (THP) at PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_present | Tests a valid mapped PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_young | Tests a young PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_dirty | Tests a dirty PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_write | Tests a writable PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_devmap | Tests a ZONE_DEVICE mapped PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_mkyoung | Creates a young PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_mkold | Creates an old PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_mkdirty | Creates a dirty PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_mkclean | Creates a clean PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_mkwrite | Creates a writable PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_mkwrprotect | Creates a write protected PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_mkdevmap | Creates a ZONE_DEVICE mapped PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_mkinvalid | Invalidates a mapped PUD [1] |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_set_huge | Creates a PUD huge mapping |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pud_clear_huge | Clears a PUD huge mapping |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pudp_get_and_clear | Clears a PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pudp_get_and_clear_full | Clears a PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pudp_test_and_clear_young | Clears young from a PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pudp_set_wrprotect | Converts into a write protected PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pudp_set_access_flags | Converts into a more permissive PUD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
==========================
HugeTLB Page Table Helpers
==========================
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_huge | Tests a HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| pte_mkhuge | Creates a HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| huge_pte_dirty | Tests a dirty HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| huge_pte_write | Tests a writable HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| huge_pte_mkdirty | Creates a dirty HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| huge_pte_mkwrite | Creates a writable HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| huge_pte_mkwrprotect | Creates a write protected HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| huge_ptep_get_and_clear | Clears a HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| huge_ptep_set_wrprotect | Converts into a write protected HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| huge_ptep_set_access_flags | Converts into a more permissive HugeTLB |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
========================
SWAP Page Table Helpers
========================
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| __pte_to_swp_entry | Creates a swapped entry (arch) from a mapepd PTE |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| __swp_to_pte_entry | Creates a mapped PTE from a swapped entry (arch) |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| __pmd_to_swp_entry | Creates a swapped entry (arch) from a mapepd PMD |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| __swp_to_pmd_entry | Creates a mapped PMD from a swapped entry (arch) |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| is_migration_entry | Tests a migration (read or write) swapped entry |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| is_write_migration_entry | Tests a write migration swapped entry |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| make_migration_entry_read | Converts into read migration swapped entry |
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
| make_migration_entry | Creates a migration swapped entry (read or write)|
---------------------------------------------------------------------------------
++---------------------------+--------------------------------------------------+
[1] https://lore.kernel.org/linux-mm/20181017020930.GN30832@redhat.com/
--
Sincerely yours,
Mike.
next prev parent reply other threads:[~2020-07-08 6:43 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-08 1:07 [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers Randy Dunlap
2020-07-08 1:22 ` Anshuman Khandual
2020-07-08 2:06 ` Randy Dunlap
2020-07-08 5:09 ` Anshuman Khandual
2020-07-08 6:40 ` Anshuman Khandual
2020-07-08 6:43 ` Mike Rapoport [this message]
2020-07-08 13:21 ` 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=20200708064332.GD128651@kernel.org \
--to=rppt@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=anshuman.khandual@arm.com \
--cc=corbet@lwn.net \
--cc=linux-arch@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=rdunlap@infradead.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.