[PATCH] ls-files: use imperative mood for -X and -z option description

[PATCH] ls-files: use imperative mood for -X and -z option description

[Bagas Sanjaya]

Usage description for -X and -z options use descriptive instead of
imperative mood. Change it for consistency with other options.

Cc: Jeff King <peff@peff.net>
Cc: <liu.denton@gmail.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 builtin/ls-files.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/builtin/ls-files.c b/builtin/ls-files.c
index 29a26ad8ae..1f38cd7b17 100644
--- a/builtin/ls-files.c
+++ b/builtin/ls-files.c
@@ -614,7 +614,7 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
 	struct option builtin_ls_files_options[] = {
 		/* Think twice before adding "--nul" synonym to this */
 		OPT_SET_INT('z', NULL, &line_terminator,
-			N_("paths are separated with NUL character"), '\0'),
+			N_("separate paths with NUL character"), '\0'),
 		OPT_BOOL('t', NULL, &show_tag,
 			N_("identify the file status with tags")),
 		OPT_BOOL('v', NULL, &show_valid_bit,
@@ -651,7 +651,7 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
 			N_("skip files matching pattern"),
 			PARSE_OPT_NONEG, option_parse_exclude),
 		OPT_CALLBACK_F('X', "exclude-from", &dir, N_("file"),
-			N_("exclude patterns are read from <file>"),
+			N_("read exclude patterns from <file>"),
 			PARSE_OPT_NONEG, option_parse_exclude_from),
 		OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
 			N_("read additional per-directory exclude patterns in <file>")),

base-commit: 4c719308ce59dc70e606f910f40801f2c6051b24
-- 
2.25.1

Re: [PATCH] ls-files: use imperative mood for -X and -z option description

[Taylor Blau]

Hi Bagas,

On Mon, Sep 20, 2021 at 07:19:41PM +0700, Bagas Sanjaya wrote:
> Usage description for -X and -z options use descriptive instead of
> imperative mood. Change it for consistency with other options.

Your patch looks fine to me. I don't think it's urgent to change, but it
looks correct nonetheless.

> Cc: Jeff King <peff@peff.net>
> Cc: <liu.denton@gmail.com>

These Cc trailers can be removed. (They're not entirely unprecedented,
but I can only find ~200 examples in git.git's history).

> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  builtin/ls-files.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/builtin/ls-files.c b/builtin/ls-files.c
> index 29a26ad8ae..1f38cd7b17 100644
> --- a/builtin/ls-files.c
> +++ b/builtin/ls-files.c
> @@ -614,7 +614,7 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
>  	struct option builtin_ls_files_options[] = {
>  		/* Think twice before adding "--nul" synonym to this */
>  		OPT_SET_INT('z', NULL, &line_terminator,
> -			N_("paths are separated with NUL character"), '\0'),
> +			N_("separate paths with NUL character"), '\0'),

The text before your patch should include an article so it reads "with
[the] NUL character" instead of "with NUL character".

So I think the right post-image would be: "separate paths with the NUL
character".

Thanks,
Taylor

Re: [PATCH] ls-files: use imperative mood for -X and -z option description

[Junio C Hamano]

Taylor Blau <me@ttaylorr.com> writes:

> Your patch looks fine to me. I don't think it's urgent to change, but it
> looks correct nonetheless.
>
>> Cc: Jeff King <peff@peff.net>
>> Cc: <liu.denton@gmail.com>
>
> These Cc trailers can be removed. (They're not entirely unprecedented,
> but I can only find ~200 examples in git.git's history).

Yup, "can" and probably "should".  It is meant for consumption by
your e-mail software.

>>  		OPT_SET_INT('z', NULL, &line_terminator,
>> -			N_("paths are separated with NUL character"), '\0'),
>> +			N_("separate paths with NUL character"), '\0'),
>
> The text before your patch should include an article so it reads "with
> [the] NUL character" instead of "with NUL character".
>
> So I think the right post-image would be: "separate paths with the NUL
> character".

Correct.  Grammar fixes are very much appreciated, especially in an
international project like this one.

Thanks.