diff mbox series

Documentation: fix vm/slub.rst warning

Message ID 1e992162-c4ac-fe4e-f1b0-d8a16a51d5e7@infradead.org (mailing list archive)
State New, archived
Headers show
Series Documentation: fix vm/slub.rst warning | expand

Commit Message

Randy Dunlap Feb. 11, 2019, 6:34 a.m. UTC
From: Randy Dunlap <rdunlap@infradead.org>

Fix markup warning by quoting the '*' character with a backslash.

Documentation/vm/slub.rst:71: WARNING: Inline emphasis start-string without end-string.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Christoph Lameter <cl@linux.com>
Cc: Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com>
---
 Documentation/vm/slub.rst |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Mike Rapoport Feb. 11, 2019, 7:35 a.m. UTC | #1
On Sun, Feb 10, 2019 at 10:34:11PM -0800, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix markup warning by quoting the '*' character with a backslash.
> 
> Documentation/vm/slub.rst:71: WARNING: Inline emphasis start-string without end-string.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Christoph Lameter <cl@linux.com>
> Cc: Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com>

Acked-by: Mike Rapoport <rppt@linux.ibm.com>
> ---
>  Documentation/vm/slub.rst |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- lnx-50-rc6.orig/Documentation/vm/slub.rst
> +++ lnx-50-rc6/Documentation/vm/slub.rst
> @@ -68,7 +68,7 @@ end of the slab name, in order to cover
>  example, here's how you can poison the dentry cache as well as all kmalloc
>  slabs:
> 
> -	slub_debug=P,kmalloc-*,dentry
> +	slub_debug=P,kmalloc-\*,dentry
> 
>  Red zoning and tracking may realign the slab.  We can just apply sanity checks
>  to the dentry cache with::
> 
>
Sergey Senozhatsky Feb. 11, 2019, 7:43 a.m. UTC | #2
On (02/11/19 09:35), Mike Rapoport wrote:
> On Sun, Feb 10, 2019 at 10:34:11PM -0800, Randy Dunlap wrote:
> > From: Randy Dunlap <rdunlap@infradead.org>
> > 
> > Fix markup warning by quoting the '*' character with a backslash.
> > 
> > Documentation/vm/slub.rst:71: WARNING: Inline emphasis start-string without end-string.
> > 
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > Cc: Christoph Lameter <cl@linux.com>
> > Cc: Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com>
> 
> Acked-by: Mike Rapoport <rppt@linux.ibm.com>

FWIW,
Reviewed-by: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>

	-ss
Jonathan Corbet Feb. 11, 2019, 3:27 p.m. UTC | #3
On Sun, 10 Feb 2019 22:34:11 -0800
Randy Dunlap <rdunlap@infradead.org> wrote:

> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix markup warning by quoting the '*' character with a backslash.
> 
> Documentation/vm/slub.rst:71: WARNING: Inline emphasis start-string without end-string.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Christoph Lameter <cl@linux.com>
> Cc: Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com>
> ---
>  Documentation/vm/slub.rst |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- lnx-50-rc6.orig/Documentation/vm/slub.rst
> +++ lnx-50-rc6/Documentation/vm/slub.rst
> @@ -68,7 +68,7 @@ end of the slab name, in order to cover
>  example, here's how you can poison the dentry cache as well as all kmalloc
>  slabs:
>  
> -	slub_debug=P,kmalloc-*,dentry
> +	slub_debug=P,kmalloc-\*,dentry
>  
>  Red zoning and tracking may realign the slab.  We can just apply sanity checks
>  to the dentry cache with::

The better fix here is to make that a literal block ("slabs::").  Happily
for all of us, Tobin already did that in 11ede50059d0.

Thanks,

jon
Randy Dunlap Feb. 11, 2019, 5:31 p.m. UTC | #4
On 2/11/19 7:27 AM, Jonathan Corbet wrote:
> On Sun, 10 Feb 2019 22:34:11 -0800
> Randy Dunlap <rdunlap@infradead.org> wrote:
> 
>> From: Randy Dunlap <rdunlap@infradead.org>
>>
>> Fix markup warning by quoting the '*' character with a backslash.
>>
>> Documentation/vm/slub.rst:71: WARNING: Inline emphasis start-string without end-string.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Christoph Lameter <cl@linux.com>
>> Cc: Sergey Senozhatsky <sergey.senozhatsky.work@gmail.com>
>> ---
>>  Documentation/vm/slub.rst |    2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> --- lnx-50-rc6.orig/Documentation/vm/slub.rst
>> +++ lnx-50-rc6/Documentation/vm/slub.rst
>> @@ -68,7 +68,7 @@ end of the slab name, in order to cover
>>  example, here's how you can poison the dentry cache as well as all kmalloc
>>  slabs:
>>  
>> -	slub_debug=P,kmalloc-*,dentry
>> +	slub_debug=P,kmalloc-\*,dentry
>>  
>>  Red zoning and tracking may realign the slab.  We can just apply sanity checks
>>  to the dentry cache with::
> 
> The better fix here is to make that a literal block ("slabs::").  Happily
> for all of us, Tobin already did that in 11ede50059d0.

Thanks for the info.
diff mbox series

Patch

--- lnx-50-rc6.orig/Documentation/vm/slub.rst
+++ lnx-50-rc6/Documentation/vm/slub.rst
@@ -68,7 +68,7 @@  end of the slab name, in order to cover
 example, here's how you can poison the dentry cache as well as all kmalloc
 slabs:
 
-	slub_debug=P,kmalloc-*,dentry
+	slub_debug=P,kmalloc-\*,dentry
 
 Red zoning and tracking may realign the slab.  We can just apply sanity checks
 to the dentry cache with::