From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 418AFC433DF for ; Wed, 8 Jul 2020 06:43:41 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 0791F207BB for ; Wed, 8 Jul 2020 06:43:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1594190621; bh=wYw2Rn0PzDLDnp3gdXkTEdy3RqWOC7UAaw77Oz2G7VQ=; h=Date:From:To:Cc:Subject:References:In-Reply-To:List-ID:From; b=ZZ7AZG9j6TAfo0w7zyLCHbtD8Y8eoNt6osX/cs0PAL10dY1Hb6aV6eXSO2FovEcba WcxLpJ4Hw4WlrL2Rmc9dXVOFAc4R5Sus2agaDCCWt1aLY/r0SZS2ghk/CXzD6yEDMQ Lp+yMVhD+S6pyC//5/PGJWvIBIVtwLbF3yax8E8I= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729209AbgGHGnk (ORCPT ); Wed, 8 Jul 2020 02:43:40 -0400 Received: from mail.kernel.org ([198.145.29.99]:48106 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726206AbgGHGnk (ORCPT ); Wed, 8 Jul 2020 02:43:40 -0400 Received: from kernel.org (unknown [87.71.40.38]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 76933206E2; Wed, 8 Jul 2020 06:43:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1594190618; bh=wYw2Rn0PzDLDnp3gdXkTEdy3RqWOC7UAaw77Oz2G7VQ=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=wdEB37dbei/DRvGByl2cvzRXPEn8egdmiMIEzxWGKqOUcP9qPHn8ki44p4FHHn0yC GWdVWnsGUHn1jFlJAb6pZwm/61TTwnHyrUmH7UH9W4TB8RuTcIuEnWEYFfMGe4wLbU r6sngx4D5+795d4stA0l0nIUG+NcJA/0YfZg6I74= Date: Wed, 8 Jul 2020 09:43:32 +0300 From: Mike Rapoport To: Randy Dunlap , Andrew Morton Cc: Linux MM , LKML , "linux-doc@vger.kernel.org" , Jonathan Corbet , Anshuman Khandual , "linux-arch@vger.kernel.org" Subject: Re: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers Message-ID: <20200708064332.GD128651@kernel.org> References: <02ee60d0-e836-2237-4881-5c57ccac5551@infradead.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <02ee60d0-e836-2237-4881-5c57ccac5551@infradead.org> Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org Hi Randy, On Tue, Jul 07, 2020 at 06:07:40PM -0700, Randy Dunlap wrote: > From: Randy Dunlap > > Make the tables be presented as tables in the generated output files > (the line drawing did not present well). > > Signed-off-by: Randy Dunlap > Cc: Jonathan Corbet > Cc: linux-doc@vger.kernel.org > Cc: Anshuman Khandual > Cc: Mike Rapoport > Cc: linux-arch@vger.kernel.org > Cc: linux-mm@kvack.org > Cc: Andrew Morton > --- > 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.