Re: [PATCH v12 09/10] cgroup/cpuset: Update description of cpuset.cpus.partition in cgroup-v2.rst

From: Bagas Sanjaya
Date: Sun Sep 04 2022 - 04:27:22 EST


On Thu, Sep 01, 2022 at 04:57:44PM -0400, Waiman Long wrote:
> It accepts only the following input values when written to.
>
> ======== ================================
> - "root" a partition root
> - "member" a non-root member of a partition
> + "member" Non-root member of a partition
> + "root" Partition root
> + "isolated" Partition root without load balancing
> ======== ================================
>
><snipped>
> + On read, the "cpuset.cpus.partition" file can show the following
> + values.
> +
> + ====================== ==============================
> + "member" Non-root member of a partition
> + "root" Partition root
> + "isolated" Partition root without load balancing
> + "root invalid (<reason>)" Invalid partition root
> + "isolated invalid (<reason>)" Invalid isolated partition root
> + ====================== ==============================
> +

These tables above produced htmldocs warnings:

Documentation/admin-guide/cgroup-v2.rst:2191: WARNING: Malformed table.
Text in column margin in table line 4.

======== ================================
"member" Non-root member of a partition
"root" Partition root
"isolated" Partition root without load balancing
======== ================================
Documentation/admin-guide/cgroup-v2.rst:2229: WARNING: Malformed table.
Text in column margin in table line 5.

====================== ==============================
"member" Non-root member of a partition
"root" Partition root
"isolated" Partition root without load balancing
"root invalid (<reason>)" Invalid partition root
"isolated invalid (<reason>)" Invalid isolated partition root
====================== ==============================

I have applied the fixup:

---- >8 ----

diff --git a/Documentation/admin-guide/cgroup-v2.rst b/Documentation/admin-guide/cgroup-v2.rst
index 76b3ea9fd5c560..77b6faecf066cb 100644
--- a/Documentation/admin-guide/cgroup-v2.rst
+++ b/Documentation/admin-guide/cgroup-v2.rst
@@ -2185,11 +2185,11 @@ Cpuset Interface Files

It accepts only the following input values when written to.

- ======== ================================
+ ========== ================================
"member" Non-root member of a partition
"root" Partition root
"isolated" Partition root without load balancing
- ======== ================================
+ ========== ================================

The root cgroup is always a partition root and its state
cannot be changed. All other non-root cgroups start out as
@@ -2222,13 +2222,13 @@ Cpuset Interface Files
On read, the "cpuset.cpus.partition" file can show the following
values.

- ====================== ==============================
+ ============================= =====================================
"member" Non-root member of a partition
"root" Partition root
"isolated" Partition root without load balancing
"root invalid (<reason>)" Invalid partition root
"isolated invalid (<reason>)" Invalid isolated partition root
- ====================== ==============================
+ ============================= =====================================

In the case of an invalid partition root, a descriptive string on
why the partition is invalid is included within parentheses.

Thanks.

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

Attachment: signature.asc
Description: PGP signature