Re: [PATCH] Document the output format of ls-remote

From: Felipe Contreras <felipe.contreras@gmail.com>
Date: Mar 19, 2023, 19:25 UTC
Message-ID: <CAMP44s2nkQN4Dnzq47_zU+MjPeTAoicpau3rHbsxifrhotRoRw@mail.gmail.com>
In-Reply-To: <CAPig+cQ+__c0CVspBgVxcGrzj8AnJJKKaQr-ofT4oLS-C-bQtw@mail.gmail.com>

On Sun, Mar 19, 2023 at 11:52 AM Eric Sunshine <sunshine@sunshineco.com> wrote:

Show 19 quoted lines

> > +----
> > +$ git ls-remote
> > +950264636c68591989456e3ba0a5442f93152c1a       refs/heads/main
> > +73876f4861cd3d187a4682290ab75c9dccadbc56       refs/heads/maint
> > +d9ab777d41f92a8c1684c91cfb02053d7dd1046b       refs/heads/next
> > +74a0ffe000da036ce4ca843d991a7c6b8c246a08       refs/heads/seen
> > +860bc4360c4fcba0fe2df942984d87f8467af3df       refs/heads/todo
> > +d4ca2e3147b409459955613c152220f4db848ee1       refs/tags/v2.40.0
> > +8810a79228a149a9773bf9c75f381fca27a6a80e       refs/tags/v2.40.0-rc0
> > +f899c182d0bffb6e915da7c8db9be202b144c098       refs/tags/v2.40.0-rc1
> > +6bed3304b2b2f1cf440ca3050b57a7cf3a3fe687       refs/tags/v2.40.0-rc2
> > +----
>
> I'm not an Asciidoc expert, but despite the fact that the real
> git-ls-remote output emits TABs, I'm not sure we really want TABs in
> the documentation since various Asciidoc implementations may render it
> differently. Also, we don't seem to have any embedded TABs like this
> in other documentation. It probably would be better to use spaces in
> the documentation.

AsciiDoc implementations follow the AsciiDoc specification, and everything between ---- is considered a source code block, so tabs should be interpreted as such.

-- 
Felipe Contreras