linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Tang Yizhou <tangyizhou@huawei.com>,
	peterz@infradead.org, mingo@redhat.com
Cc: linux-doc@vger.kernel.org, zhengbin13@huawei.com,
	siyanteng@loongson.cn, siyanteng01@gmail.com,
	tangyeechou@gmail.com, Tang Yizhou <tangyizhou@huawei.com>
Subject: Re: [PATCH] docs: scheduler: Convert schedutil.txt to ReST
Date: Fri, 11 Mar 2022 13:50:15 -0700	[thread overview]
Message-ID: <87v8wk2ozc.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220311030400.32320-1-tangyizhou@huawei.com>

Tang Yizhou <tangyizhou@huawei.com> writes:

> All other scheduler documents have been converted to *.rst. Let's do
> the same for schedutil.txt.
>
> Signed-off-by: Tang Yizhou <tangyizhou@huawei.com>
> ---
>  Documentation/scheduler/index.rst             |  1 +
>  .../{schedutil.txt => schedutil.rst}          | 50 ++++++++++---------
>  2 files changed, 28 insertions(+), 23 deletions(-)
>  rename Documentation/scheduler/{schedutil.txt => schedutil.rst} (85%)

I would like to see this change made so that this document can be built
with the rest of the kernel docs.  I will, however, defer to Peter and
will not accept this change over his objections.

That said, there is one other issue...
[...]

> --- a/Documentation/scheduler/schedutil.txt
> +++ b/Documentation/scheduler/schedutil.rst
> @@ -1,11 +1,15 @@
> +=========
> +Schedutil
> +=========
>  
> +.. note::
>  
> -NOTE; all this assumes a linear relation between frequency and work capacity,
> -we know this is flawed, but it is the best workable approximation.
> +   All this assumes a linear relation between frequency and work capacity,
> +   we know this is flawed, but it is the best workable approximation.
>  
>  
>  PELT (Per Entity Load Tracking)
> --------------------------------
> +===============================
>  
>  With PELT we track some metrics across the various scheduler entities, from
>  individual tasks to task-group slices to CPU runqueues. As the basis for this
> @@ -38,8 +42,8 @@ while 'runnable' will increase to reflect the amount of contention.
>  For more detail see: kernel/sched/pelt.c
>  
>  
> -Frequency- / CPU Invariance
> ----------------------------
> +Frequency / CPU Invariance
> +==========================
>  
>  Because consuming the CPU for 50% at 1GHz is not the same as consuming the CPU
>  for 50% at 2GHz, nor is running 50% on a LITTLE CPU the same as running 50% on
> @@ -47,23 +51,23 @@ a big CPU, we allow architectures to scale the time delta with two ratios, one
>  Dynamic Voltage and Frequency Scaling (DVFS) ratio and one microarch ratio.
>  
>  For simple DVFS architectures (where software is in full control) we trivially
> -compute the ratio as:
> +compute the ratio as::
>  
> -	    f_cur
> +            f_cur

You would appear to have done some space-to-tab conversions throughout
the file which muddies up the diff and makes it harder to see what you
have really changed.  Please redo the patch without unneeded white-space
changes.

Thanks,

jon

  reply	other threads:[~2022-03-11 20:50 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-11  3:04 [PATCH] docs: scheduler: Convert schedutil.txt to ReST Tang Yizhou
2022-03-11 20:50 ` Jonathan Corbet [this message]
2022-03-12  6:29   ` Tang Yizhou
2022-03-12 11:40   ` Peter Zijlstra

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=87v8wk2ozc.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=peterz@infradead.org \
    --cc=siyanteng01@gmail.com \
    --cc=siyanteng@loongson.cn \
    --cc=tangyeechou@gmail.com \
    --cc=tangyizhou@huawei.com \
    --cc=zhengbin13@huawei.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).