Received-SPF: pass (google.com: domain of linux-kernel+bounces-141823-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Fri, 12 Apr 2024 09:50:26 +0700
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Zhang Qiao <zhangqiao22@huawei.com>, corbet@lwn.net
Cc: mingo@kernel.org, chrubis@suse.cz, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, Steven Rostedt <rostedt@goodmis.org>,
	Peter Zijlstra <peterz@infradead.org>
Subject: Re: [PATCH] sched/Documentation: Add RT_RUNTIME_SHARE documentation
Message-ID: <Zhihch_S1_-1JhwK@archie.me>
References: <20240131123238.2332064-1-zhangqiao22@huawei.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="pta05BleG83gC9lZ"
Content-Disposition: inline
In-Reply-To: <20240131123238.2332064-1-zhangqiao22@huawei.com>


--pta05BleG83gC9lZ
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Wed, Jan 31, 2024 at 08:32:38PM +0800, Zhang Qiao wrote:
> +2.4 RT_RUNTIME_SHARE sched feature
> +----------------------------

htmldocs build reports new warning:

Documentation/scheduler/sched-rt-group.rst:151: WARNING: Title underline to=
o short.

2.4 RT_RUNTIME_SHARE sched feature
----------------------------

I have to extend the underline:

---- >8 ----
diff --git a/Documentation/scheduler/sched-rt-group.rst b/Documentation/sch=
eduler/sched-rt-group.rst
index 4d8eceb71f5ed8..751113fcd35850 100644
--- a/Documentation/scheduler/sched-rt-group.rst
+++ b/Documentation/scheduler/sched-rt-group.rst
@@ -148,7 +148,7 @@ For now, this can be simplified to just the following (=
but see Future plans):
    \Sum_{i} runtime_{i} <=3D global_runtime
=20
 2.4 RT_RUNTIME_SHARE sched feature
-----------------------------
+----------------------------------
=20
 RT_RUNTIME_SHARE allows a cpu borrows rt-runtime from other cpus if it runs
 out of its own rt-runtime.

Wording suggestions below.

> +
> +RT_RUNTIME_SHARE allows a cpu borrows rt-runtime from other cpus if it r=
uns
"... to borrow rt-runtime ..."
> +out of its own rt-runtime.
> +
> +With this feature enabled, a rt-task probably hits 100% cpu usage and st=
arves
"... a rt-task may hit ... and can stall other per-cpu tasks ..."
> +per-cpu tasks like kworkers, as a result, it may hang up the whole syste=
m.
"..., which lead into system hang."
> +Therefore, in order to avoid such exception, recommand to disable this f=
eature
> +by default unless you really know what you're up to.
"Thus, it is advised to disable this feature by default to avoid aforementi=
oned
issue unless you know what you're doing."

Thanks.

--=20
An old man doll... just what I always wanted! - Clara

--pta05BleG83gC9lZ
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZhihbQAKCRD2uYlJVVFO
o550AQDu03i1uJtG0AxGErdDS2JmvkRZ3c/WLBTu1QSqG6Sx0AEAtqzYZcvSGCS7
u2XiNdlZMMXwZvzc1CJVuFyjGh8A/gA=
=1lgf
-----END PGP SIGNATURE-----

--pta05BleG83gC9lZ--