On Mon, Jul 13, 2015 at 09:35:40AM -0700, Junio C Hamano wrote:
> Mike Hommey <mh@xxxxxxxxxxxx> writes:
>
> > init_notes() is the main point of entry to the notes API. It is an arbitrary
> > restriction that all it allows as input is a strict ref name, when callers
> > may want to give an arbitrary treeish.
> >
> > However, some operations that require updating the notes tree require a
> > strict ref name, because they wouldn't be able to update e.g. foo@{1}.
> >
> > So we allow treeish expressions to be used in the case the notes tree is
> > going to be used without write "permissions", and to distinguish whether
> > the notes tree is intended to be used for reads only, or will be updated,
> > a flag is added.
>
> It is unfair to call the current check arbitrary, though. From the
> point of view of the person who views notes as a database, it is
> entirely a sensible thing to treat it as an read/write data store.
>
> > This has the side effect of enabling the use of treeish as notes refs in
> > commands allowing them, e.g. git log --notes=foo@{1}.
>
> I do not think it is a "side effect". It's the primary benefit this
> change brings in.
My original motivation for this change was for init_notes() to take a
committish so that I can feed it with one in a C program that uses the
notes API. So from that perspective, that command lines can now use them
is a side effect.
> I'd flip the attitude around and sell this as "an enhancement",
> perhaps like this:
>
> notes: allow treeish expressions as notes ref
>
> init_notes() is the main point of entry to the notes API. It ensures
> that the input can be used as ref, because it needs a ref to update
> to store notes tree after modifying it.
>
> There however are many use cases where notes tree is only read, e.g.
> "git log --notes=...". Any notes-shaped treeish could be used for
> such purpose, but it is not allowed due to existing restriction.
>
> Allow treeish expressions to be used in the case the notes tree is
> going to be used without write "permissions". Add a flag to
> distinguish whether the notes tree is intended to be used read-only,
> or will be updated.
>
> With this change, operations that use notes read-only can be fed any
> notes-shaped tree-ish can be used, e.g. git log --notes=notes@{1}.
>
> Signed-off-by: Mike Hommey <mh@xxxxxxxxxxxx>
> Signed-off-by: Junio C Hamano <gitster@xxxxxxxxx>
WFM.
> We probably should do a few more things:
>
> - Make sure that we show "there is no such tree-ish, no way to look
> up any note to any commit from there" and "I understood the tree
> you gave me, but there is no note for that commit" differently.
How would you reconcile that with the usual "there are only a couple
commits with a note in the hundreds you make me display"?
> - Decide if we want to "fail" the operation when the notes tree
> given by the user is not even a tree-ish or just "warn" and keep
> going. And do so consistently.
Is this something you want to be figured before merging this patch?
Mike
--
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