git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
* FETCH_HEAD format is undocumented
@ 2020-11-16 17:13 Philippe Blain
  2020-11-16 19:03 ` Junio C Hamano
  0 siblings, 1 reply; 2+ messages in thread
From: Philippe Blain @ 2020-11-16 17:13 UTC (permalink / raw)
  To: Git mailing list

Hi,

While trying to use `git fmt-merge-msg`, I figured it only accepts
inputs in the format used in the 'FETCH_HEAD' file.

I then tried to find a description of the format of this file in the documentation, 
but could not find any. For example, 'git grep not-for-merge' in /Documentation
returns a single hit, in the release notes for Git 2.5.0.

I think it could be good if we documented the FETCH_HEAD format.

Cheers,

Philippe.

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: FETCH_HEAD format is undocumented
  2020-11-16 17:13 FETCH_HEAD format is undocumented Philippe Blain
@ 2020-11-16 19:03 ` Junio C Hamano
  0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2020-11-16 19:03 UTC (permalink / raw)
  To: Philippe Blain; +Cc: Git mailing list

Philippe Blain <levraiphilippeblain@gmail.com> writes:

> While trying to use `git fmt-merge-msg`, I figured it only accepts
> inputs in the format used in the 'FETCH_HEAD' file.
>
> I then tried to find a description of the format of this file in the documentation, 
> but could not find any. For example, 'git grep not-for-merge' in /Documentation
> returns a single hit, in the release notes for Git 2.5.0.
>
> I think it could be good if we documented the FETCH_HEAD format.

Not just the format of FETCH_HEAD file, but the whole usage of
fmt-merge-msg is meant as a mere implementation detail of the
one-way communication from "git fetch" to "git merge".  I'd rather
leave it opaque so that we can update the format as needed.  For one
thing it is impossible to do i18n with the current format, I think,
which some folks may eventually want to change.

I am OK with documenting it somewhere in Documentation/technical/
with a warning written in big red letters that it is subject to
change, to clearly mark that the format of the file should not be
relied upon and the only useful thing you could do is to rely on the
fact that its first 40-byte gives one object name (so you could say
"git log ...FETCH_HEAD" for example) and to feed it to "git merge".



^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2020-11-16 19:05 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-11-16 17:13 FETCH_HEAD format is undocumented Philippe Blain
2020-11-16 19:03 ` Junio C Hamano

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).