[PATCH] format shell command as code block

[PATCH] format shell command as code block

[Weiji Wang]

This formats the last two shell commands in
Documentation/admin-guide/mm/zswap.rst as code blocks.

---
 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 b42132969..85612d705 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] format shell command as code block

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 282 bytes --]

On Mon, Mar 18, 2024 at 10:01:25PM +0800, Weiji Wang wrote:
> This formats the last two shell commands in
> Documentation/admin-guide/mm/zswap.rst as code blocks.

Why?

Also missing Signed-off-by.

Confused...

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] format shell command as code block

[Jonathan Corbet]

Weiji Wang <nebclllo0444@gmail.com> writes:

> This formats the last two shell commands in
> Documentation/admin-guide/mm/zswap.rst as code blocks.
>
> ---
>  Documentation/admin-guide/mm/zswap.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

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.

> diff --git a/Documentation/admin-guide/mm/zswap.rst b/Documentation/admin-guide/mm/zswap.rst
> index b42132969..85612d705 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

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

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.