[dm-devel] [PATCH v3 4/4] dm dust: introduce listbadblocks in the rst

[Bryan Gurney]

On Fri, Jun 19, 2020 at 8:37 AM yangerkun <yangerkun at huawei.com> wrote:
>
> Since we support the listbadblocks command, introduce the detail in the
> doc.
>
> Signed-off-by: yangerkun <yangerkun at huawei.com>
> ---
>  .../admin-guide/device-mapper/dm-dust.rst        | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>
> diff --git a/Documentation/admin-guide/device-mapper/dm-dust.rst b/Documentation/admin-guide/device-mapper/dm-dust.rst
> index 84149c08b68f..5c66a71e3442 100644
> --- a/Documentation/admin-guide/device-mapper/dm-dust.rst
> +++ b/Documentation/admin-guide/device-mapper/dm-dust.rst
> @@ -205,6 +205,21 @@ If there were no bad blocks to clear, the following message will
>  appear::
>
>          no badblocks found
> +Listing the bad block list
> +--------------------------
> +
> +To list all bad blocks in the bad block list(using an example device
> +with blocks 1 and 2 in the bad block list),run the following message
> +command::

There are a couple of missing spaces here, at these two locations:

"...bad block list(using..."
change to
"...bad block list (using..."

and

"...in the bad block list),run the..."
change to
"...in the bad block list), run the..."

> +
> +        $ sudo dmsetup message dust1 0 listbadblocks
> +        1
> +        2
> +
> +No bad block exists, same message will get following report::

This would be better as the following:

"If there are no bad blocks in the bad block list, the following
message will appear"

However, note that we discussed changing this to an empty line,
instead of "null", so we would need to update the documentation to
reflect that the output will be an empty line.


Thanks,

Bryan

> +
> +        $ sudo dmsetup message dust1 0 listbadblocks
> +        null
>
>  Message commands list
>  ---------------------
> @@ -224,6 +239,7 @@ Single argument message commands::
>
>          countbadblocks
>          clearbadblocks
> +        listbadblocks
>          disable
>          enable
>          quiet
> --
> 2.25.4
>