Re: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers
On 7/7/20 11:43 PM, Mike Rapoport wrote: > 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-...@vger.kernel.org >> Cc: Anshuman Khandual >> Cc: Mike Rapoport >> Cc: linux-a...@vger.kernel.org >> Cc: linux...@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 Works for me. Thanks. -- ~Randy
Re: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers
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-...@vger.kernel.org > Cc: Anshuman Khandual > Cc: Mike Rapoport > Cc: linux-a...@vger.kernel.org > Cc: linux...@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 | -
Re: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers
On 07/08/2020 06:37 AM, 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-...@vger.kernel.org > Cc: Anshuman Khandual > Cc: Mike Rapoport > Cc: linux-a...@vger.kernel.org > Cc: linux...@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 > | > - > -| 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
Re: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers
On 07/08/2020 07:36 AM, Randy Dunlap wrote: > On 7/7/20 6:22 PM, Anshuman Khandual wrote: >> >> >> On 07/08/2020 06:37 AM, 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-...@vger.kernel.org >>> Cc: Anshuman Khandual >>> Cc: Mike Rapoport >>> Cc: linux-a...@vger.kernel.org >>> Cc: linux...@kvack.org >>> Cc: Andrew Morton >>> --- >>> Documentation/vm/arch_pgtable_helpers.rst | 333 ++-- >>> 1 file changed, 116 insertions(+), 217 deletions(-) >> >> Do you have a git URL some where to see these new output ? This >> documentation is also useful when reading from a terminal where >> these manual line drawing tables make sense. >> > > No, I don't have a git URL. > You can go to > https://drive.google.com/file/d/1FO6lCRKldzESwLdylvY8tw10dOBvwz84/view?usp=sharing > > I had to Download the file and then view it locally. I couldn't get Google > Drive > to display it for me as html (only as text). I could see it locally as well on a browser and the table looks the same way like those current manual ones on a terminal, so looks good to me. > > I understand about reading tables at a terminal. > This file could have been a txt file for that, but it's not. It's a RsT file. Thats right. All files in Documentation/vm/ are .rst type, hence would not like to have a .txt type in there. > > If you want to leave it as is, please fix these warnings: Thats right. Can not have in both ways. Lets stick with .rst and change as required.
Re: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers
On 7/7/20 6:22 PM, Anshuman Khandual wrote: > > > On 07/08/2020 06:37 AM, 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-...@vger.kernel.org >> Cc: Anshuman Khandual >> Cc: Mike Rapoport >> Cc: linux-a...@vger.kernel.org >> Cc: linux...@kvack.org >> Cc: Andrew Morton >> --- >> Documentation/vm/arch_pgtable_helpers.rst | 333 ++-- >> 1 file changed, 116 insertions(+), 217 deletions(-) > > Do you have a git URL some where to see these new output ? This > documentation is also useful when reading from a terminal where > these manual line drawing tables make sense. > No, I don't have a git URL. You can go to https://drive.google.com/file/d/1FO6lCRKldzESwLdylvY8tw10dOBvwz84/view?usp=sharing I had to Download the file and then view it locally. I couldn't get Google Drive to display it for me as html (only as text). I understand about reading tables at a terminal. This file could have been a txt file for that, but it's not. It's a RsT file. If you want to leave it as is, please fix these warnings: Documentation/vm/arch_pgtable_helpers.rst:24: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:28: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:32: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:36: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:40: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:44: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:48: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:52: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:56: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:60: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:64: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:68: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:72: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:76: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:88: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:92: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:96: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:100: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:104: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:108: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:112: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:116: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:120: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:124: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:128: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:132: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:136: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:140: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:144: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:148: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:152: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:162: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:166: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:170: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:174: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:178: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:182: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:186: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:190: WARNING: Line block ends without a blank line. Documentation/vm/arch_pgtable_helpers.rst:194: WARNING: Line block ends without a
Re: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers
On 07/08/2020 06:37 AM, 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-...@vger.kernel.org > Cc: Anshuman Khandual > Cc: Mike Rapoport > Cc: linux-a...@vger.kernel.org > Cc: linux...@kvack.org > Cc: Andrew Morton > --- > Documentation/vm/arch_pgtable_helpers.rst | 333 ++-- > 1 file changed, 116 insertions(+), 217 deletions(-) Do you have a git URL some where to see these new output ? This documentation is also useful when reading from a terminal where these manual line drawing tables make sense.
[PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers
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-...@vger.kernel.org Cc: Anshuman Khandual Cc: Mike Rapoport Cc: linux-a...@vger.kernel.org Cc: linux...@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 | - -| 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 |
