threads / patch / 56554

v2ls-files: use imperative mood for -X and -z option description

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

## tl;dr

2 messages between Sep 21, 2021 and Sep 21, 2021. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Bagas Sanjaya· Sep 21, 2021, 11:13 UTC · lore

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

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Changes since v1 [1]:
  - Add missing "the" article in -z description (suggested by Taylor
    Blau)
Range-diff against v1 [1]:
1:  eee9d91fc1 ! 1:  9f02334bdf ls-files: use imperative mood for -X and -z option description
    @@ Commit message
         ls-files: use imperative mood for -X and -z option description
     
         Usage description for -X and -z options use descriptive instead of
    -    imperative mood. Change it for consistency with other options.
    +    imperative mood. Edit it for consistency with other options.
     
         Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
     
    @@ builtin/ls-files.c: int cmd_ls_files(int argc, const char **argv, const char *cm
      		/* 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'),
    ++			N_("separate paths with the NUL character"), '\0'),
      		OPT_BOOL('t', NULL, &show_tag,
      			N_("identify the file status with tags")),
      		OPT_BOOL('v', NULL, &show_valid_bit,
[1]: https://lore.kernel.org/git/xmqqee9javtd.fsf@gitster.g/T/#t
 builtin/ls-files.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Show changes to builtin/ls-files.c +2 −2
diff --git a/builtin/ls-files.c b/builtin/ls-files.c
index 29a26ad8ae..e6d415e077 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 the 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
Jeff King· Sep 21, 2021, 14:16 UTC · re: Bagas Sanjaya · lore

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

On Tue, Sep 21, 2021 at 06:13:05PM +0700, Bagas Sanjaya wrote:
> Usage description for -X and -z options use descriptive instead of
> imperative mood. Edit it for consistency with other options.
Thanks, this version looks fine to me.
-Peff

← back to recent threads