Re: [PATCH] MyFirstContribution: render literal *

From: Felipe Contreras <felipe.contreras@gmail.com>
Date: Apr 5, 2023, 13:22 UTC
Message-ID: <CAMP44s128zFcMrK7URUK73ZmzETDRA5SNkWwoHgukZ9Q3f+5Qg@mail.gmail.com>
In-Reply-To: <owlyzg7mubui.fsf@fine.c.googlers.com>

On Wed, Apr 5, 2023 at 12:39 AM Linus Arver <linusa@google.com> wrote:

> Felipe Contreras <felipe.contreras@gmail.com> writes:

Show 23 quoted lines

> > And for what it's worth I would revamp the whole section, something like
> > this:
>
> > --- a/Documentation/MyFirstContribution.txt
> > +++ b/Documentation/MyFirstContribution.txt
> > @@ -1136,18 +1136,18 @@ information on how to handle comments from
> > reviewers.
> >   We'll reuse our `psuh` topic branch for v2. Before we make any changes,
> > we'll
> >   mark the tip of our v1 branch for easy reference:
>
> > -----
> > +....
> >   $ git checkout psuh
> >   $ git branch psuh-v1
> > -----
> > +....
>
>
> While I see the four dots (....) being used to denote regions in other
> files like SubmittingPatches, they are not used at all in
> MyFirstContribution.txt. So I am not sure why we would want to change
> this.

"We" probably don't want to change it, *I* do. Because in AsciiDoc there's a difference between a listing block and a literal block, but the Git documentation does a very poor job of being compatible with AsciiDoc anyway. It doesn't even use the modern syntax. So it probably doesn't matter.

Cheers.

-- 
Felipe Contreras