git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Matheus Tavares <matheus.bernardino@usp.br>
Cc: git <git@vger.kernel.org>
Subject: Re: [PATCH 0/3] doc: unify config info on some cmds
Date: Sat, 16 Jul 2022 09:53:23 +0200	[thread overview]
Message-ID: <220716.867d4dze37.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <CAHd-oW4zHA1YLX-5B1vYTA1f8PocziUCi0WxvSEkFUuf2GqKxg@mail.gmail.com>


On Fri, Jul 15 2022, Matheus Tavares wrote:

> Em qui, 14 de jul de 2022 18:27, Ævar Arnfjörð Bjarmason
> <avarab@gmail.com> escreveu:
>>
>>
>> Here's a cleaned up version of what I have, which I figure is probably
>> better linked-to than contributing to my E-Mail quota :):
>>
>>         https://github.com/git/git/compare/master...avar:git:avar/doc-config-includes
>
> Thanks for sharing your version!
>
>> The one thing I'd like you to reconsider is to drop the idea of adding
>> these "ifndef::git-grep[]" defines and the like. In your version it
>> yields an arguably better result.
>>
>> But I think what we should be going for is the more general direction
>> outlined above, at which point that becomes quite a mess of
>> ifdefs. I.e. config/gc/rerere.txt would need to know what it's going to
>> get include in, which would be N number of manpages in the genreal case,
>> not just "main or config" as this series leaves it.
>>
>> I think the solution I have to that in 1/9 in that first series is a
>> better trade-off, i.e. we just (eventually, your series doesn't need to
>> do that) include some standard wording saying that what you're looking
>> at in git-CMD(1) is transcluded as-is from the relevant part of
>> git-config(1). I.e.:
>>
>>         Everything below this line in this section is selectively included
>>         from the linkgit:git-config[1] documentation. The content is the same
>>         as what's found there:
>>
>> What do you think about doing that instead?
>
> I like the includes/* idea, and I agree that it is a more sensible way
> forward than the many 'ifndef[]::git-cmd.txt's :) Your linked changes
> also cover a wider range of cmds than my series does. So I'd be happy
> to have them as a replacement to this series.

I can submit what I've got as a v2 if you'd like, but I'd be just as
happy with you picking this up & running with it, whether that's seeing
what you'd like to integrate into your series here, or perhaps rebasing
your patches on the 1st patch I have (the one that introduces those
"Everything below this..." template)>

But OTOH if you're going to drop the "ifndef" idea I think what you'd
come up with will be identical to the patch bodies I've got for the bits
you modified, so perhaps it's easier if I just submit mine...

Just let me know, I'd just like these docs fixed & unified.

  reply	other threads:[~2022-07-16  7:55 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-14 17:44 [PATCH 0/3] doc: unify config info on some cmds Matheus Tavares
2022-07-14 17:44 ` [PATCH 1/3] doc: grep: unify configuration variables definitions Matheus Tavares
2022-07-14 18:46   ` Junio C Hamano
2022-07-14 17:44 ` [PATCH 2/3] doc: apply: " Matheus Tavares
2022-07-14 18:48   ` Junio C Hamano
2022-07-14 17:44 ` [PATCH 3/3] doc: notes: " Matheus Tavares
2022-07-14 19:45   ` Junio C Hamano
2022-07-14 21:17 ` [PATCH 0/3] doc: unify config info on some cmds Ævar Arnfjörð Bjarmason
2022-07-15 19:58   ` Matheus Tavares
2022-07-16  7:53     ` Ævar Arnfjörð Bjarmason [this message]
2022-07-17 17:13       ` Matheus Tavares
2022-07-29  8:25 ` [PATCH v2 0/9] docs: de-duplicate sections, add more CONFIGURATION sections Ævar Arnfjörð Bjarmason
2022-07-29  8:25   ` [PATCH v2 1/9] docs: add and use include template for config/* includes Ævar Arnfjörð Bjarmason
2022-07-30 13:29     ` Matheus Tavares
2022-07-29  8:25   ` [PATCH v2 2/9] grep docs: de-duplicate configuration sections Ævar Arnfjörð Bjarmason
2022-07-30 13:31     ` Matheus Tavares
2022-07-29  8:25   ` [PATCH v2 3/9] send-email " Ævar Arnfjörð Bjarmason
2022-07-30 13:45     ` Matheus Tavares
2022-07-29  8:25   ` [PATCH v2 4/9] apply " Ævar Arnfjörð Bjarmason
2022-07-30 13:50     ` Matheus Tavares
2022-07-29  8:25   ` [PATCH v2 5/9] notes " Ævar Arnfjörð Bjarmason
2022-07-30 20:02     ` Matheus Tavares
2022-07-29  8:25   ` [PATCH v2 6/9] difftool " Ævar Arnfjörð Bjarmason
2022-07-30 14:09     ` Matheus Tavares
2022-07-29  8:25   ` [PATCH v2 7/9] log " Ævar Arnfjörð Bjarmason
2022-07-30 18:52     ` Matheus Tavares
2022-07-29  8:25   ` [PATCH v2 8/9] docs: add CONFIGURATION sections that map to a built-in Ævar Arnfjörð Bjarmason
2022-07-29 21:58     ` Junio C Hamano
2022-07-29  8:25   ` [PATCH v2 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins Ævar Arnfjörð Bjarmason
2022-07-29 22:03     ` Junio C Hamano
2022-07-30 19:08     ` Matheus Tavares
2022-07-30 20:44       ` Junio C Hamano
2022-07-30 20:05   ` [PATCH v2 0/9] docs: de-duplicate sections, add more CONFIGURATION sections Matheus Tavares
2022-08-31  8:41   ` [PATCH v3 " Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 1/9] docs: add and use include template for config/* includes Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 2/9] grep docs: de-duplicate configuration sections Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 3/9] send-email " Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 4/9] apply " Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 5/9] notes docs: de-duplicate and combine " Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 6/9] difftool docs: de-duplicate " Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 7/9] log " Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 8/9] docs: add CONFIGURATION sections that map to a built-in Ævar Arnfjörð Bjarmason
2022-08-31  8:41     ` [PATCH v3 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins Ævar Arnfjörð Bjarmason
2022-09-03 13:29     ` [PATCH v3 0/9] docs: de-duplicate sections, add more CONFIGURATION sections Matheus Tavares
2022-09-07  8:26     ` [PATCH v4 " Ævar Arnfjörð Bjarmason
2022-09-07  8:26       ` [PATCH v4 1/9] docs: add and use include template for config/* includes Ævar Arnfjörð Bjarmason
2022-09-07  8:26       ` [PATCH v4 2/9] grep docs: de-duplicate configuration sections Ævar Arnfjörð Bjarmason
2022-09-07  8:26       ` [PATCH v4 3/9] send-email " Ævar Arnfjörð Bjarmason
2022-09-07  8:27       ` [PATCH v4 4/9] apply " Ævar Arnfjörð Bjarmason
2022-09-07  8:27       ` [PATCH v4 5/9] notes docs: de-duplicate and combine " Ævar Arnfjörð Bjarmason
2022-09-07  8:27       ` [PATCH v4 6/9] difftool docs: de-duplicate " Ævar Arnfjörð Bjarmason
2022-09-07  8:27       ` [PATCH v4 7/9] log " Ævar Arnfjörð Bjarmason
2022-09-07  8:27       ` [PATCH v4 8/9] docs: add CONFIGURATION sections that map to a built-in Ævar Arnfjörð Bjarmason
2022-09-07  8:27       ` [PATCH v4 9/9] docs: add CONFIGURATION sections that fuzzy map to built-ins Ævar Arnfjörð Bjarmason
2022-09-07 11:51       ` [PATCH v4 0/9] docs: de-duplicate sections, add more CONFIGURATION sections Matheus Tavares
2022-09-07 16:45         ` Junio C Hamano

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=220716.867d4dze37.gmgdl@evledraar.gmail.com \
    --to=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=matheus.bernardino@usp.br \
    /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.
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 NNTP newsgroup(s).