Johan Herland <johan@xxxxxxxxxxx> writes:
> Instead of having multiple interconnected dirstat-related options, teach
> the --dirstat option itself to accept all behavior modifiers as arguments.
>
> - Preserve the current --dirstat=<limit> (where <limit> is an integer
> specifying a cut-off percentage)
> - Add --dirstat=cumulative, replacing --cumulative
> - Add --dirstat=files, replacing --dirstat-by-file
> - Also add --dirstat=changes and --dirstat=noncumulative for specifying the
> current default behavior. These allow the user to reset other --dirstat
> arguments (e.g. 'cumulative' and 'files') occuring earlier on the command
> line.
>
> Allow multiple arguments to be separated by commas, e.g.:
> --dirstat=files,10,cumulative
>
> Update the documentation accordingly, and add testcases verifying the
> behavior of the new syntax.
The above description is unclear if the version of git will error out when
given --cumulative or --dirstat-by-file. I can sort of guess by lack of
removed lines from the documentation, but please do not make readers guess.
Also a miniscule style nitpick: could you indent your bulletted-list just
a bit (one space indent is just fine)?
> diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
> index 7e4bd42..b6b1448 100644
> --- a/Documentation/diff-options.txt
> +++ b/Documentation/diff-options.txt
> @@ -66,19 +66,40 @@ endif::git-format-patch[]
> number of modified files, as well as number of added and deleted
> lines.
>
> ---dirstat[=<limit>]::
> - Output the distribution of relative amount of changes (number of lines added or
> - removed) for each sub-directory. Directories with changes below
> - a cut-off percent (3% by default) are not shown. The cut-off percent
> - can be set with `--dirstat=<limit>`. Changes in a child directory are not
> - counted for the parent directory, unless `--cumulative` is used.
> +--dirstat[=<arg1,arg2,...>]::
> + Output the distribution of relative amount of changes for each
> + sub-directory. The behavior of `--dirstat` can be customized by
> + passing it a comma separated list of arguments. The defaults
> + are controlled by the `diff.dirstat` configuration variable (see
> + linkgit:git-config[1]). The following arguments are available:
These "arguments" feel more like "options" (or "parameters"), no? Your
code in diff.c also calls it "opt". The second line of the proposed log
message has the same issue.
> +--
> +`changes`;;
> + Compute the dirstat numbers by counting the lines that have been
> + removed from the source, or added to the destination. This ignores
> + the amount of pure code movements within a file. In other words,
> + rearranging lines in a file is not counted as much as other changes.
> + This is the default `--dirstat` behavior.
"default behavior when no option is given"?
> +`files`;;
> + Compute the dirstat numbers by counting the number of files changed.
> + Each changed file counts equally in the dirstat analysis. This is
> + the computationally cheapest `--dirstat` behavior, since it does
> + not look at the file contents at all.
s/not look/not have to look/?
> +`cumulative`;;
> + Count changes in a child directory for the parent directory as well.
> + Note that when using `cumulative`, the sum of the percentages
> + reported may exceed 100%. The default (non-cumulative) behavior can
> + be specified with the `noncumulative` argument.
So the later one wins? I.e. --dirstat=cumulative,noncumulative from the
command line (which seems silly), or more importantly with
[alias]
dstat = diff --dirstat=cumulative
and you can say "git dstat --dirstat=noncumulative A..B"?
> diff --git a/diff.c b/diff.c
> index cfbfa92..08aaa47 100644
> --- a/diff.c
> +++ b/diff.c
> @@ -3144,6 +3144,72 @@ static int stat_opt(struct diff_options *options, const char **av)
> return argcount;
> }
>
/*
* Document what the return value from this function means here.
*/
> +static int dirstat_opt(struct diff_options *options, const char **av)
Do you have to pass "const char **av", or just "const char *arg"?
> +{
> + const char *p, *arg = av[0];
> + char *mangled = NULL;
> + char sep = '=';
> +
> + if (!strcmp(arg, "--cumulative")) /* deprecated */
> + /* handle '--cumulative' like '--dirstat=cumulative' */
> + p = "=cumulative";
> + else if (!strcmp(arg, "--dirstat-by-file") ||
> + !prefixcmp(arg, "--dirstat-by-file=")) { /* deprecated */
> + /* handle '--dirstat-by-file=*' like '--dirstat=files,*' */
> + mangled = xstrdup(arg + 2);
> + memcpy(mangled, "--dirstat=files", 15);
> + if (mangled[15]) {
> + assert(mangled[15] == '=');
> + mangled[15] = ',';
> + }
> + arg = mangled;
> + p = mangled + 9;
I understand you wanted to reuse the while() loop below, but I do not
think it is worth it. Isn't it easier to read if you handled the above
cases in their if/else body and return?
if (--cumulative) {
options->output_format |= DIFF_FORMAT_DIRSTAT;
DIFF_OPT_SET(options, DIRSTAT_CUMULATIVE);
return 1;
}
if (--dirstat-by-file) {
options->output_format |= DIFF_FORMAT_DIRSTAT;
DIFF_OPT_SET(options, DIRSTAT_BY_FILE);
return 1;
}
...
Even better, probably they can be left to diff_opt_parse() without calling
this function, as you are deprecating them and do not have to allow them
to take the opt1,opt2,... form of parameter.
> + }
> + else if (!prefixcmp(arg, "-X"))
> + p = arg + 2;
> + else if (!prefixcmp(arg, "--dirstat"))
> + p = arg + 9;
> + else
> + return 0;
> +
> + options->output_format |= DIFF_FORMAT_DIRSTAT;
> +
> + while (*p) {
> + if (*p != sep)
What happens to "diff -X3 A..B"?
> + die("Missing argument separator ('%c'), at index %lu of '%s'",
> + sep, p - arg, arg);
Don't you need to cast (p-arg) for %lu from ptrdiff type here? It
probably is more common to say s/index/char/;
> + sep = ',';
> + ++p;
We tend to write postincrement when there is no strong reason to do
otherwise.
> + if (!prefixcmp(p, "changes")) {
> + p += 7;
> + DIFF_OPT_CLR(options, DIRSTAT_BY_FILE);
> + }
> + else if (!prefixcmp(p, "files")) {
> + p += 5;
> + DIFF_OPT_SET(options, DIRSTAT_BY_FILE);
> + }
> + else if (!prefixcmp(p, "noncumulative")) {
> + p += 13;
> + DIFF_OPT_CLR(options, DIRSTAT_CUMULATIVE);
> + }
> + else if (!prefixcmp(p, "cumulative")) {
> + p += 10;
> + DIFF_OPT_SET(options, DIRSTAT_CUMULATIVE);
> + }
> + else if (isdigit(*p)) {
> + char *end;
> + options->dirstat_percent = strtoul(p, &end, 10);
> + assert(end > p);
> + p = end;
> + }
That's a senseless assert(), isn't it?
You already know the first letter is a digit, so assert(p < end) will
always be true. You may want to check that this particular option is all
digit by checking (*end == '\0' || *end == ',') but that is done at the
beginning of this loop anyway, so I don't think there is anything to check
here.
> + else
> + die("Unknown --dirstat argument '%s'", p);
The function parses dirstat_OPT, but this says argument?
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html