All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Weiji Wang <nebclllo0444@gmail.com>, linux-doc@vger.kernel.org
Cc: Weiji Wang <nebclllo0444@gmail.com>
Subject: Re: [PATCH] format shell command as code block
Date: Tue, 19 Mar 2024 01:51:42 -0600	[thread overview]
Message-ID: <87le6e8xrl.fsf@meer.lwn.net> (raw)
In-Reply-To: <20240318140129.21986-1-nebclllo0444@gmail.com>

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

  parent reply	other threads:[~2024-03-19  7:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-18 14:01 [PATCH] format shell command as code block Weiji Wang
2024-03-19  2:05 ` Bagas Sanjaya
2024-03-19  7:51 ` Jonathan Corbet [this message]
2024-03-19 11:35   ` [PATCH] docs: zswap: fix shell command format Weiji Wang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87le6e8xrl.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=nebclllo0444@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.