From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Qais Yousef <qyousef@layalina.io>
Cc: kernel test robot <lkp@intel.com>, Ingo Molnar <mingo@kernel.org>,
Peter Zijlstra <peterz@infradead.org>,
Dietmar Eggemann <dietmar.eggemann@arm.com>,
Vincent Guittot <vincent.guittot@linaro.org>,
oe-kbuild-all@lists.linux.dev, linux-kernel@vger.kernel.org,
Lukasz Luba <lukasz.luba@arm.com>,
Xuewen Yan <xuewen.yan94@gmail.com>, Wei Wang <wvw@google.com>,
Jonathan JMChen <Jonathan.JMChen@mediatek.com>,
Hank <han.lin@mediatek.com>, Paul Bone <pbone@mozilla.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org
Subject: Re: [PATCH] Documentation: sched: Add a new sched-util-clamp.rst
Date: Mon, 14 Nov 2022 15:55:04 +0700 [thread overview]
Message-ID: <Y3ICaCPX61EOn/KN@debian.me> (raw)
In-Reply-To: <20221113152629.3wbyeejsj5v33rvu@airbuntu>
[-- Attachment #1: Type: text/plain, Size: 3530 bytes --]
On Sun, Nov 13, 2022 at 03:26:29PM +0000, Qais Yousef wrote:
> Thanks! I have the below fixup patch that addresses these. It made me realize
> my html output could look better. It's cosmetic; so won't post a new version
> till some feedback is provided first.
>
>
> Cheers
>
> --
> Qais Yousef
>
>
> --->8---
>
> diff --git a/Documentation/scheduler/index.rst b/Documentation/scheduler/index.rst
> index b430d856056a..f12d0d06de3a 100644
> --- a/Documentation/scheduler/index.rst
> +++ b/Documentation/scheduler/index.rst
> @@ -15,6 +15,7 @@ Linux Scheduler
> sched-capacity
> sched-energy
> schedutil
> + sched-util-clamp
> sched-nice-design
> sched-rt-group
> sched-stats
> diff --git a/Documentation/scheduler/sched-util-clamp.rst b/Documentation/scheduler/sched-util-clamp.rst
> index e75b69767afb..728ffa364fc7 100644
> --- a/Documentation/scheduler/sched-util-clamp.rst
> +++ b/Documentation/scheduler/sched-util-clamp.rst
> @@ -169,24 +169,27 @@ could change with implementation details.
> 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.
>
>
> -DISCLAMER:
> +.. note::
> + DISCLAMER:
> The diagram above is an illustration rather than a true depiction of the
> internal data structure.
The DISCLAIMER line above isn't needed, since note block should do the
job.
>
> @@ -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?
Otherwise no new warnings. Thanks for fixing this up.
However, in the future, for documentation patches you should always Cc:
linux-doc list. Adding it to Cc list now.
Thanks.
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2022-11-14 8:55 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-05 23:23 [PATCH] Documentation: sched: Add a new sched-util-clamp.rst Qais Yousef
2022-11-06 17:47 ` kernel test robot
2022-11-13 15:26 ` Qais Yousef
2022-11-14 8:55 ` Bagas Sanjaya [this message]
2022-11-15 20:55 ` Qais Yousef
2022-11-16 8:36 ` Bagas Sanjaya
2022-11-20 20:52 ` Qais Yousef
2022-11-14 2:47 ` Bagas Sanjaya
2022-11-15 20:55 ` Qais Yousef
2022-11-14 9:22 ` Bagas Sanjaya
2022-11-15 20:55 ` Qais Yousef
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=Y3ICaCPX61EOn/KN@debian.me \
--to=bagasdotme@gmail.com \
--cc=Jonathan.JMChen@mediatek.com \
--cc=corbet@lwn.net \
--cc=dietmar.eggemann@arm.com \
--cc=han.lin@mediatek.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=lukasz.luba@arm.com \
--cc=mingo@kernel.org \
--cc=oe-kbuild-all@lists.linux.dev \
--cc=pbone@mozilla.com \
--cc=peterz@infradead.org \
--cc=qyousef@layalina.io \
--cc=vincent.guittot@linaro.org \
--cc=wvw@google.com \
--cc=xuewen.yan94@gmail.com \
/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).