Bug 218105 - Incorrect path name in description of creating a threaded cgroups tree
Summary: Incorrect path name in description of creating a threaded cgroups tree
Status: RESOLVED CODE_FIX
Alias: None
Product: Documentation
Classification: Unclassified
Component: man-pages (show other bugs)
Hardware: All Linux
: P3 normal
Assignee: documentation_man-pages@kernel-bugs.osdl.org
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-11-05 12:13 UTC by Göran Uddeborg
Modified: 2024-03-04 11:50 UTC (History)
1 user (show)

See Also:
Kernel Version:
Subsystem:
Regression: No
Bisected commit-id:


Attachments

Description Göran Uddeborg 2023-11-05 12:13:45 UTC
The manual page for cgroups.7 explains how to create a threaded subtree in this way:

    1. In an existing cgroup, z, that currently has the type domain, we (1)
       enable  one  or  more  threaded controllers and (2) make a process a
       member of z.  (These two steps can be done in either  order.)   This
       has the following consequences:

       *  The type of z becomes domain threaded.

       *  All  of the descendant cgroups of x that were not already of type
          threaded are converted to type domain invalid.

Where the last bullet talks about "x", it should surely talk about "z".
Comment 1 Alejandro Colomar 2023-11-11 19:57:50 UTC
It seems it affects more text:


     The second way of creating a threaded subtree is as follows:

     (1)  In an existing cgroup, z, that currently has  the  type  do‐
          main,  we  (1.1) enable one or more threaded controllers and
          (1.2) make a process a member of z.  (These two steps can be
          done in either order.)  This has the following consequences:

          •  The type of z becomes domain threaded.

          •  All of the descendant cgroups of x that were not  already
             of type threaded are converted to type domain invalid.

     (2)  As  before,  we  make the threaded subtree usable by writing
          the string "threaded" to each of the domain invalid  cgroups
          under y, in order to convert them to the type threaded.

The 'y' in (2) also seems like it should have been 'z'.  Do you agree?
Comment 2 Göran Uddeborg 2023-11-12 12:51:38 UTC
Agreed, that must be what was intended.
Comment 3 Alejandro Colomar 2024-03-04 11:50:04 UTC
I'll push the following commit tomorrow.  Thanks for the report!


commit 09ed04875f27741e4ad111d7bcc5e93a5397903f (HEAD -> contrib, alx/contrib)
Author: Alejandro Colomar <alx@kernel.org>
Date:   Mon Mar 4 12:45:24 2024 +0100

    cgroups.7: tfix
    
    Closes: <https://bugzilla.kernel.org/show_bug.cgi?id=218105>
    Reported-by: Göran Uddeborg <goeran@uddeborg.se>
    Signed-off-by: Alejandro Colomar <alx@kernel.org>

diff --git a/man7/cgroups.7 b/man7/cgroups.7
index ca10cf859..877aae03f 100644
--- a/man7/cgroups.7
+++ b/man7/cgroups.7
@@ -1441,7 +1441,7 @@ .SS Creating a threaded subtree
 .IR "domain threaded" .
 .IP \[bu]
 All of the descendant cgroups of
-.I x
+.I z
 that were not already of type
 .I threaded
 are converted to type
@@ -1453,7 +1453,7 @@ .SS Creating a threaded subtree
 to each of the
 .I domain invalid
 cgroups under
-.IR y ,
+.IR z ,
 in order to convert them to the type
 .IR threaded .
 .P

Note You need to log in before you can comment on or make changes to this bug.