Web lists-archives.com

Re: [PATCH v1] add status config and command line options for rename detection






On 5/9/2018 12:56 PM, Elijah Newren wrote:
Hi Ben,

Overall I think this is good, but I have lots of nit-picky things to
bring up.  :-)



Thank you for the review. I appreciate the extra set of eyes on these changes. Especially when dealing with the merge logic and settings which I am unfamiliar with.


I suspect that status.renames should mention "copy", just as
diff.renames does.  (We didn't mention it in merge.renames, because
merge isn't an operation for which copy detection can be useful -- at
least not until the diffstat at the end of the merge is controlled by
merge.renames as well...)


I wasn't supporting copy (as you noticed later in the patch) but will update the patch to do so and update the documentation appropriately.

Also, do these two config settings only affect 'git status', or does
it also affect the status shown when composing a commit message
(assuming the user hasn't turned commit.status off)?  Does it affect
`git commit --dry-run` too?


The config settings only affect 'git status'

--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -109,6 +109,10 @@ static int have_option_m;
  static struct strbuf message = STRBUF_INIT;

  static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
+static int diff_detect_rename = -1;
+static int status_detect_rename = -1;
+static int diff_rename_limit = -1;
+static int status_rename_limit = -1;

Could we replace these four variables with just two: detect_rename and
rename_limit?  Keeping these separate invites people to write code
using only one of the settings rather than the appropriate inherited
mixture of them, resulting in a weird bug.  More on this below...


This model was inherited from the diff code and replicated to the merge code. However, it would be nice to get rid of these 4 static variables. See below for a proposal on how to do that...

@@ -1259,11 +1273,29 @@ static int git_status_config(const char *k, const char *v, void *cb)
                         return error(_("Invalid untracked files mode '%s'"), v);
                 return 0;
         }
+       if (!strcmp(k, "diff.renamelimit")) {
+               diff_rename_limit = git_config_int(k, v);
+               return 0;
+       }
+       if (!strcmp(k, "status.renamelimit")) {
+               status_rename_limit = git_config_int(k, v);
+               return 0;
+       }

Here, since you're already checking diff.renamelimit first, you can
just set rename_limit in both blocks and not need both
diff_rename_limit and status_rename_limit.  (Similar can be said for
diff.renames/status.renames.)

It really doesn't work that way - the call back is called for every config setting and there is no specific order they are called with. Typically, you just test for and save off any that you care about like I"m doing here.

I can update the logic here so that as I save off the settings that it will also enforce the priority model (ie the diff setting can't override the status setting) and then compute the final value once I have the command line arguments as they override either config setting (if present).

On the plus side, this change passes the red/green test but it now splits the priority logic into two places and doesn't match with how diff and merge handle this same issue.


<snip>

@@ -1297,6 +1329,10 @@ int cmd_status(int argc, const char **argv, const char *prefix)
                   N_("ignore changes to submodules, optional when: all, dirty, untracked. (Default: all)"),
                   PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
                 OPT_COLUMN(0, "column", &s.colopts, N_("list untracked files in columns")),
+               OPT_BOOL(0, "no-renames", &no_renames, N_("do not detect renames")),
+               { OPTION_CALLBACK, 'M', "find-renames", &rename_score_arg,
+                 N_("n"), N_("detect renames, optionally set similarity index"),
+                 PARSE_OPT_OPTARG, opt_parse_rename_score },

Should probably also document these options in
Documentation/git-status.txt (and maybe Documentation/git-commit.txt
as well).

Good point, will do.


Not sure if we want to add a flag for copy detection (similar to
git-diff's -C/--find-copies and --find-copies-harder), or just leave
that for when someone finds a need.  If left out, might want to just
mention that it was considered and intentionally omitted for now in
the commit message.


I tend to only implement the features I know are actually needed so intentionally omitted this (along with many other potential diff options).

+       if ((intptr_t)rename_score_arg != -1) {

I don't understand why rename_score_arg is a (char*) and then you need
to cast to intptr_t, but that may just be because I haven't done much
of anything with option parsing.  A quick look at the docs isn't
making it clear to me, though; could you enlighten me?


Yes, it is related to making parse_options() do what we need. -1 means the command line option wasn't passed so use the default. NULL means the command line argument was passed but without the optional score. A non NULL, non -1 value means the optional score was passed and needs to be parsed. The (intptr_t_) cast is to enable comparing a pointer to an integer (-1) without generating a compiler warning.

+               s.detect_rename = DIFF_DETECT_RENAME;

What if status.renames is 'copy' but someone wants to override the
score for detecting renames and pass --find-renames=40?  Does the
--find-renames override and degrade the 'copy'?  I think it'd make
more sense to increase s.detect_rename to at least DIFF_DETECT_RENAME,
rather than just outright setting it here.


I understand your argument and agree that it makes some sense. I am matching the same logic in merge-recursive.c which just sets detect_rename to 1 in this case. I believe more strongly that they should be consistent than in one option over the other.

If I'm reading the merge logic for this case incorrectly or if you're willing to patch the merge logic to match :), I'm happy to change this to:

		if (s.detect_rename < DIFF_DETECT_RENAME)
			s.detect_rename = DIFF_DETECT_RENAME;

+                                        s.rename_limit;
+
+       /*
+        * We do not have logic to handle the detection of copies.  In
+        * fact, it may not even make sense to add such logic: would we
+        * really want a change to a base file to be propagated through
+        * multiple other files by a merge?
+        */
+       if (s.detect_rename > DIFF_DETECT_RENAME)
+               s.detect_rename = DIFF_DETECT_RENAME;

This comment and code made sense in merge-recursive.c (which doesn't
show detected diffs/renames/copies but just uses them for internal
processing logic).  It does not make sense here; git status could show
detected copies much like `git diff -C --name-status` shows it.  In
fact, a quick grep for DIFF_STATUS_COPIED shows multiple hits in
wt-status.c, so I suspect it already has the necessary logic for
displaying copies.


Clearly I was following my similar patch series for merge too closely without thinking through how they should be different. Thanks for catching this. Gone. :)