Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Lukas Bulwahn <lukas.bulwahn@gmail.com>
Date:   Wed, 9 Sep 2020 10:37:14 +0200 (CEST)
To:     John Mathew <john.mathew@unikie.com>
cc:     linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        corbet@lwn.net, mingo@redhat.com, peterz@infradead.org,
        juri.lelli@redhat.com, vincent.guittot@linaro.org,
        dietmar.eggemann@arm.com, rostedt@goodmis.org, bsegall@google.com,
        mgorman@suse.de, bristot@redhat.com, tsbogend@alpha.franken.de,
        lukas.bulwahn@gmail.com, x86@kernel.org,
        linux-mips@vger.kernel.org, tglx@linutronix.de,
        willy@infradead.org, valentin.schneider@arm.com
Subject: Re: [RFC PATCH v8 0/3] Add scheduler overview documentation
In-Reply-To: <20200902162632.10271-1-john.mathew@unikie.com>
Message-ID: <alpine.DEB.2.21.2009090959530.5622@felia>
References: <20200902162632.10271-1-john.mathew@unikie.com>
User-Agent: Alpine 2.21 (DEB 202 2017-01-01)
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk


On Wed, 2 Sep 2020, John Mathew wrote:

> This patch series updates the scheduler documentation to add more topics
> wrt to scheduler overview. New sections are added to provide a brief
> overview of the kernel structs used by the scheduler, scheduler invocation,
> and context switch. Previous version of the patch was reviewed at:
> https://lore.kernel.org/lkml/20200527084421.4673-1-John.Mathew@unikie.com/
>

John, here is some first feedback to get the ball rolling:

I tried to apply your patches on v5.9-rc4, and I got those warnings:

Applying: docs: scheduler: Restructure scheduler documentation.
.git/rebase-apply/patch:30: new blank line at EOF.
+
.git/rebase-apply/patch:137: new blank line at EOF.
+
warning: 2 lines add whitespace errors.
Applying: docs: scheduler: Add scheduler overview documentation
.git/rebase-apply/patch:73: new blank line at EOF.
+
warning: 1 line adds whitespace errors.
Applying: docs: scheduler: Add introduction to scheduler context-switch
.git/rebase-apply/patch:153: new blank line at EOF.
+
.git/rebase-apply/patch:260: new blank line at EOF.
+
warning: 2 lines add whitespace errors.


You might want to look into this. I also checked that the patch also 
applies on linux-next, i.e., next-20200908; so, it does not clash in an 
obvious way with other changes at the moment.

I did run checkpatch.pl and it warned about:
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?

No action required here. 


Documentation generation (make htmldocs) shows these two new warnings with 
your patches applied to v5.9-rc4:

  ./kernel/sched/core.c:17: WARNING: Definition list ends without a blank 
line; unexpected unindent.
  ./kernel/sched/core.c:21: WARNING: Unexpected indentation.


You might want to put those minor fixes on your remaining TODO list for 
this patchset as well.

I will continue to comment with more editorial points in the next hours 
and days, while proof-reading your additions to the documentation.


Lukas