git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Edward Thomson <ethomson@edwardthomson.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: Git ML <git@vger.kernel.org>
Subject: Re: [PATCH 1/1] xdiff: provide indirection to git functions
Date: Thu, 17 Feb 2022 22:58:04 +0000	[thread overview]
Message-ID: <20220217225804.GC7@edef91d97c94> (raw)
In-Reply-To: <220217.86ee41izpq.gmgdl@evledraar.gmail.com>

On Thu, Feb 17, 2022 at 10:29:23AM +0100, Ævar Arnfjörð Bjarmason wrote:
> 
> [I'm assuming that dropping the list from CC was a mistake, re-CC-ing]

It was; many apologies, I don't use mutt very often any more.  Thanks!

> As for the "new person to our codebase..." I don't think you're wrong
> there, but that's an asthetic preference, not something that's required
> for the stated aims of this series of dropping in compatibility shims.

Sure, but avoiding a prefix is also not a technical decision but an
aesthetic and ergonomic one.

Is using a prefix here great?  No, it's not great, it's shit.  But it's
shit that's easy to reason about.

If somebody sees a call to `xdl_free` in some code, they say "wtf is
this `xdl_free` nonsense?"  And they grep around and figure it out and
understand the way that this project handles heap allocations.  It's
very transparent.

If somebody sees a call to `free` in their code, they say "great,
`free`".  But it merely *appears* very transparent; in fact, there's
some magic behind the scenes that turns a `free` into a `git__free`
without you knowing it.  You've not learned the way that this project
handles heap allocations, but you also don't know that there's anything
that you needed to learn.  These are the sorts of things that you think
you understand but only discover when you _need_ to discover it because
something's gone very wrong.

In my experience, calling a function what it _isn't_ is the sort of thing
that a developer discovers the hard way, and that often leads to them
not trusting the codebase because it doesn't do what it says it does.

Cheers-
-ed

  parent reply	other threads:[~2022-02-17 22:58 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-09  1:29 [PATCH 0/1] xdiff: share xdiff between git and libgit2 Edward Thomson
2022-02-09  1:33 ` [PATCH 1/1] xdiff: provide indirection to git functions Edward Thomson
2022-02-09 11:07   ` Phillip Wood
2022-02-15 23:40   ` Ævar Arnfjörð Bjarmason
2022-02-16 11:02     ` Phillip Wood
2022-02-16 13:27       ` Ævar Arnfjörð Bjarmason
     [not found]         ` <20220217012847.GA8@e5e602f6ad40>
2022-02-17  9:29           ` Ævar Arnfjörð Bjarmason
2022-02-17 17:32             ` Junio C Hamano
2022-02-17 22:58             ` Edward Thomson [this message]
2022-04-15 15:55               ` Ævar Arnfjörð Bjarmason
2022-02-17 15:44 ` [PATCH 0/1] xdiff: share xdiff between git and libgit2 Johannes Schindelin

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=20220217225804.GC7@edef91d97c94 \
    --to=ethomson@edwardthomson.com \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.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).