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

Subsystems: the rest

STALE1800d

2 messages, 2 authors, 2021-09-21 · open the first message on its own page

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

From: Bagas Sanjaya <hidden>
Date: 2021-09-21 11:15:15

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 <redacted>
---

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 [off-list ref]
     
    @@ 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(-)
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

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

From: Jeff King <hidden>
Date: 2021-09-21 14:16:20

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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help