Re: [PATCH v3 07/10] builtin/replace: teach listing using short, medium or full formats

From: Christian Couder <christian.couder@gmail.com>
Date: Dec 19, 2013, 16:36 UTC
Message-ID: <CAP8UFD1+kydjrjhTxKDSMmOa+KiOYgMGK5gyxCe-LPih02=VYQ@mail.gmail.com>
In-Reply-To: <xmqqioumjc1n.fsf@gitster.dls.corp.google.com>

On Wed, Dec 18, 2013 at 6:37 PM, Junio C Hamano <gitster@pobox.com> wrote:

Show 18 quoted lines

> Christian Couder <christian.couder@gmail.com> writes:
>
>> On Wed, Dec 18, 2013 at 1:37 PM, Karsten Blees <karsten.blees@gmail.com> wrote:
>>> Am 11.12.2013 08:46, schrieb Christian Couder:
>>>> +enum repl_fmt { SHORT, MEDIUM, FULL };
>>>
>>> SHORT is predefined on Windows, could you choose another name?
>>
>> Ok, I will change to:
>>
>> enum repl_fmt { SHORT_FMT, MEDIUM_FMT, FULL_FMT };
>
> What are these for in the first place?  Your "SHORT" conflicting
> with something totally unrelated is a sign that you should be naming
> them in a way that is more specific to your use.  SHORT_FMT is still
> not specific enough to tell what they are for.  With SHOW_REPLACE_
> prefix, perhaps?  Also perhaps give characterization better than
> their output lengths?

I am ok with SHORT_REPLACE_FMT and so on.

> My quick read of show_reference() tells me that they are "name
> only", "name and value", and something else that does not seem
> very useful unless you are debugging.

Yeah, SHORT_REPLACE_FMT is "name only" which means something like:

$ git replace --format=short 14ac020163ea60a9d683ce68e36c946f31ecc856 4b48deed3a433909bfd6b6ab3d4b91348b6af464 5c37393794868bc8e708cccd7c9d9aaa7a5e53cb a3fb2e1845a1aaf129b7975048973414dc172173 e25dc7954f0832d962347872884aab2dffb426c5

MEDIUM_REPLACE_FMT is "name and value", like this:

$ git replace --format=medium 14ac020163ea60a9d683ce68e36c946f31ecc856 -> 4b48deed3a433909bfd6b6ab3d4b91348b6af464 4b48deed3a433909bfd6b6ab3d4b91348b6af464 -> feae347d8510cfba5eb8c8ac80056777b07c2528 5c37393794868bc8e708cccd7c9d9aaa7a5e53cb -> 14ac020163ea60a9d683ce68e36c946f31ecc856 a3fb2e1845a1aaf129b7975048973414dc172173 -> 9af2a15082b7c95982473e32f3376558c149a7e7 e25dc7954f0832d962347872884aab2dffb426c5 -> 00ad688edb1a79423184992de45a5f0322c8bdf5

and FULL _REPLACE_FMT is "name with type and value with type", like this:

$ git replace --format=full 14ac020163ea60a9d683ce68e36c946f31ecc856 (commit) -> 4b48deed3a433909bfd6b6ab3d4b91348b6af464 (blob) 4b48deed3a433909bfd6b6ab3d4b91348b6af464 (blob) -> feae347d8510cfba5eb8c8ac80056777b07c2528 (blob) 5c37393794868bc8e708cccd7c9d9aaa7a5e53cb (tree) -> 14ac020163ea60a9d683ce68e36c946f31ecc856 (commit) a3fb2e1845a1aaf129b7975048973414dc172173 (commit) -> 9af2a15082b7c95982473e32f3376558c149a7e7 (commit) e25dc7954f0832d962347872884aab2dffb426c5 (tag) -> 00ad688edb1a79423184992de45a5f0322c8bdf5 (commit)

I think this last one might be useful for people replacing objects with objects that have another type. And as we let people do that using --force, it could be useful for them to have a way to easily see what they have done.

Thanks, Christian.