From: Junio C Hamano <gitster@pobox.com>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: git@vger.kernel.org, Philip Oakley <philipoakley@iee.org>,
Jeff King <peff@peff.net>
Subject: Re: [PATCH v3 1/9] rebase -i: generate the script via rebase--helper
Date: Thu, 27 Apr 2017 19:36:14 -0700 [thread overview]
Message-ID: <xmqqy3ull0m9.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <xmqqbmrhmlsw.fsf@gitster.mtv.corp.google.com> (Junio C. Hamano's message of "Thu, 27 Apr 2017 17:13:19 -0700")
Junio C Hamano <gitster@pobox.com> writes:
> Yes. The "pretty_given" trick is one example that the underlying
> implementation can change over time. If you wrote this patch before
> 66b2ed09 ("Fix "log" family not to be too agressive about showing
> notes", 2010-01-20) happened, you wouldn't have known to flip this
> bit on to emulate the command line parsing of "--pretty" and
> friends, and you would have required the author of that change to
> know that you have this cut & pasted duplicated code here when the
> commit is primarily about updating revision.c
>
> So I am very serious when I say that this is adding an unnecessary
> maintenance burden.
I _am_ sympathetic to your wish to have the compiler catch a
misspelt "revs.verboes_header = 1". A misspelt "--formta=..."
would not be caught until the execution time.
But the compiler's static name checking helps only one time while
you are writing _this_ patch, and it does not help at all to protect
this duplicated code from future breakages. The way "rev-list" and
friends _internally_ implement "--format=..." or any other options
sed by the rev-list command whose behaviour you are recreating here
can (and will) change in the future, just like it already did change
in early 2010. We didn't have pretty_given field for several years
after "--pretty" etc. that currently set the field were originally
introduced.
In an ideal world, we would probably have specific methods to
manipulate "struct rev_info" and set_format_string() method, which
would be called when the command line parser is reacting to
"--format=..." in setup_revisions(), may encapsulate the
implementation detail of setting verbose_header and pretty_given
fields in addition to calling get_commit_format() method on the
rev_info object, and your new code may be calling that method,
without having to know the implementation detail.
We do not live in that ideal world, and it is _not_ the theme of
your topic to bring us closer to the ideal world. Under that
constraint, a future-proof way to set up the revision machinery is
to have setup_revisions() parse an av[] array. What will be done to
your copy of revs will stay compatible with what rev-list would do
after the implementation detail of setup_revisions() changes that
way. It is true that a misspelt "--formta=..." would not be caught
until the execution time, but once the code in this part is written,
it is less likely to get broken by a change coming from needs by
other parts of the system (e.g. the addition of pretty_given came
not because we wanted to enhance how --format or --pretty worked; it
came because we wanted to make sure they are not affected by changes
to another option).
So after being forced by your response to rethink about it, I feel
even firmer about this than I felt when I sent my first review
comment.
Thanks.
next prev parent reply other threads:[~2017-04-28 2:36 UTC|newest]
Thread overview: 100+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-02 16:22 [PATCH 0/9] The final building block for a faster rebase -i Johannes Schindelin
2016-09-02 16:23 ` [PATCH 1/9] rebase -i: generate the script via rebase--helper Johannes Schindelin
2016-09-02 16:23 ` [PATCH 2/9] rebase -i: remove useless indentation Johannes Schindelin
2016-09-02 16:23 ` [PATCH 3/9] rebase -i: do not invent onelines when expanding/collapsing SHA-1s Johannes Schindelin
2016-09-02 16:23 ` [PATCH 4/9] rebase -i: also expand/collapse the SHA-1s via the rebase--helper Johannes Schindelin
2016-09-02 20:56 ` Dennis Kaarsemaker
2016-09-03 7:01 ` Johannes Schindelin
2016-09-02 16:23 ` [PATCH 5/9] t3404: relax rebase.missingCommitsCheck tests Johannes Schindelin
2016-09-02 16:23 ` [PATCH 6/9] rebase -i: check for missing commits in the rebase--helper Johannes Schindelin
2016-09-02 20:59 ` Dennis Kaarsemaker
2016-09-02 16:23 ` [PATCH 7/9] rebase -i: skip unnecessary picks using " Johannes Schindelin
2016-09-02 16:23 ` [PATCH 8/9] t3415: test fixup with wrapped oneline Johannes Schindelin
2016-09-02 16:23 ` [PATCH 9/9] rebase -i: rearrange fixup/squash lines using the rebase--helper Johannes Schindelin
2016-09-03 18:03 ` Josh Triplett
2016-09-04 6:47 ` Johannes Schindelin
2017-04-25 13:51 ` [PATCH v2 0/9] The final building block for a faster rebase -i Johannes Schindelin
2017-04-25 13:51 ` [PATCH v2 1/9] rebase -i: generate the script via rebase--helper Johannes Schindelin
2017-04-26 10:45 ` Jeff King
2017-04-26 11:34 ` Johannes Schindelin
2017-04-25 13:51 ` [PATCH v2 2/9] rebase -i: remove useless indentation Johannes Schindelin
2017-04-25 13:51 ` [PATCH v2 3/9] rebase -i: do not invent onelines when expanding/collapsing SHA-1s Johannes Schindelin
2017-04-25 13:51 ` [PATCH v2 4/9] rebase -i: also expand/collapse the SHA-1s via the rebase--helper Johannes Schindelin
2017-04-25 13:52 ` [PATCH v2 5/9] t3404: relax rebase.missingCommitsCheck tests Johannes Schindelin
2017-04-25 13:52 ` [PATCH v2 6/9] rebase -i: check for missing commits in the rebase--helper Johannes Schindelin
2017-04-25 13:52 ` [PATCH v2 7/9] rebase -i: skip unnecessary picks using " Johannes Schindelin
2017-04-26 10:55 ` Jeff King
2017-04-26 11:31 ` Johannes Schindelin
2017-04-25 13:52 ` [PATCH v2 8/9] t3415: test fixup with wrapped oneline Johannes Schindelin
2017-04-25 13:52 ` [PATCH v2 9/9] rebase -i: rearrange fixup/squash lines using the rebase--helper Johannes Schindelin
2017-04-26 3:32 ` [PATCH v2 0/9] The final building block for a faster rebase -i Junio C Hamano
2017-04-26 11:59 ` [PATCH v3 " Johannes Schindelin
2017-04-26 11:59 ` [PATCH v3 1/9] rebase -i: generate the script via rebase--helper Johannes Schindelin
2017-04-27 4:31 ` Junio C Hamano
2017-04-27 14:18 ` Johannes Schindelin
2017-04-28 0:13 ` Junio C Hamano
2017-04-28 2:36 ` Junio C Hamano [this message]
2017-04-28 15:13 ` Johannes Schindelin
2017-05-01 3:11 ` Junio C Hamano
2017-05-01 11:47 ` Johannes Schindelin
2017-04-28 10:08 ` Phillip Wood
2017-04-28 19:22 ` Johannes Schindelin
2017-05-01 10:06 ` Phillip Wood
2017-05-01 11:58 ` Johannes Schindelin
2017-05-01 0:49 ` Junio C Hamano
2017-05-01 11:06 ` Johannes Schindelin
2017-04-26 11:59 ` [PATCH v3 2/9] rebase -i: remove useless indentation Johannes Schindelin
2017-04-26 11:59 ` [PATCH v3 3/9] rebase -i: do not invent onelines when expanding/collapsing SHA-1s Johannes Schindelin
2017-04-26 11:59 ` [PATCH v3 4/9] rebase -i: also expand/collapse the SHA-1s via the rebase--helper Johannes Schindelin
2017-04-27 5:00 ` Junio C Hamano
2017-04-27 6:47 ` Junio C Hamano
2017-04-27 21:44 ` Johannes Schindelin
2017-04-28 0:15 ` Junio C Hamano
2017-04-28 15:15 ` Johannes Schindelin
2017-04-26 11:59 ` [PATCH v3 5/9] t3404: relax rebase.missingCommitsCheck tests Johannes Schindelin
2017-04-27 5:05 ` Junio C Hamano
2017-04-27 22:01 ` Johannes Schindelin
2017-04-26 11:59 ` [PATCH v3 6/9] rebase -i: check for missing commits in the rebase--helper Johannes Schindelin
2017-04-27 5:32 ` Junio C Hamano
2017-04-28 15:10 ` Johannes Schindelin
2017-04-26 12:00 ` [PATCH v3 7/9] rebase -i: skip unnecessary picks using " Johannes Schindelin
2017-04-26 12:00 ` [PATCH v3 8/9] t3415: test fixup with wrapped oneline Johannes Schindelin
2017-04-26 12:00 ` [PATCH v3 9/9] rebase -i: rearrange fixup/squash lines using the rebase--helper Johannes Schindelin
2017-04-28 21:30 ` [PATCH v4 00/10] The final building block for a faster rebase -i Johannes Schindelin
2017-04-28 21:31 ` [PATCH v4 01/10] t3415: verify that an empty instructionFormat is handled as before Johannes Schindelin
2017-04-28 21:31 ` [PATCH v4 02/10] rebase -i: generate the script via rebase--helper Johannes Schindelin
2017-05-26 3:15 ` Liam Beguin
2017-05-29 10:59 ` Johannes Schindelin
2017-05-30 15:57 ` liam Beguin
2017-05-30 18:19 ` liam Beguin
2017-05-29 6:07 ` Junio C Hamano
2017-05-29 10:54 ` Johannes Schindelin
2017-05-30 4:57 ` Junio C Hamano
2017-05-30 14:59 ` Johannes Schindelin
2017-05-30 15:08 ` revision API design, was " Johannes Schindelin
2017-05-30 22:53 ` Junio C Hamano
2017-06-01 6:48 ` Junio C Hamano
2017-04-28 21:31 ` [PATCH v4 03/10] rebase -i: remove useless indentation Johannes Schindelin
2017-05-26 3:15 ` Liam Beguin
2017-05-26 17:50 ` Stefan Beller
2017-05-27 3:15 ` liam Beguin
2017-04-28 21:32 ` [PATCH v4 04/10] rebase -i: do not invent onelines when expanding/collapsing SHA-1s Johannes Schindelin
2017-04-28 21:32 ` [PATCH v4 05/10] rebase -i: also expand/collapse the SHA-1s via the rebase--helper Johannes Schindelin
2017-05-26 3:15 ` Liam Beguin
2017-05-29 11:20 ` Johannes Schindelin
2017-04-28 21:32 ` [PATCH v4 06/10] t3404: relax rebase.missingCommitsCheck tests Johannes Schindelin
2017-04-28 21:32 ` [PATCH v4 07/10] rebase -i: check for missing commits in the rebase--helper Johannes Schindelin
2017-04-28 21:32 ` [PATCH v4 08/10] rebase -i: skip unnecessary picks using " Johannes Schindelin
2017-04-28 21:32 ` [PATCH v4 09/10] t3415: test fixup with wrapped oneline Johannes Schindelin
2017-04-28 21:33 ` [PATCH v4 10/10] rebase -i: rearrange fixup/squash lines using the rebase--helper Johannes Schindelin
2017-05-26 3:16 ` Liam Beguin
2017-05-29 11:26 ` Johannes Schindelin
2017-05-26 3:15 ` [PATCH v4 00/10] The final building block for a faster rebase -i Liam Beguin
2017-05-27 16:23 ` René Scharfe
2017-05-29 10:51 ` Johannes Schindelin
2017-05-29 12:50 ` Ævar Arnfjörð Bjarmason
2017-05-30 15:44 ` Johannes Schindelin
2017-05-30 20:22 ` Ævar Arnfjörð Bjarmason
2017-05-31 18:46 ` Ævar Arnfjörð Bjarmason
2017-05-29 10:56 ` Johannes Schindelin
2017-05-29 8:30 ` Junio C Hamano
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 \
--in-reply-to=xmqqy3ull0m9.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
--cc=philipoakley@iee.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public 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).