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

From: Taylor Blau <me@ttaylorr.com>
Date: Sep 20, 2021, 15:08 UTC
Message-ID: <YUij2Aj04B1Q1tRV@nand.local>
In-Reply-To: <20210920121940.905549-1-bagasdotme@gmail.com>

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).

Show 15 quoted lines

> 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