lkml.org 
[lkml]   [2022]   [Nov]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: [PATCH] Documentation: sched: Add a new sched-util-clamp.rst
On Tue, Nov 15, 2022 at 08:55:47PM +0000, Qais Yousef wrote:
> > > 2.1 BUCKETS:
> > > -------------
> > >
> > > +.. code-block:: c
> > > +
> > > [struct rq]
> > >
> > > -(bottom) (top)
> > > + (bottom) (top)
> > >
> > > - 0 1024
> > > - | |
> > > - +-----------+-----------+-----------+---- ----+-----------+
> > > - | Bucket 0 | Bucket 1 | Bucket 2 | ... | Bucket N |
> > > - +-----------+-----------+-----------+---- ----+-----------+
> > > - : : :
> > > - +- p0 +- p3 +- p4
> > > - : :
> > > - +- p1 +- p5
> > > - :
> > > - +- p2
> > > + 0 1024
> > > + | |
> > > + +-----------+-----------+-----------+---- ----+-----------+
> > > + | Bucket 0 | Bucket 1 | Bucket 2 | ... | Bucket N |
> > > + +-----------+-----------+-----------+---- ----+-----------+
> > > + : : :
> > > + +- p0 +- p3 +- p4
> > > + : :
> > > + +- p1 +- p5
> > > + :
> > > + +- p2
> >
> > The code block above is diagram, isn't it? Thus specifying language for
> > syntax highlighting (in this case ``c``) isn't appropriate.
>
> I could do with a helping hand here actually. I am a text only person but
> trying to follow the new rst docs; but I don't have a clue to be honest.
>
> I did try to find the right directive, but I couldn't find it. What should be
> specified for this diagram?

Just leave ..code-block:: directive alone or use simpler double colon
(::). The highlighting will not be applied to the code snippet.

> > > @@ -200,6 +203,8 @@ The rq has a bucket for each uclamp_id: [UCLAMP_MIN, UCLAMP_MAX].
> > > The range of each bucket is 1024/N. For example for the default value of 5 we
> > > will have 5 buckets, each of which will cover the following range:
> > >
> > > +.. code-block:: c
> > > +
> >
> > Again, why ``c`` syntax highlighting?
>
> This is a C code snippet. What would be better to use? I think I was getting
> errors if I don't specify something. But again; I was touching my way around in
> the dark here trying to figure it out.
>

Yup, that's the correct language for highlighting.

Thanks.

--
An old man doll... just what I always wanted! - Clara
[unhandled content-type:application/pgp-signature]
\
 
 \ /
  Last update: 2022-11-16 09:36    [W:0.117 / U:0.576 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site