[PATCH] mm: fix Documentation/vm/hmm.rst Sphinx warnings

[PATCH] mm: fix Documentation/vm/hmm.rst Sphinx warnings

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix Sphinx warnings in Documentation/vm/hmm.rst by using "::"
notation and inserting a blank line.  Also add a missing ';'.

Documentation/vm/hmm.rst:292: WARNING: Unexpected indentation.
Documentation/vm/hmm.rst:300: WARNING: Unexpected indentation.

Fixes: 023a019a9b4e ("mm/hmm: add default fault flags to avoid the need to pre-fill pfns arrays")

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jérôme Glisse <jglisse@redhat.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
---
 Documentation/vm/hmm.rst |    8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

--- lnx-52-rc1.orig/Documentation/vm/hmm.rst
+++ lnx-52-rc1/Documentation/vm/hmm.rst
@@ -288,15 +288,17 @@ For instance if the device flags for dev
     WRITE (1 << 62)
 
 Now let say that device driver wants to fault with at least read a range then
-it does set:
-    range->default_flags = (1 << 63)
+it does set::
+
+    range->default_flags = (1 << 63);
     range->pfn_flags_mask = 0;
 
 and calls hmm_range_fault() as described above. This will fill fault all page
 in the range with at least read permission.
 
 Now let say driver wants to do the same except for one page in the range for
-which its want to have write. Now driver set:
+which its want to have write. Now driver set::
+
     range->default_flags = (1 << 63);
     range->pfn_flags_mask = (1 << 62);
     range->pfns[index_of_write] = (1 << 62);

Re: [PATCH] mm: fix Documentation/vm/hmm.rst Sphinx warnings

[Mike Rapoport]

On Mon, May 20, 2019 at 02:24:01PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix Sphinx warnings in Documentation/vm/hmm.rst by using "::"
> notation and inserting a blank line.  Also add a missing ';'.
> 
> Documentation/vm/hmm.rst:292: WARNING: Unexpected indentation.
> Documentation/vm/hmm.rst:300: WARNING: Unexpected indentation.
> 
> Fixes: 023a019a9b4e ("mm/hmm: add default fault flags to avoid the need to pre-fill pfns arrays")
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jérôme Glisse <jglisse@redhat.com>
> Cc: Andrew Morton <akpm@linux-foundation.org>

Reviewed-by: Mike Rapoport <rppt@linux.ibm.com>

> ---
>  Documentation/vm/hmm.rst |    8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> --- lnx-52-rc1.orig/Documentation/vm/hmm.rst
> +++ lnx-52-rc1/Documentation/vm/hmm.rst
> @@ -288,15 +288,17 @@ For instance if the device flags for dev
>      WRITE (1 << 62)
> 
>  Now let say that device driver wants to fault with at least read a range then
> -it does set:
> -    range->default_flags = (1 << 63)
> +it does set::
> +
> +    range->default_flags = (1 << 63);
>      range->pfn_flags_mask = 0;
> 
>  and calls hmm_range_fault() as described above. This will fill fault all page
>  in the range with at least read permission.
> 
>  Now let say driver wants to do the same except for one page in the range for
> -which its want to have write. Now driver set:
> +which its want to have write. Now driver set::
> +
>      range->default_flags = (1 << 63);
>      range->pfn_flags_mask = (1 << 62);
>      range->pfns[index_of_write] = (1 << 62);
> 
> 

-- 
Sincerely yours,
Mike.

Re: [PATCH] mm: fix Documentation/vm/hmm.rst Sphinx warnings

[Jerome Glisse]

On Tue, May 21, 2019 at 11:21:18AM +0300, Mike Rapoport wrote:
> On Mon, May 20, 2019 at 02:24:01PM -0700, Randy Dunlap wrote:
> > From: Randy Dunlap <rdunlap@infradead.org>
> > 
> > Fix Sphinx warnings in Documentation/vm/hmm.rst by using "::"
> > notation and inserting a blank line.  Also add a missing ';'.
> > 
> > Documentation/vm/hmm.rst:292: WARNING: Unexpected indentation.
> > Documentation/vm/hmm.rst:300: WARNING: Unexpected indentation.
> > 
> > Fixes: 023a019a9b4e ("mm/hmm: add default fault flags to avoid the need to pre-fill pfns arrays")
> > 
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > Cc: Jérôme Glisse <jglisse@redhat.com>
> > Cc: Andrew Morton <akpm@linux-foundation.org>
> 
> Reviewed-by: Mike Rapoport <rppt@linux.ibm.com>

Reviewed-by: Jérôme Glisse <jglisse@redhat.com>


> 
> > ---
> >  Documentation/vm/hmm.rst |    8 +++++---
> >  1 file changed, 5 insertions(+), 3 deletions(-)
> > 
> > --- lnx-52-rc1.orig/Documentation/vm/hmm.rst
> > +++ lnx-52-rc1/Documentation/vm/hmm.rst
> > @@ -288,15 +288,17 @@ For instance if the device flags for dev
> >      WRITE (1 << 62)
> > 
> >  Now let say that device driver wants to fault with at least read a range then
> > -it does set:
> > -    range->default_flags = (1 << 63)
> > +it does set::
> > +
> > +    range->default_flags = (1 << 63);
> >      range->pfn_flags_mask = 0;
> > 
> >  and calls hmm_range_fault() as described above. This will fill fault all page
> >  in the range with at least read permission.
> > 
> >  Now let say driver wants to do the same except for one page in the range for
> > -which its want to have write. Now driver set:
> > +which its want to have write. Now driver set::
> > +
> >      range->default_flags = (1 << 63);
> >      range->pfn_flags_mask = (1 << 62);
> >      range->pfns[index_of_write] = (1 << 62);
> > 
> > 
> 
> -- 
> Sincerely yours,
> Mike.
>