mbox series

[v2,0/9] docs: cgroup-v1: formatting improv for "Memory Resource Controller" doc

Message ID 20230105131633.553574-1-bagasdotme@gmail.com
Headers
Series docs: cgroup-v1: formatting improv for "Memory Resource Controller" doc |

Message

Bagas Sanjaya Jan. 5, 2023, 1:16 p.m. UTC 
  "Memory Resource Controller" CGroup v1 documentation has been in reST since
99c8b231ae6c6c ("docs: cgroup-v1: convert docs to ReST and rename to *.rst").
The current doc look is kinda ugly, so improve the formatting (only htmldocs is
tested).

Changes since v1 [1]:
  * Drop the underline fix, since the blamed commit had been dropped
  * Rebase on top of current cgroup tree (for-next branch)

Range-diff against v1:

 1:  e0f2b878ad6435 <  -:  -------------- docs: cgroup-v1: extend underline of section 8
 2:  4e26b743ce9b42 =  1:  cb31249cacdad6 docs: cgroup-v1: replace custom note constructs with appropriate admonition blocks
 3:  c89f9aa1e6dac9 <  -:  -------------- docs: cgroup-v1: wrap remaining admonitions in admonition blocks
 -:  -------------- >  2:  8e03baf289c4f2 docs: cgroup-v1: wrap remaining admonitions in admonition blocks
 4:  b901b2b0407e23 =  3:  790ac70bcf31e1 docs: cgroup-v1: use code block for locking order schema
 5:  f4112d2f9990ce =  4:  2af22c24977a38 docs: cgroup-v1: fix footnotes
 6:  d5d16831555e6b =  5:  9788d0e8c87cc5 docs: cgroup-v1: move hierarchy of accounting caption
 7:  92db959851e2c8 =  6:  b191e2bd87871b docs: cgroup-v1: use bullet lists for list of stat file tables
 8:  767988658f58b8 !  7:  56e4ba363e4e65 docs: cgroup-v1: use make swap extension subsections subsections
    @@ Metadata
     Author: Bagas Sanjaya <bagasdotme@gmail.com>
     
      ## Commit message ##
    -    docs: cgroup-v1: use make swap extension subsections subsections
    +    docs: cgroup-v1: make swap extension subsections subsections
     
         Subsections text of swap extension section is marked up as bold text,
         whereas making them proper subsection is more appropriate.
 9:  a502f09f9a3c33 !  8:  6895ee7c84e840 docs: cgroup-v1: add internal cross-references
    @@ Documentation/admin-guide/cgroup-v1/memory.rst: If we want to change this to 1G,
      
     +.. _cgroup-v1-memory-move-charges:
     +
    - 8. Move charges at task migration (DEPRECATED!)
    - ===============================================
    + 8. Move charges at task migration
    + =================================
      
     @@ Documentation/admin-guide/cgroup-v1/memory.rst: If you want to enable it::
      
10:  895b1f1aa37d33 =  9:  b179c2788f2a36 docs: cgroup-v1: use numbered lists for user interface setup

[1]: https://lore.kernel.org/linux-doc/20221219042209.22898-1-bagasdotme@gmail.com/

Bagas Sanjaya (9):
  docs: cgroup-v1: replace custom note constructs with appropriate
    admonition blocks
  docs: cgroup-v1: wrap remaining admonitions in admonition blocks
  docs: cgroup-v1: use code block for locking order schema
  docs: cgroup-v1: fix footnotes
  docs: cgroup-v1: move hierarchy of accounting caption
  docs: cgroup-v1: use bullet lists for list of stat file tables
  docs: cgroup-v1: make swap extension subsections subsections
  docs: cgroup-v1: add internal cross-references
  docs: cgroup-v1: use numbered lists for user interface setup

 .../admin-guide/cgroup-v1/cgroups.rst         |   2 +
 .../admin-guide/cgroup-v1/memory.rst          | 268 ++++++++++--------
 2 files changed, 146 insertions(+), 124 deletions(-)


base-commit: 21786e5cb375a1e58a9175fee423e1d7f892d965

Comments

Tejun Heo Jan. 5, 2023, 5:39 p.m. UTC | #1 
On Thu, Jan 05, 2023 at 08:16:25PM +0700, Bagas Sanjaya wrote:
> "Memory Resource Controller" CGroup v1 documentation has been in reST since
> 99c8b231ae6c6c ("docs: cgroup-v1: convert docs to ReST and rename to *.rst").
> The current doc look is kinda ugly, so improve the formatting (only htmldocs is
> tested).

Applied to cgroup/for-6.2-fixes.

Thanks.