From: Sergey Organov <email@example.com> To: Junio C Hamano <firstname.lastname@example.org> Cc: Jeff King <email@example.com>, firstname.lastname@example.org Subject: Re: [PATCH 3/3] t/t4013: add test for --diff-merges=off Date: Sat, 08 Aug 2020 02:11:45 +0300 [thread overview] Message-ID: <email@example.com> (raw) In-Reply-To: <firstname.lastname@example.org> Junio C Hamano <email@example.com> writes: > Sergey Organov <firstname.lastname@example.org> writes: > >> I asked because I thought you see some essential difference between two >> tests, as you didn't suggest to add similar permutation test to the >> original. I think this reply resolves my doubt. > > Yeah, I didn't explain this very well. I think you actually did in a previous thread where I've suggested to change the order in the existing test to relax it slightly, but more explanations never hurt. > > The thing is that the way "--first-parent" interacts with other > options that countermand "--diff-merges" (i.e. "--no-diff-merges" > and "--diff-merges=off") needs to be highlighted with extra clarity, > simply because "--first-parent" is different from a simple > "combination" of "follow the first parent commit chain while > traversing" and "--diff-merges" [*1*] > > [ *1* It makes it worse that the "-m" option itself changes behavior > (whether it is given explicitly or implied) when used together with > "--first-parent". Unlike "git log -m -p" without "--first-parent", > you cannot see the difference the mainline brought in to the side > branch when the "--first-parent" option is in use. ] The more you explain it, the more I'm reinforced in my view that the whole thing is unnecessary complicated, and that we'd better fix it than try to cast it in stone. > It merely "implies" (or "defaults", which is the usual word we use) > "--diff-merges", so anything the user says explicitly on the command > line countermands it, i.e. This sounds exactly as if "implied" option were put at the beginning of the options list, no? By the way, could you please give an example in documentation where "defaults" is used to mean "implies", or is it informal and just for communication of intentions? I failed to find it myself, see below. > > git log --first-parent --no-diff-merges -p > > does not trigger "--diff-merges" because the user explicitly says > that diffs for patches are unwanted after saying "--first-parent" > (i.e. without "--no-diff-merges" later, we would have done the > "diff-merges" implied by "--first-parent"). > > And > > git log --no-diff-merges --first-parent -p > > does not trigger "--diff-merges" So, do these both effectively resolve to: git log -m --no-diff-merges --first-parent --patch where first -m is the one implied by --first-parent, and the rest are real options relieved from their side-effects, so that reals are mutually independent and thus immune to specific relative positions? > because the user explicitly said that diffs for patches are unwanted > by the time "--first-parent" is seen (i.e. without "--no-diff-merges" > upfront, "--first-parent" would have weighed in to enable > "--diff-merges" behavior, but because the user already said "no", it > wouldn't). This is too complicated for my taste. I believe useful outcome could be achieved without such inter-dependencies, only by using options that /actually/ imply other option(s) by simple substitution, instead of "defaulting", whatever it actually means, that would allow to technically describe options without resorting to guessing user intentions, and without need to explain behavior by outcome of a set of examples. Those particular options aside, there is yet another existing kind of option that we didn't take into account yet: --patch-with-raw Synonym for -p --raw. Synonym! Now, "synonym" means something very definite: that I can safely substitute one for another with no change of semantics, right? So, here it is, the "implies" that I mean -- true substitution, and also with no other side-effects! Synonym, perfect! For myself I call such option a "convenience option", an option that does nothing else but brings in (implies) specific set of other options. OK, let's remember we already have that. [The only problem with it is that even longest form "--patch --raw" is shorter than the option itself, so there doesn't seem to be a point of having this synonym. Looks like historical option converted to "convenience option" some time ago.] Digging further, in an attempt to actually find where "defaults" term is used, I stomped over acutal use of "imply", rather than "default", and then to yet another kind of option, "shorthand"! What a nice name for what I called "convenience option" above, I thought! Let's check: --oneline:: This is a shorthand for "--pretty=oneline --abbrev-commit" used together. Nice, "shorthand" sounds exactly like "shorter synonym", so it must be true substitution! But then, we have this: --no-abbrev-commit:: Show the full 40-byte hexadecimal commit object name. This negates `--abbrev-commit` and those options which imply it such as "--oneline". It also overrides the `log.abbrevCommit` variable. So, --oneline "implies", according to this piece of git documentation, --abbrev-commit, and simultaneously --oneline is "shorthand"=="synonym", that to me means it substitutes --abbrev-commit. The problem is that, as direct consequence of the above, "implies" must mean simple substitution, that contradicts the definition of "implies" being something called "defaults" that you gave at the beginning of your explanations. So, finally, I'm entirely lost in all this, again. There doesn't seem to be strict definition that could be relied upon, and that is not a good sign. [Unrelated, but mention not to forget. According to description above, when --oneline implies --abbrev-commit, the --no-abbrev-commit negates entire --oneline rather than implied --abbrev-commit! Is this a defect of the description, or an intended behavior, I wonder?] > > This is quite different from options that are orthogonal to each > other. We do not need permutations of "log --root --cc" vs "log > --cc --root" tested. We know from the code that they cannot > possibly interact with each other. We could still test the > permutations, and it may give us more "complete" coverage, but it > may be of very low value. These I like very much! Ideally, all the different options would be orthogonal to each other, making things much simpler to grasp, test, and describe, overall. I believe this should be one of the explicit rules or guidelines for design for new options, as well as for fixing old options whenever it's possible without breaking things. > As to permutations of additive options, we do want to make sure they > are truly additive (as opposed to being the "last one wins") and as > a side effect of ensuring the additive nature, we would end up > testing the effect of the order of options given, e.g. "git commit > -m paragraph1 -m paragraph2". These are to be rare exceptions, I think, with explicit tests indeed. > As to permutations of options that directly overrides or opposes > each other, we may want to ensure e.g. that "git log -p -U2 -U4" > uses four context lines and "git log -p -U4 -U2" uses two or that > "git format-patch --attach --no-attach" does not use attachment and > "git format-patch --no-attach --attach" does (i.e. "last one wins"). Yeah, the same option with different values should override itself in general, except additives that you've mentioned above. > > But again, especially for commands that use parse-options API > correctly to implement their command line options, it is hard to get > these two cases wrong (e.g. you need to deliberately write a > callback to make "log -p -U2 -U4" additive to use six context > lines), so it may be of lower value to throughly test permutations. > It would not be as low as testing permutations of unrelated options, > though. This is very good! The only problem remaining is to avoid creating new inter-dependencies and to get rid of existing wherever possible. BTW, the revision.c does not use the parse-options API, right? Is it possible to change that gradually, or should it be done all at once instead? I mean, if I implement new option for revision.c, should I somehow rather use the parse-options API instead of imitating existing code in revision.c? Thanks, -- Sergey
next prev parent reply other threads:[~2020-08-15 21:59 UTC|newest] Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-08-05 22:08 [PATCH 0/3] Change "--diff-merges" to require parameter Sergey Organov 2020-08-05 22:08 ` [PATCH 1/3] revision: change "--diff-merges" option " Sergey Organov 2020-08-05 22:08 ` [PATCH 2/3] doc/git-log: describe --diff-merges=off Sergey Organov 2020-08-12 0:06 ` Junio C Hamano 2020-08-12 0:48 ` Junio C Hamano 2020-08-12 8:08 ` Sergey Organov 2020-08-05 22:08 ` [PATCH 3/3] t/t4013: add test for --diff-merges=off Sergey Organov 2020-08-05 22:31 ` Junio C Hamano 2020-08-05 22:44 ` Sergey Organov 2020-08-05 23:19 ` Junio C Hamano 2020-08-05 23:44 ` Junio C Hamano 2020-08-06 8:34 ` Sergey Organov 2020-08-06 17:10 ` Junio C Hamano 2020-08-06 20:52 ` Sergey Organov 2020-08-07 23:11 ` Sergey Organov [this message] 2020-08-17 17:17 ` Junio C Hamano 2020-08-17 20:36 ` Sergey Organov
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: http://vger.kernel.org/majordomo-info.html * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --subject='Re: [PATCH 3/3] t/t4013: add test for --diff-merges=off' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://80x24.org/mirrors/git.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).