Re: Problem: git Notes not discoverable (+proposed solutions)
- From
Michal Suchánek <msuchanek@suse.de>
- Date
- Sep 4, 2024, 07:13 UTC
- Message-ID
- <20240904071338.GW26466@kitsune.suse.cz>
- In-Reply-To
- <xmqq7cbsh16d.fsf@gitster.g>
On Tue, Sep 03, 2024 at 02:34:02PM -0700, Junio C Hamano wrote:
Show 22 quoted lines
> sideshowbarker <mike@w3.org> writes: > > > ## Problem description > > > > When a project has added git Notes for its commits, git by default doesn’t > > automatically fetch the Notes; so, the Notes aren’t automatically discoverable > > to contributors who are using “git log” to read the project commit logs — and > > especially not discoverable to new contributors, or “casual” users of the logs. > > > > A user will see the Notes only if they _already_ know what git Notes are, and > > know that the project uses Notes, and the user knows how to get them. > > > > But the reality is: most users do not even know what git Notes are, and don’t > > know how to get them if they exist. So most people end up never seeing them. > > And even if they did, they wouldn't know how to use them, so not > much is lost here. > > Quite honestly, a project that uses notes in such a way that it is > essential to understand/utilize the history should reexamine its use > of notes and try to see if they can make its commits more useful > without relying on notes, I would think.
The notes could be also used to annotate existing upstream history without altering it.
However, the problems with notes worflows make it impractical.
Thanks
Michal