| Message ID | 27ef94e9cc4189c3d74e984437dcce24e1f29678.1603889270.git.gitgitgadget@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | blame: enable funcname blaming with userdiff driver | expand |
Hi Eric, > Le 28 oct. 2020 à 13:33, Eric Sunshine <sunshine@sunshineco.com> a écrit : > > On Wed, Oct 28, 2020 at 8:48 AM Philippe Blain via GitGitGadget > <gitgitgadget@gmail.com> wrote: >> 'git blame -h' and 'git log -h' both show '-L <n,m>' and describe this >> option as "Process only line range n,m, counting from 1". No hint is >> given that a function name regex can also be used. >> >> Use <range> instead, and expand the description of the option to mention >> both modes. Remove "counting from 1" as it's uneeded; it's uncommon to >> refer to the first line of a file as "line 0". >> >> Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com> >> --- >> diff --git a/builtin/blame.c b/builtin/blame.c >> @@ -889,7 +889,8 @@ int cmd_blame(int argc, const char **argv, const char *prefix) >> - OPT_STRING_LIST('L', NULL, &range_list, N_("n,m"), N_("Process only line range n,m, counting from 1")), >> + OPT_STRING_LIST('L', NULL, &range_list, N_("range"), >> + N_("Process only the given line range (<range>=<start>,<end>) or function (<range>=:<funcname>)")), > > The "<range>=" bit is redundant and confusing (and ugly). Considering > that the description already says "Process only the given line > _range_", it should be fine to drop the "<range>=" lead-in. Perhaps: > > Process only the given line range <start>,<end> or :<funcname>" > > This might feel too succinct, but that's often true of short -h help. > Such succinctness is generally acceptable as long as more detailed > documentation can be discovered easily (such as in the 'man' page). > > Same comment regarding the rest of the changes in this patch. Yes, I agree. I've shortened it for v2 (and also made the changes you suggested for 2/6 and 4/6. Thanks for taking a look, Philippe.
diff --git a/builtin/blame.c b/builtin/blame.c index bb0f29300e..05f69211dd 100644 --- a/builtin/blame.c +++ b/builtin/blame.c @@ -889,7 +889,8 @@ int cmd_blame(int argc, const char **argv, const char *prefix) OPT_STRING(0, "contents", &contents_from, N_("file"), N_("Use <file>'s contents as the final image")), OPT_CALLBACK_F('C', NULL, &opt, N_("score"), N_("Find line copies within and across files"), PARSE_OPT_OPTARG, blame_copy_callback), OPT_CALLBACK_F('M', NULL, &opt, N_("score"), N_("Find line movements within and across files"), PARSE_OPT_OPTARG, blame_move_callback), - OPT_STRING_LIST('L', NULL, &range_list, N_("n,m"), N_("Process only line range n,m, counting from 1")), + OPT_STRING_LIST('L', NULL, &range_list, N_("range"), + N_("Process only the given line range (<range>=<start>,<end>) or function (<range>=:<funcname>)")), OPT__ABBREV(&abbrev), OPT_END() }; diff --git a/builtin/log.c b/builtin/log.c index 0a7ed4bef9..e6a3bb7803 100644 --- a/builtin/log.c +++ b/builtin/log.c @@ -183,8 +183,8 @@ static void cmd_log_init_finish(int argc, const char **argv, const char *prefix, N_("pattern"), N_("do not decorate refs that match <pattern>")), OPT_CALLBACK_F(0, "decorate", NULL, NULL, N_("decorate options"), PARSE_OPT_OPTARG, decorate_callback), - OPT_CALLBACK('L', NULL, &line_cb, "n,m:file", - N_("Process line range n,m in file, counting from 1"), + OPT_CALLBACK('L', NULL, &line_cb, "range:file", + N_("Trace the evolution of the given line range (<range>=<start>,<end>) or function (<range>=:<funcname>) in <file>"), log_line_range_callback), OPT_END() };