Cc: mtk.manpages@gmail.com, "Serge E. Hallyn" <serge@hallyn.com>,
        lkml <linux-kernel@vger.kernel.org>, cgroups@vger.kernel.org,
        linux-man <linux-man@vger.kernel.org>
To: Tejun Heo <tj@kernel.org>, Roman Gushchin <guro@fb.com>
From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
Subject: cgroups(7): documenting cgroup.stat
Message-ID: <196c0cca-b573-8c65-2b5f-66376f79a836@gmail.com>
Date: Tue, 2 Jan 2018 19:22:33 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101
 Thunderbird/52.3.0
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org

Hello Roman,

I wish to add documentation to cgroups(7) for the cgroup.stat file
that you added in Linux 4.14. I wrote some text based on your text
added to the cgroup-v2.txt file, but added some pieces, and also have
a question (see below). The plain-text version for (easy review)
is shown below. Could you please review this text? (Please note 
the FIXME!)

The branch containing the pending cgroups(7) changes can be found at :
https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/log/?h=draft_cgroup_updates

[[
   Cgroups v2 cgroup.stat file
       Each   cgroup   in   the  v2  hierarchy  contains  a  read-only
       cgroup.stat file (first introduced in Linux 4.14) that consists
       of  lines  containing key-value pairs.  The following keys cur‐
       rently appear in this file:

       nr_descendants
              This is the  total  number  of  visible  (i.e.,  living)
              descendant cgroups underneath this cgroup.

              ┌─────────────────────────────────────────────────────┐
              │FIXME                                                │
              ├─────────────────────────────────────────────────────┤
              │For  the  following text on nr_dying_descendants, it │
              │would I think be  helpful  to  describe  a  condrete │
              │example of when one might see nr_dying_descendants a │
              │nonzero value for this  key.  Ideally,  the  example │
              │would be one that the reader could easily reproduce. │
              │Is there such an example?                            │
              └─────────────────────────────────────────────────────┘

       nr_dying_descendants
              This is the total number  of  dying  descendant  cgroups
              underneath this cgroup.  A cgroup enters the dying state
              after being deleted.  It remains in that  state  for  an
              undefined  period  (which  will  depend  on system load)
              before being destroyed.

              A process can't be made a member of a dying cgroup,  and
              a dying cgroup can't be brought back to life.
]]

Cheers,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/