[PATCH] btrfs-progs: fix inspect-internal --help incomplete sentence

[PATCH] btrfs-progs: fix inspect-internal --help incomplete sentence

[Anand Jain]

btrfs inspect-internal --help show some incomplete sentenses. As shown
below,

  btrfs inspect-internal --help
  <snip>
      btrfs inspect-internal min-dev-size [options] <path>
          Get the minimum size the device can be shrunk to. The
      btrfs inspect-internal dump-tree [options] <device> [<device> ..]
  <snip>

This patch just fixes it.

Also, the consistency is missing whether to add a period after the
one-line statement of the btrfs --help output.
So while here, this patch adds a period at the end of the help
statement and makes it consistent within the command
btrfs inspect-internal --help.

Signed-off-by: Anand Jain <anand.jain@oracle.com>
---
 cmds/inspect.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/cmds/inspect.c b/cmds/inspect.c
index 15f19c8a3027..fcb3b1ae1321 100644
--- a/cmds/inspect.c
+++ b/cmds/inspect.c
@@ -80,7 +80,7 @@ out:
 
 static const char * const cmd_inspect_inode_resolve_usage[] = {
 	"btrfs inspect-internal inode-resolve [-v] <inode> <path>",
-	"Get file system paths for the given inode",
+	"Get file system paths for the given inode.",
 	"",
 	"-v   deprecated, alias for global -v option",
 	HELPINFO_INSERT_GLOBALS,
@@ -126,7 +126,7 @@ static DEFINE_SIMPLE_COMMAND(inspect_inode_resolve, "inode-resolve");
 
 static const char * const cmd_inspect_logical_resolve_usage[] = {
 	"btrfs inspect-internal logical-resolve [-Pvo] [-s bufsize] <logical> <path>",
-	"Get file system paths for the given logical address",
+	"Get file system paths for the given logical address.",
 	"",
 	"-P          skip the path resolving and print the inodes instead",
 	"-o          ignore offsets when matching references (requires v2 ioctl",
@@ -389,9 +389,9 @@ static DEFINE_SIMPLE_COMMAND(inspect_rootid, "rootid");
 
 static const char* const cmd_inspect_min_dev_size_usage[] = {
 	"btrfs inspect-internal min-dev-size [options] <path>",
-	"Get the minimum size the device can be shrunk to. The",
-	"device id 1 is used by default.",
+	"Get the minimum size the device can be shrunk to.",
 	"",
+	"The device id 1 is used by default.",
 	"--id DEVID   specify the device id to query",
 	NULL
 };
-- 
2.29.2

[PATCH v2] btrfs-progs: fix inspect-internal --help incomplete sentence

[Anand Jain]

btrfs inspect-internal --help show some incomplete sentenses. As shown
below,

  btrfs inspect-internal --help
  <snip>
      btrfs inspect-internal min-dev-size [options] <path>
          Get the minimum size the device can be shrunk to. The
      btrfs inspect-internal dump-tree [options] <device> [<device> ..]
  <snip>

This patch just fixes it.

Signed-off-by: Anand Jain <anand.jain@oracle.com>
---
v2: Drop the idea to fix the period at the end of the single line help
    statements. Because the fix wasn't sufficient, there are more, and
    it can be done separately.

 cmds/inspect.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/cmds/inspect.c b/cmds/inspect.c
index 15f19c8a3027..4e3e6382637a 100644
--- a/cmds/inspect.c
+++ b/cmds/inspect.c
@@ -389,9 +389,9 @@ static DEFINE_SIMPLE_COMMAND(inspect_rootid, "rootid");
 
 static const char* const cmd_inspect_min_dev_size_usage[] = {
 	"btrfs inspect-internal min-dev-size [options] <path>",
-	"Get the minimum size the device can be shrunk to. The",
-	"device id 1 is used by default.",
+	"Get the minimum size the device can be shrunk to",
 	"",
+	"The device id 1 is used by default.",
 	"--id DEVID   specify the device id to query",
 	NULL
 };
-- 
2.29.2

Re: [PATCH v2] btrfs-progs: fix inspect-internal --help incomplete sentence

[Anand Jain]

  Gentle ping. Can you pls consider this patch for the next release?

Thanks, Anand

On 19/03/2021 15:10, Anand Jain wrote:
> btrfs inspect-internal --help show some incomplete sentenses. As shown
> below,
> 
>    btrfs inspect-internal --help
>    <snip>
>        btrfs inspect-internal min-dev-size [options] <path>
>            Get the minimum size the device can be shrunk to. The
>        btrfs inspect-internal dump-tree [options] <device> [<device> ..]
>    <snip>
> 
> This patch just fixes it.
> 
> Signed-off-by: Anand Jain <anand.jain@oracle.com>
> ---
> v2: Drop the idea to fix the period at the end of the single line help
>      statements. Because the fix wasn't sufficient, there are more, and
>      it can be done separately.
> 
>   cmds/inspect.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/cmds/inspect.c b/cmds/inspect.c
> index 15f19c8a3027..4e3e6382637a 100644
> --- a/cmds/inspect.c
> +++ b/cmds/inspect.c
> @@ -389,9 +389,9 @@ static DEFINE_SIMPLE_COMMAND(inspect_rootid, "rootid");
>   
>   static const char* const cmd_inspect_min_dev_size_usage[] = {
>   	"btrfs inspect-internal min-dev-size [options] <path>",
> -	"Get the minimum size the device can be shrunk to. The",
> -	"device id 1 is used by default.",
> +	"Get the minimum size the device can be shrunk to",
>   	"",
> +	"The device id 1 is used by default.",
>   	"--id DEVID   specify the device id to query",
>   	NULL
>   };
> 

Re: [PATCH v2] btrfs-progs: fix inspect-internal --help incomplete sentence

[David Sterba]

On Fri, Mar 19, 2021 at 03:10:02PM +0800, Anand Jain wrote:
> btrfs inspect-internal --help show some incomplete sentenses. As shown
> below,
> 
>   btrfs inspect-internal --help
>   <snip>
>       btrfs inspect-internal min-dev-size [options] <path>
>           Get the minimum size the device can be shrunk to. The
>       btrfs inspect-internal dump-tree [options] <device> [<device> ..]
>   <snip>
> 
> This patch just fixes it.
> 
> Signed-off-by: Anand Jain <anand.jain@oracle.com>
> ---
> v2: Drop the idea to fix the period at the end of the single line help
>     statements. Because the fix wasn't sufficient, there are more, and
>     it can be done separately.

Added to devel, thanks.