Re: [PATCH v2 1/6] Add AutoFDO support for Clang build

[Mike Rapoport <rppt@kernel.org>]

On Fri, Oct 04, 2024 at 09:28:36AM -0700, Rong Xu wrote:
> On Thu, Oct 3, 2024 at 11:09 PM Mike Rapoport <rppt@kernel.org> wrote:
> >
> > On Thu, Oct 03, 2024 at 11:20:17AM -0700, Rong Xu wrote:
> > > Writing the doc with all these code-blocks was not fun either.
> > > We are happy to change if there is a better way for this.
> > >
> > > -Rong
> > >
> > > On Thu, Oct 3, 2024 at 9:13 AM Peter Zijlstra <peterz@infradead.org> wrote:
> > > >
> > > > On Thu, Oct 03, 2024 at 09:11:34AM -0700, Nick Desaulniers wrote:
> > > >
> > > > > > It makes it absolute crap for all of us who 'render' text documents
> > > > > > using less or vi.
> > > > >
> > > > > "It hurts when I punch myself in the face."
> > > >
> > > > Weirdly enough I have a job that entails staring at text documents in
> > > > text editors all day every day :-) sorry for thinking that's a sane
> > > > thing to do.
> >
> > Something like this should do:
> >
> > > +- For enabling a single file (e.g. foo.o)::
> > > +
> > > +        AUTOFDO_PROFILE_foo.o := y
> 
> Do you mean we don't use ".. code-block:: " here and just use indented
> text separated with blank lines?

The double column (::) in the end of a paragraph means that the next paragraph
is a literal block:

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks

You'd loose the coloring, but other than that it won't be different from
the ".. code-block::" and easier to read in a text form.
 
> -Rong

-- 
Sincerely yours,
Mike.