[PATCH] docs: zswap: fix shell command format

[PATCH] docs: zswap: fix shell command format

[Weiji Wang]

Format the shell commands as code block to keep the documentation in the
same style
Fixes: 501a06fe8e4c ("zswap: memcontrol: implement zswap writeback disabling")
Fixes: b5ba474f3f51 ("zswap: shrink zswap pool based on memory pressure")
Signed-off-by: Weiji Wang <nebclllo0444@gmail.com>
---
 Documentation/admin-guide/mm/zswap.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/mm/zswap.rst b/Documentation/admin-guide/mm/zswap.rst
index b42132969e31..13632671adae 100644
--- a/Documentation/admin-guide/mm/zswap.rst
+++ b/Documentation/admin-guide/mm/zswap.rst
@@ -155,7 +155,7 @@ Setting this parameter to 100 will disable the hysteresis.
 
 Some users cannot tolerate the swapping that comes with zswap store failures
 and zswap writebacks. Swapping can be disabled entirely (without disabling
-zswap itself) on a cgroup-basis as follows:
+zswap itself) on a cgroup-basis as follows::
 
 	echo 0 > /sys/fs/cgroup/<cgroup-name>/memory.zswap.writeback
 
@@ -166,7 +166,7 @@ writeback (because the same pages might be rejected again and again).
 When there is a sizable amount of cold memory residing in the zswap pool, it
 can be advantageous to proactively write these cold pages to swap and reclaim
 the memory for other use cases. By default, the zswap shrinker is disabled.
-User can enable it as follows:
+User can enable it as follows::
 
   echo Y > /sys/module/zswap/parameters/shrinker_enabled
 
-- 
2.43.0

Re: [PATCH] docs: zswap: fix shell command format

[Jonathan Corbet]

Weiji Wang <nebclllo0444@gmail.com> writes:

> Format the shell commands as code block to keep the documentation in the
> same style
> Fixes: 501a06fe8e4c ("zswap: memcontrol: implement zswap writeback disabling")
> Fixes: b5ba474f3f51 ("zswap: shrink zswap pool based on memory pressure")
> Signed-off-by: Weiji Wang <nebclllo0444@gmail.com>
> ---
>  Documentation/admin-guide/mm/zswap.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Applied, thanks.

jon

[PATCH] docs: zswap: fix shell command format

[Weiji Wang]

> The *idea* of the change is fine, but there are a couple of problems
> here.  I can't take a patch without a signed-off-by line, so you'll need
> to resubmit with that.

I will resubmit after correcting the format later. Sorry for any
inconvenience.

> Why three colons?  "as follows::" will do what you want.

I see. I will also edit that.