From patchwork Thu Jan 5 13:16:26 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089862 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 44D08C3DA7A for ; Thu, 5 Jan 2023 13:17:14 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id F24D6900004; Thu, 5 Jan 2023 08:17:09 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id ED631900003; Thu, 5 Jan 2023 08:17:09 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id D4DFC900004; Thu, 5 Jan 2023 08:17:09 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id C61C9900003 for ; Thu, 5 Jan 2023 08:17:09 -0500 (EST) Received: from smtpin19.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay10.hostedemail.com (Postfix) with ESMTP id ACA01C09D3 for ; Thu, 5 Jan 2023 13:17:09 +0000 (UTC) X-FDA: 80320796178.19.230CE28 Received: from mail-pj1-f43.google.com (mail-pj1-f43.google.com [209.85.216.43]) by imf15.hostedemail.com (Postfix) with ESMTP id C1DFEA0012 for ; Thu, 5 Jan 2023 13:17:07 +0000 (UTC) Authentication-Results: imf15.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=KZ7VuUCI; spf=pass (imf15.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.43 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924627; a=rsa-sha256; cv=none; b=GAyyyl3ZslG3IJXmtAYokgOMyBYu3H/SOMMnAhB5/7s3o8Yh61TG3KLc/uEMU6Jg7sOCRR n9mbHuEeFihlcuZZ/H/0forBL1prlHNLRlhAfGgcCemM9JPns4Fh3F1zBJB4NPNAzuV9ks +3WjrZbJSv97kDDZ8AhHbBfpbCqDwas= ARC-Authentication-Results: i=1; imf15.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=KZ7VuUCI; spf=pass (imf15.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.43 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924627; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=kEyDN1DoPB92rHtz9Bu6YtukEjhpZoR1SaNfSfYIFW4=; b=68qvELmXnjJ2YnHvDEpi6YXkEUv7X2cLvJzCMjJppz3Nr1v8Y1bE1yo0sNO89DD4JxYQ9M BDruWiM7qy5rxbl5BHdfS2t2ZV+At69mjlKaxdGkMEO8ByF5AxTKOeChi5bZcbN4IOXiPi m/X2ILNRHfOFAz1qzhmJSR7+9MjIEkk= Received: by mail-pj1-f43.google.com with SMTP id cl14so3350107pjb.2 for ; Thu, 05 Jan 2023 05:17:07 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=kEyDN1DoPB92rHtz9Bu6YtukEjhpZoR1SaNfSfYIFW4=; b=KZ7VuUCIf/RIhfW0Ha0Xh1OvaTK8RR2Ace8AZf12WVCOnGaDE++Tuix77O0TG+tqiI UWbd7O/vXR0K9zscx6A2zOnv4chr/TVaiURpCNyhxVrNgpvVq+IGIwz7lfE/M1oPlINT NOImTaNK7y8SYUX9EPUpfeB+pyGG+UOwZJWLFHpvj9UKA2txvhk4n80kTWxu4ASs586K ZZEhS3Z5gKACg1SwAWYMQXZ6lTapo9WARtjcGi9fJorXpCMpiMmKe1majuwpBybQ57ct aDlKlivxjCkkztxSPZMmfGBDQO3qVzGV7zDAJZOreudO+D52wAYUJ/ZO0UBifALXXsuJ P4xw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=kEyDN1DoPB92rHtz9Bu6YtukEjhpZoR1SaNfSfYIFW4=; b=GD4hw8HzVNZwuBAb3oQtPQ9fCYAczEu1c7cQvyVoCA0ifLrvPgWGul1OznJXf0KOSd v7HJQhOMnsoJHaOr66pndSxD5NL8+qtpLlb2qi9xMpKcyfBKPDYVVRUtmfr3rnOt8LRW x2yisfaSpJrLuh432mqzNZQKjMgvm7GgJR/LlXvj4Ss0D5kYl1DNA+rdZMfdWU3wHgsI HIV6ldJ8eRo7N67BRnFTUUJFFdMo7oiyWV0kW/4xu4YuQ3oJHjkodeMDqsT8y0fEBQYi Ma3gXZR6rdNakxnYngjH4YxnkXkgJP3Mc6ePesPFwsY8wwhCjmkvE7BIdh8mhkP0hpre os2A== X-Gm-Message-State: AFqh2kpbw/4HMLnX/fWYRqGOoyLmyS6ryMvb/g388vUzvI9M361t+1Qm QK9rJDKepPnrr4mtDI3fLmw= X-Google-Smtp-Source: AMrXdXua9EXcDqeZze7Fj7qX9Z1Mtd3h5heZGEbc9ZeNK053ZyPPuHU+uBZFwPujwGzBi1MnYiCLlQ== X-Received: by 2002:a17:90a:e545:b0:226:2332:a3fd with SMTP id ei5-20020a17090ae54500b002262332a3fdmr29442612pjb.5.1672924626731; Thu, 05 Jan 2023 05:17:06 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id nn2-20020a17090b38c200b001df264610c4sm4161995pjb.0.2023.01.05.05.17.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:05 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 7BD531042DE; Thu, 5 Jan 2023 20:16:59 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 1/9] docs: cgroup-v1: replace custom note constructs with appropriate admonition blocks Date: Thu, 5 Jan 2023 20:16:26 +0700 Message-Id: <20230105131633.553574-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=5301; i=bagasdotme@gmail.com; h=from:subject; bh=DlZUnry3AswBM9GzCcO9SGcvMxRqxgXh0Yg3NkkBNXs=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzq6zkfwiJlWTZq4w3UpyzsfuB5u2XBOcKPWCf9efiZ8l TRiEO0pZGMS4GGTFFFkmJfI1nd5lJHKhfa0jzBxWJpAhDFycAjCRxUsZfrPHF16fd5hv0fNbsQuerm Hv9+Q/dKNXRJdnxrNENY8Iw9UM/9359n8NbLm8K+J17eds1aCraype/s+5+KVnt4jYtvkLeVgB X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Rspam-User: X-Rspamd-Queue-Id: C1DFEA0012 X-Rspamd-Server: rspam01 X-Stat-Signature: unudt89a3qgdz43t5udh5i75nzhxewyu X-HE-Tag: 1672924627-709661 X-HE-Meta: U2FsdGVkX1/84mvjUr5iQpTn4E67T74KLhB5dNug0ow9NaQT6fhF2KC35PaMTQmxnG0pZfQXzwacORSRpu0TtSlPEF9oOOB8c9PEruuaEFWZhKodc4oZlo9rR8lroNJtYT9JugXQJy3aK1zCFMtPPiqzFEGbQ93ZRSbYdUDKPAOMb8cSiPpD30lABE6c/MQP9okncGcRMWu0nltLPLpyhUhMKTBPP2jzUyk9MHVgZWiXAaevz5Ghed2w0DsSfZpH8pXdcSDir3yw+ff2/EbKESfAD5W9zERg4kBqsfkSlWYNlSaYDR3fHIVDSPQK24yECcDXOz7ekxYGvR4bBWf3n215cRfhYW9EmDUbz3C1ynmEkywWULWkrlSjFUL5XobTegyr0XYdkCv2WUwO9T2WwYzL12hHZOT7bxCMT+O1JNy80IvkJYThR8ObG2O3Dy0801dUjj6rFPHblh0FanlvDetaIu9kHwrMsIAAuU89rLTHafITcFgO5z/pnXhCoFLpKcrc0DywU37wsxMH2Bsp2aB6gPn4FfD1I+lINadangjg69rSY9fyqMq5cl3Kl0dmwzQvzjMu107gLfn7Qlh803Kdj72QgqKGOLUvyR93H8U+kQGHFcVorEgazkrvRYThBA43pvuXjGGPLg8C6rt84yeXZactCTWCH1NrFWiDnETbayTQdKuP9dcM9rJJ/aKSPRPZstw9L/CnlvywJRpJyIturZvV4B1WRf4/LIuyamg7QvAbNw+kvCwSXEf1Jk2k8gmuo0KAgvF3CsDLEj91YcS65zN7T73FE3iyzeERoyWV1maSRe62ahu603A4LgyiJRscx7j0VijMQXwYz2OeZR3jhreoQVP4TJyYGcTfsLJFj+IUbzyqwmypvBO5obeKrB/B68Klux9LbttXWyKQcfYQfC+wn7rgllEUw3yGHf/YjBJoSU90AfVixGEeznnH2YH1ERDLdNt6n+l4e/D yiM8ELkT uxZ1M2+dIsXI9hARQ6nt1FVEOJFhGN0DpOmYM8DMFt/QEMFdx46+hup2q5bImgbifHx0V2REOisbQki6v7BgNEGIie3TV8fyPsCSwEOmUg0/pFT3zax+WWnQM/MA53SalofeL X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Admonition constructs on the documentation use definition lists, which isn't fit for the purpose. Replace them with appropriate blocks: * Use caution:: for outdated document notice * hint:: for memo * note:: for other constructs * warning:: for memory reclaim Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/memory.rst | 58 ++++++++++--------- 1 file changed, 31 insertions(+), 27 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 60370f2c67b99c..d0d8c780cb6bd9 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -2,13 +2,13 @@ Memory Resource Controller ========================== -NOTE: +.. caution:: This document is hopelessly outdated and it asks for a complete rewrite. It still contains a useful information so we are keeping it here but make sure to check the current code if you need a deeper understanding. -NOTE: +.. note:: The Memory Resource Controller has generically been referred to as the memory controller in this document. Do not confuse memory controller used here with the memory controller that is used in hardware. @@ -274,12 +274,12 @@ The reclaim algorithm has not been modified for cgroups, except that pages that are selected for reclaiming come from the per-cgroup LRU list. -NOTE: - Reclaim does not work for the root cgroup, since we cannot set any - limits on the root cgroup. +.. note:: + Reclaim does not work for the root cgroup, since we cannot set any + limits on the root cgroup. -Note2: - When panic_on_oom is set to "2", the whole system will panic. +.. note:: + When panic_on_oom is set to "2", the whole system will panic. When oom event notifier is registered, event will be delivered. (See oom_control section) @@ -367,10 +367,10 @@ U != 0, K < U: never greater than the total memory, and freely set U at the cost of his QoS. -WARNING: - In the current implementation, memory reclaim will NOT be - triggered for a cgroup when it hits K while staying below U, which makes - this setup impractical. + .. warning:: + In the current implementation, memory reclaim will NOT be triggered for + a cgroup when it hits K while staying below U, which makes this setup + impractical. U != 0, K >= U: Since kmem charges will also be fed to the user counter and reclaim will be @@ -405,16 +405,16 @@ Since now we're in the 0 cgroup, we can alter the memory limit:: # echo 4M > /sys/fs/cgroup/memory/0/memory.limit_in_bytes -NOTE: - We can use a suffix (k, K, m, M, g or G) to indicate values in kilo, - mega or gigabytes. (Here, Kilo, Mega, Giga are Kibibytes, Mebibytes, - Gibibytes.) +.. note:: + We can use a suffix (k, K, m, M, g or G) to indicate values in kilo, + mega or gigabytes. (Here, Kilo, Mega, Giga are Kibibytes, Mebibytes, + Gibibytes.) -NOTE: - We can write "-1" to reset the ``*.limit_in_bytes(unlimited)``. +.. note:: + We can write "-1" to reset the ``*.limit_in_bytes(unlimited)``. -NOTE: - We cannot set limits on the root cgroup any more. +.. note:: + We cannot set limits on the root cgroup any more. :: @@ -574,12 +574,12 @@ recent_scanned_anon VM internal parameter. (see mm/vmscan.c) recent_scanned_file VM internal parameter. (see mm/vmscan.c) ========================= ======================================== -Memo: +.. hint:: recent_rotated means recent frequency of LRU rotation. recent_scanned means recent # of scans to LRU. showing for better debug please see the code for meanings. -Note: +.. note:: Only anonymous and swap cache memory is listed as part of 'rss' stat. This should not be confused with the true 'resident set size' or the amount of physical memory used by the cgroup. @@ -710,10 +710,11 @@ If we want to change this to 1G, we can at any time use:: # echo 1G > memory.soft_limit_in_bytes -NOTE1: +.. note:: Soft limits take effect over a long period of time, since they involve reclaiming memory for balancing between memory cgroups -NOTE2: + +.. note:: It is recommended to set the soft limit always below the hard limit, otherwise the hard limit will take precedence. @@ -735,17 +736,20 @@ If you want to enable it:: # echo (some positive value) > memory.move_charge_at_immigrate -Note: +.. note:: Each bits of move_charge_at_immigrate has its own meaning about what type of charges should be moved. See 8.2 for details. -Note: + +.. note:: Charges are moved only when you move mm->owner, in other words, a leader of a thread group. -Note: + +.. note:: If we cannot find enough space for the task in the destination cgroup, we try to make space by reclaiming memory. Task migration may fail if we cannot make enough space. -Note: + +.. note:: It can take several seconds if you move charges much. And if you want disable it again:: From patchwork Thu Jan 5 13:16:27 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089860 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0D197C53210 for ; Thu, 5 Jan 2023 13:17:11 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id ED71E8E0005; Thu, 5 Jan 2023 08:17:08 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id EBB558E0001; Thu, 5 Jan 2023 08:17:08 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id D74488E0005; Thu, 5 Jan 2023 08:17:08 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id CAB728E0001 for ; Thu, 5 Jan 2023 08:17:08 -0500 (EST) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id A4D29A0366 for ; Thu, 5 Jan 2023 13:17:08 +0000 (UTC) X-FDA: 80320796136.22.981F007 Received: from mail-pl1-f180.google.com (mail-pl1-f180.google.com [209.85.214.180]) by imf07.hostedemail.com (Postfix) with ESMTP id D715340003 for ; Thu, 5 Jan 2023 13:17:06 +0000 (UTC) Authentication-Results: imf07.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=pEf0tlDI; spf=pass (imf07.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.180 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924626; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=EUYjmNJNX3EIHXC0Kg1oUFxJ9a1dGF+07OElWAzi70E=; b=cBN9RfICUh1qK1/l0iLCfMjFUHyNbDMW7Rljp8qJyrzQ4B2pTZsVnCGSRySu4gnZZil4s5 5k/UnmFhVXI85G6YwO3tnz1gxuLnz1cU7N1v+bn6vOa0tm7XE8NFN0cHscxOmljniHzkxb hpJ5c2ac+drm8/CHoYxO2QDav2erKqs= ARC-Authentication-Results: i=1; imf07.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=pEf0tlDI; spf=pass (imf07.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.180 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924626; a=rsa-sha256; cv=none; b=VkoCWgQZinToVIZgSy6vIc0S+heqlw5OWFJGTPlN2i8/5Zfym3agOjmS0z0JXllly6bnXz F8kIIntZRCXCIvZvgbi4831U1F4Eecg+gbOaHX7wgSPDkpCqijaSdgyGIErdPzrvbQme8r tyrYF7n0sdxkoAKau9BTtlNAzoA34SE= Received: by mail-pl1-f180.google.com with SMTP id jl4so33030132plb.8 for ; Thu, 05 Jan 2023 05:17:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=EUYjmNJNX3EIHXC0Kg1oUFxJ9a1dGF+07OElWAzi70E=; b=pEf0tlDI14cg718e2UjLbBPIw6gz58pcBgl/mZqJb17JoDKmf4ebY3uoHvhwaYGc4d 8//GhUDyynq9lR7EUZ6Jb13SOAUrqpVKd3I8d21JPwfc6OPxpWpQ3e7FAmPPoc503j4S Saszua8tfPTYOLVLfysVYmuwwkXPJjRc8sW4V2nJr++VrhuhpD8By2lx30peHyeKkghC MUn4aOiX7owa3KzqTQvF1fQL88hv2v21axjD4RoOxUlymmV266wrh+fKvf7Pv32Z7vLr lKQwQgQpgQdJ/DCU0VBUNvyV70VCzFBQKoJebskRh4/uNFBWOhqX2wTM8loT+ohIZLAf yj3A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=EUYjmNJNX3EIHXC0Kg1oUFxJ9a1dGF+07OElWAzi70E=; b=tyg9JdqNoTFVgFBzfvXE6FNEedSQWf2x2jMtHM1nuyKxI7V+uH5hYZ3jR2QWEkVKTf NfI744Tgg8IVdWCurSasajeN3YbSxNDaYwEftOBPo/PPnu95z0DtO/O09efJP08UaadK 0uUrEWl2LoWIQ5BBnD9Jpuq59kz1JYcIp++kk33RXbMxXHlcvKinRNQBf0tllv1MGnGu CwaPLJ7lGr3aqkcfexuD5zYUm5K/E0XPgVrTJVgv8xSL4yD/JVX843jvknDB7JsstrAI IArQKrNHBJLh5/lOlufL4O2IuYVTKeIBhK3h3UfFVcvSg50xACBMaeBTEFD5QUF66Ui7 o7DA== X-Gm-Message-State: AFqh2kogJ/2ud3Wxqoik9iHLxS6VO2PHg9dSdEbGvZyH+mI9MCViq7aB KAL8pghkWGn/v8ZsbhIFWMs= X-Google-Smtp-Source: AMrXdXv80mGohLQSKP7xW+IpL76jo1fslPpxki49NJnSCNujtCj69FbgIT810EatTBYqeEsTWpBMLw== X-Received: by 2002:a17:902:8e81:b0:192:d5dc:c842 with SMTP id bg1-20020a1709028e8100b00192d5dcc842mr11888101plb.44.1672924625628; Thu, 05 Jan 2023 05:17:05 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id t7-20020a1709027fc700b00192d3e7eb8fsm7232005plb.252.2023.01.05.05.17.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:04 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id AFE841048CD; Thu, 5 Jan 2023 20:16:59 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 2/9] docs: cgroup-v1: wrap remaining admonitions in admonition blocks Date: Thu, 5 Jan 2023 20:16:27 +0700 Message-Id: <20230105131633.553574-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1148; i=bagasdotme@gmail.com; h=from:subject; bh=lVJicFMEl6ad4fCfED8HKHDv/aSeW7ylfz8qS3An+no=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzq4vNBYKCd3bmcV9+5uUy0z7o9MXVf7QviLr+cXonYRX St7jjlIWBjEuBlkxRZZJiXxNp3cZiVxoX+sIM4eVCWQIAxenAEzk9CKGf9b/N0rf1hF0ce5oufcnok N88nLxF9U6JlvWFldayGfc9WVkWGDful9O0+7A0yDvRIf/St5zCg7L64uXOU4pVkrT0bXgBgA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Rspamd-Queue-Id: D715340003 X-Stat-Signature: hr8m7ex3krftp1ydit5tyhx5cfr573so X-Rspam-User: X-Rspamd-Server: rspam08 X-HE-Tag: 1672924626-939710 X-HE-Meta: U2FsdGVkX18GLEe6CqWkHRnjBpjoSX1xuo92+AqZz6u+Vof6NFAoPmW7lVi4tze7Kod418nTk3/vesZMAOwm9G2KEqtv3g/8aYi02uRYPkUERK9+QJbtoag/O6XSubKqckX/W3Oe0sINVS6kOg9tjoqvemkkTX8LXLScIMw805tDlZry6X5H1XDYNBNDaAgn0Vw4/EXSwQtTO8SBDA0w0Mx4WfJZu1yLWhdII3vWjCcxi9Sph0asqVYkcSSzKU/Tf3RuAVKZwghRx6RDzP0m6QOS54vf3uQCRLyu0JsSreVjUBaolwjp7xbYFA7Nh2IvWoKpSJISnjObYeRKSC/zDDs4OeK0/OF9ynbArlfCjgFwTtAuV9lFYxVtcAE5KPrGEIKnarZI8b5KAuxUiiyEiK5y1u5oYfmKYpLzfsC2GPvyl+bHKVVEZiIgTtY9zBQfTlEK+Fcio7H2+JEuIFRpuoYHZjqWr6uXdY/+KzAb0t14g20zekSbPH+QIP9VODZDCkesAHPnpCLvwtXlIsI+5OJi/zO3LFu1IMX9J8zwnenUDfIB/L5E/zRk80MMhN1TFOcjD1TVkHZ+yDOXvpYgZlONe5z83B6rX9bxsK8U1cGC3eIdR6LWK9h8Gt0U9MyEEsUvu8Bh964VRl8mcYZvg1uN7VceHPr7U9BqnaN+4uMn7OrLixyExl5x0fpzap5yRQ6dpboYSCT9H0Y/O5S4T/hZmRt5dhZWP+C+lsh+xAExa6Tjbp7lttYmuftNf4eWGMMJxiuDeJPXMXB5o+NZzsIQ14OY6wfJGCr4WLOPHSlf0ucwBUvNBv7ZEPztn9We8OQanErT/lzFJjMLo3Ql6dsOGRtWY1FAJi8ebYckxxYuNJa4neV6ZwF6l+m987/dp0yZCYFiO1DJctxMw9Z49WAoipe12ISQ/GvkaNhojO1jEpNRtStNrR4R1YLNWVJKrYA1wcNCVEg6AEtK5Qn y18Qg51+ P5E+kItTFmIP66jYX8iL+qLyvEy4AHf3Omy5HkKlb9VG8mjMcmNcqBlb6iw26CCFyekKiIV9/+IQa5QeZ6+EBrVotvPo40L/rIxwMWzkzIIR7AkaE8X5h1CnqC9FavRFSncW4 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Wrap two other admonitions in appropriate blocks in order for readers to pay more attention to block contents: * hint:: for editor's note * warning:: for move charges deprecation Signed-off-by: Bagas Sanjaya --- Documentation/admin-guide/cgroup-v1/memory.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index d0d8c780cb6bd9..b0353c40639b7e 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -13,7 +13,7 @@ Memory Resource Controller memory controller in this document. Do not confuse memory controller used here with the memory controller that is used in hardware. -(For editors) In this document: +.. hint:: When we mention a cgroup (cgroupfs's directory) with memory controller, we call it "memory cgroup". When you see git-log and source code, you'll see patch's title and function names tend to use "memcg". From patchwork Thu Jan 5 13:16:28 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089859 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id A2E14C3DA7A for ; Thu, 5 Jan 2023 13:17:09 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 9CC698E0003; Thu, 5 Jan 2023 08:17:08 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 959928E0001; Thu, 5 Jan 2023 08:17:08 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 844058E0003; Thu, 5 Jan 2023 08:17:08 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id 789868E0001 for ; Thu, 5 Jan 2023 08:17:08 -0500 (EST) Received: from smtpin28.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 4BF761A0DA5 for ; Thu, 5 Jan 2023 13:17:08 +0000 (UTC) X-FDA: 80320796136.28.721FE3F Received: from mail-pl1-f174.google.com (mail-pl1-f174.google.com [209.85.214.174]) by imf30.hostedemail.com (Postfix) with ESMTP id 58E548000A for ; Thu, 5 Jan 2023 13:17:06 +0000 (UTC) Authentication-Results: imf30.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b="XkW/T1so"; spf=pass (imf30.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.174 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924626; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=XHKqH/mTeMAtJX+k1fwhOFwTW56tZzYBJVqR/bzkhlc=; b=62XJ/Z9CVoSbpGb9wWgInxZT2En+hjQriGjmRSNP50euuZVAWJn/89ENM1gsOAD1z1OkNj KAuEPQ1UWDl6Y20bX6aLAq36FN8lPr7Lg7q2UkGU5yr9Ve5xrmeQ5IM7t7RwwjFEKUiKiN QxyNyML5NVClK4Wolt4S3Lhyi432tHg= ARC-Authentication-Results: i=1; imf30.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b="XkW/T1so"; spf=pass (imf30.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.174 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924626; a=rsa-sha256; cv=none; b=ZcihzJvK0KOKgwuIUG3mUFV8WsPga8/DVRheaj1PvoxtqbBd8YSvfnfwgCjg1Jpi4FjJxE M98SVPQeKw/pVPOLM3gycZPwjb9eQei7n4+mE02yM+S8jRyHTOGWvypxQFq7viYUn3BlkL bgXY6y3JgKKrYAO09/uF8BkpkmKs0G0= Received: by mail-pl1-f174.google.com with SMTP id jn22so39263919plb.13 for ; Thu, 05 Jan 2023 05:17:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=XHKqH/mTeMAtJX+k1fwhOFwTW56tZzYBJVqR/bzkhlc=; b=XkW/T1soWfm4Rl1XX1uhjbNQfx1mx3n00vAID2EM9vtxWbYXinFO4hH0F/Sh76u8Nt T+gnK2msfrDFO1KmUccj24rF4UB8vifHeM6vVJGG4BqzWmkF5LR+KlioizvkKNFhtzGI DqZ08ByEgPPDNotBdzpS9VmCEyShtWZsvx3n8EAJPOHu1HX5kpNBORHmuWbj2c2tqTYV kKkA+xB6Fxx4Jc5iZgdCkvewR5ElvC1Q8mCbRjR5m0aVPDHOhmprl5Z6bpMJhV7aZOd2 jqwuT8bQYA/2qPzKPL/nYTtz+E24L3VfdAWrshv08AHCMMHGZLUBryatFJX7kP89y92r Wa8g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=XHKqH/mTeMAtJX+k1fwhOFwTW56tZzYBJVqR/bzkhlc=; b=oYg93TYkjkz8C2LmMldB9uXbJLxolllDaG8kza/5xRF5ujCLVS0y0wrs57IE2mHGT2 4SDWHuptb3AvxFFVyTQZy0f0aEg+xL+rnQYIqF1RoLBihd62dHN54LJG4XreEgEPe2cD HAnGkLzJvh6EQrX0f1rzHMMj/JgcIDBCWwSr7bR/MkPZlpB7OT6g5KmAS98DviDtxpTR t/yz8hWJkyYmt8Dhu/bhM2feC1GVuuAuIxNe77/pJ8YBbu+LNeopP4CFAE7y4+fmtA0D nOPJuPvenHNH3iOZCe2haTVW9GZ+mawFf34pp88few+cZ57TRNJEnSKJyxj2Jp4PbMF/ d/Xg== X-Gm-Message-State: AFqh2kpGRc9IOYhC7o6o6lB8ItOze8IPPZWml2Sx5DtWdk+RdB41PgJ1 ELBaWPG8bjnkAA1aCJ/Yj6g= X-Google-Smtp-Source: AMrXdXuI/wFI9NZprHDOZ4C4Pqbm5J8rbYDJ/NE13dBSqovxsPA/Y3l0huJb190MwMO5oSrbIdxjoA== X-Received: by 2002:a17:902:d491:b0:192:ad82:dc98 with SMTP id c17-20020a170902d49100b00192ad82dc98mr31433592plg.34.1672924625229; Thu, 05 Jan 2023 05:17:05 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id i2-20020a170902c94200b00189618fc2d8sm26053948pla.242.2023.01.05.05.17.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:04 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 9720A1043E8; Thu, 5 Jan 2023 20:16:59 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 3/9] docs: cgroup-v1: use code block for locking order schema Date: Thu, 5 Jan 2023 20:16:28 +0700 Message-Id: <20230105131633.553574-4-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=903; i=bagasdotme@gmail.com; h=from:subject; bh=IgqigKn9DkjPklU4lRTNbnqTt63GfYY/akiSBYrKIlo=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzq4XDnK5Z2Dspp/XK6O/hDH/vy9jfrHcT7XO5Wcey2i5 SQp3lLIwiHExyIopskxK5Gs6vctI5EL7WkeYOaxMIEMYuDgFYCICVQz/a/lu5hjddea89ev3r8tRkp XRb02+MnYu/XFlWaNkJntyKyPDAc1vbdt6LNecrSx/q+j+h/XJHfs98c6Fk0yPFO7av6OBHQA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Stat-Signature: fc5udjq4ga5x4epu51hjwef6f56wjfzy X-Rspam-User: X-Rspamd-Queue-Id: 58E548000A X-Rspamd-Server: rspam06 X-HE-Tag: 1672924626-834653 X-HE-Meta: U2FsdGVkX1/B5pPjBuW1CLTzc2XEWqU9Encfhn3oqMKt1TrimQN30JZEbTn9pWjczoNf18br6EB1dHo/9mH/gif13sZoyPUdwIeNyZUxfRuU27RrSRJcFAw/8yLj0a/vbXzGisldZdfIOqMmVvgZfs9VY/TsYAWdaaxN2ww9chp+pKqFAZ0Kgcs0BNW2SZOcjcV2lCc81UF6zuTRXU6KzIiYdVpO80hBgTdM8/milynPxrKu7kQriwMQlm0tJQ0fPgY/WyAe3b4nCE4lvDFMbrghzAqGy/L4a5oG8TUwVz7z1orNeYy8UqEOiL3D/CVLRby2camHME9i8kgmCzUvVlFGqGj1k8J+bHwny8b6wHFsRc7v0UWCR/sUoYXVfh6lOCcuRZ9afmPk0Re+8NrV5Mi/PItcpy/6VZiLuZ/EynUONTCpVf1Wgg/GPtA7LigVi3FfSuHblwTuzzG4WJpjiB4M1KIqnqQ1hiEA11jKqcX23YJyBTdUZIxUDEtJ2C4NCj10bouC+z42xFWoEcuL8EKWXctXAW1gclV1QnE6oIoomtbAfU41kXo4mqVoOKhg7f6iVY1CBSqHsIrTnn8VY8jgUot4eyR6XawnpyO/2MTAVKY5gwlBmy2W4SOGx2xR5kKompYrA/G+yrsLH7qGsnBDiY27LrufZqmmH1rnydT6lamqLnT42c8nlAAP3VgKzPecTGXkLPlpC+46pm2BWqypSkZc48O5ljN05vx3vLQ3FOZ6q2OBcIRVlW+2xbZSeJNy2bJjbPg3vbw7eg22YM5GyAFj2c/a6u1VJ9//6TditSzrLww8rUnGzj8PjzGLPBxD+VO2aDDRDxqOP3Ckgu6SvyMQfm/6bOiHyrbJBih8sp6zh12oLY9W+BkLAzM4LyEUsR+U/pRWdCDPXWw/o144kzSlCJ3U5KhrErjuMvYK+omG+1RV3r26M0ifQAMLdaVk9JQ5YusGjKZ/GWU mcabImun aBLxjoAPtYZ3SZkITsTzp0g8EaBx1FuxUGN1T40Mt1L43a7ecXcK0JvZa7mf8tXXQ6agO8r32lyzX4ZEkPpf3VMOJ9+hJY0Lv4wUBfF3/97FSRKfyYGrneJiC3vv21Ff8yH6Z X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The locking order schema is a figure (like diagram), which should have been formatted with literal code block for consistency with other figures. Signed-off-by: Bagas Sanjaya --- Documentation/admin-guide/cgroup-v1/memory.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index b0353c40639b7e..2b807fc128c662 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -287,7 +287,7 @@ When oom event notifier is registered, event will be delivered. 2.6 Locking ----------- -Lock order is as follows: +Lock order is as follows:: Page lock (PG_locked bit of page->flags) mm->page_table_lock or split pte_lock From patchwork Thu Jan 5 13:16:29 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089864 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id DFBE5C3DA7A for ; Thu, 5 Jan 2023 13:17:16 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id CDAF6900007; Thu, 5 Jan 2023 08:17:11 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id C6504900003; Thu, 5 Jan 2023 08:17:11 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id A8FED900007; Thu, 5 Jan 2023 08:17:11 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 9B26E900003 for ; Thu, 5 Jan 2023 08:17:11 -0500 (EST) Received: from smtpin03.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id 6E151407DC for ; Thu, 5 Jan 2023 13:17:11 +0000 (UTC) X-FDA: 80320796262.03.68DB6AE Received: from mail-pj1-f51.google.com (mail-pj1-f51.google.com [209.85.216.51]) by imf26.hostedemail.com (Postfix) with ESMTP id 91C9C14001A for ; Thu, 5 Jan 2023 13:17:09 +0000 (UTC) Authentication-Results: imf26.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=keDd3AgP; spf=pass (imf26.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.51 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924629; a=rsa-sha256; cv=none; b=nTUIF1A1YbnkVOzNMdVT3vt/HUi/Sb931wtsjGwP/75gRNaco8fz521dajuCXlIVC9lzse dDzBlaEMYufULCjTYH9BVHPhieJNaFb2hM8ey0mT+415t1wK2hGvjhCjoxcawlN0c17r89 OXUhCdFPdN4SyJrJQgtuU9mcCNA1tpg= ARC-Authentication-Results: i=1; imf26.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=keDd3AgP; spf=pass (imf26.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.51 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924629; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=WcgLa2dNrRbbB5gOhzfJxjnV71pkRRr18/tvuPVFK50=; b=JhskVRtGAJcd8ZuipdGAMAbk4PFaa74KfpYRJkf4/WatHlY2X6jJezsv1YHguFX+RTmr05 jMMYI8k0OgGxSgGlC+j6U2oHcuvJIS/dfsRVUP2t2AiIlFOLDTbGonUrqV8LnDcT1D9Xww REHFcwsZ6umbTtOnDJXfHNI9lZzniBc= Received: by mail-pj1-f51.google.com with SMTP id m7-20020a17090a730700b00225ebb9cd01so1971834pjk.3 for ; Thu, 05 Jan 2023 05:17:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=WcgLa2dNrRbbB5gOhzfJxjnV71pkRRr18/tvuPVFK50=; b=keDd3AgPUHBkhQi+rsF5VDBfEFxkbSMl3Vqw0PYwH/URI1zS8RogSrFV/8SHOT2rcb I133BM/nD4wJ1EadTEgtSEDHDPrcig04g3dNQ4nfkqx1gvITJcygp7HgRmME0VppT5i5 8g7EWVT/saKRIoUp1ZIB7M2O49HAmxkadDEdEUWyUhIldVpmt2TD6k1XYn5vN+l4y0t+ w5uhh7NvkckKzoRXRBq2lpxu28RhgpVqRYPd9uRQhoPdfLt59iM9m5mpmZVpxojBFHUU kKNdT2f3FiEZjnlOWzwCzGTfAEwvYMLKN2ON1apQj+lEfgkbpdE1RfunoE+Bbj/ZZ3aU 1R0g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=WcgLa2dNrRbbB5gOhzfJxjnV71pkRRr18/tvuPVFK50=; b=dhuj1jBtcLGT5JTL9T446KO747u2rKLsDRVjH0SRt2stCAqXaYMm1BQNtRcohllQSB 7XVTJeemj2WlKp6VbqVdKoLBbqVflx+rmcWzd94QuOz1wMyPSZz5DcG3BpjFnjKOijEN xKy5LS9ho7vXrrfEEkYbbnwICCQALJyBQYyrFSCqDauHneYda4SsAlAB2vGFhrx5pgYf b0TBZE5U1lf8tbsuBCLOIv3a9bA+krCNFggBv77bE9xVnTvtguUYVEkKmdk1+0Z+ilMp 7ioqkHzOOA3xIcwCKSld3NqbTJWdzMzvTOZpUtuKr7Cpk3EfJgXlxRK3R2fxSWgeftFq zzhA== X-Gm-Message-State: AFqh2kqOf/hy16QciHCuVeI/cUDPYy/q5vVz0ziKSh0eSp1VZhWKfaFU fgTsc6mzW8FcKfZqyUHt2DM= X-Google-Smtp-Source: AMrXdXtglOj8A4JpjzospA6ZVS8xDhDFh3sS/+n6zUQ0COioBhiZcJZTWPZZ7RtTN+bsVQJ0rOvuEA== X-Received: by 2002:a17:902:d491:b0:192:b40b:e41 with SMTP id c17-20020a170902d49100b00192b40b0e41mr33019419plg.61.1672924628393; Thu, 05 Jan 2023 05:17:08 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id u14-20020a170903124e00b001911e0af95dsm25982139plh.240.2023.01.05.05.17.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:07 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 1616D104F84; Thu, 5 Jan 2023 20:16:59 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 4/9] docs: cgroup-v1: fix footnotes Date: Thu, 5 Jan 2023 20:16:29 +0700 Message-Id: <20230105131633.553574-5-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=4564; i=bagasdotme@gmail.com; h=from:subject; bh=Li+17qbQJgnbNb0Pbpw9z8Zmcq62SZTQcF9sfN0MfPE=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzq6P9OrLP7vybP+GlXoHvU8ZyVxYFBl27qn5hBWm9b4h Kzo1O0pZGMS4GGTFFFkmJfI1nd5lJHKhfa0jzBxWJpAhDFycAjCRl/4M/4wTt0d1cuy3W33uwGLZ0q yehNM3tp7XkOpxUg0Ofe9xdicjQ2d5hGC1K1+WwIaTC+q3+EedWJbbzfbB321yw8oapQW9bAA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Rspam-User: X-Rspamd-Queue-Id: 91C9C14001A X-Rspamd-Server: rspam01 X-Stat-Signature: 3o1aiqkhnab3uojuc4it1diapzc6f7kg X-HE-Tag: 1672924629-278117 X-HE-Meta: U2FsdGVkX1/VoUlzCAkmKyl0c6fI21lJ37J4ClPkj11Cj/o075DonTTZ5u0/3NuBpmYrc926R722fs2WXmsyU+doZ3bt77PiL1FQMW74iO4/Z02Nwgvz0kVkTv9kskp9zYwkIrdNv4y9yqdj9U0q95DYBT8gUdWLQdUYaD/EAql7msHwZE27ejUHVlmH/c6lX9zrA6EuzTr0ZzAUkWkFeQ25DiwedIJtIjSRoZPQFWLMVAEp4wJ6TSiPYhZr5jRdZ+Q5ayK3r4tc/KKhR2vnRbarALsRTW9W2z8W8RGy4gXQgxUeAv7SbG1iWy/MkPXF3dApSRjWPpnFtG3YZv5csr3yI4X8n1EbbNJvf2rKzsoBMh4UQOyPmcanEr/Cm7Doc3aDOHIozHlADqqJTAk34p0J7W89t+kWDtkFJzeAS8ofLKBFZl9KLtDxklpb7GKi3SIaDcvq1VGFTl/NMXn56jZw8IA9R+arIt8AGeYb40DATDsgbDkI3sAmxM+E+i4TVV/xkcqK0A7WFylyJHA0l3RlVF5f6GPl4S+FGTQa00yxZ7OYxlr/S/oB7n2evNJMXgaI9tRkZs5vXwg33dp8sOqqTQReOWp+VB47tyotJs8ehpTpl8eelz4POIDKIMp3DbkN7UrQ77+ljcWLfJxIP3Arcb/gzB511eqenNnn058WCaFNSYC9ltnUsJy/lUh66zC7LuWtHoXjqQ2Xb8LZyx936DO2xOCxBmeNMtHIO34PSZNUddgqKwB6+ovQ9bZL3ZZbDCCiYSYWOJ/g9Z8zTzOk70zZJqRbGDNNZ/7DISiW0sBrC70XLwNyk8izNhCb6mknFdjOAgf0Y5tFTZ3EFULXpZDzUmZWB2SRoK4pjpCUITRZvClXnAllJ/qc3fa7dWQhAv1+BLCSiTVH2qxM0GYXY9cDbR+G8bbuwJd2G2HUQwECLg3NzgH0tdogfjuHDMbXyWWfxFxKqcpJokg o/pE+Wsv 37rZhPncYu3ZZS7AabwBk0Efo81SqSQzKtqEK1RMAZBnhRy0qKdG1TAYmKA2s2ii+aEhqhHuyimNStsjE6BhuK5HexSSS8opvwnxWnBb9AH9nq2D7qXx+IhN6vHQuBpf2mJrg X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The documentation contains external references, which some of them are marked as footnotes. Fix the syntax for them to be properly rendered as such. Non-footnote references aren't affected since the text for these is aligned the same to the footnotes. Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/memory.rst | 36 ++++++++++--------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 2b807fc128c662..8d1cedcf44f6ea 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -23,7 +23,7 @@ Benefits and Purpose of the memory controller ============================================= The memory controller isolates the memory behaviour of a group of tasks -from the rest of the system. The article on LWN [12] mentions some probable +from the rest of the system. The article on LWN [12]_ mentions some probable uses of the memory controller. The memory controller can be used to a. Isolate an application or a group of applications @@ -107,16 +107,16 @@ Brief summary of control files. ========== The memory controller has a long history. A request for comments for the memory -controller was posted by Balbir Singh [1]. At the time the RFC was posted +controller was posted by Balbir Singh [1]_. At the time the RFC was posted there were several implementations for memory control. The goal of the RFC was to build consensus and agreement for the minimal features required -for memory control. The first RSS controller was posted by Balbir Singh[2] -in Feb 2007. Pavel Emelianov [3][4][5] has since posted three versions of the -RSS controller. At OLS, at the resource management BoF, everyone suggested -that we handle both page cache and RSS together. Another request was raised -to allow user space handling of OOM. The current memory controller is +for memory control. The first RSS controller was posted by Balbir Singh [2]_ +in Feb 2007. Pavel Emelianov [3]_ [4]_ [5]_ has since posted three versions +of the RSS controller. At OLS, at the resource management BoF, everyone +suggested that we handle both page cache and RSS together. Another request was +raised to allow user space handling of OOM. The current memory controller is at version 6; it combines both mapped (RSS) and unmapped Page -Cache Control [11]. +Cache Control [11]_. 2. Memory Control ================= @@ -960,15 +960,16 @@ commented and discussed quite extensively in the community. References ========== -1. Singh, Balbir. RFC: Memory Controller, http://lwn.net/Articles/206697/ -2. Singh, Balbir. Memory Controller (RSS Control), +.. [1] Singh, Balbir. RFC: Memory Controller, http://lwn.net/Articles/206697/ +.. [2] Singh, Balbir. Memory Controller (RSS Control), http://lwn.net/Articles/222762/ -3. Emelianov, Pavel. Resource controllers based on process cgroups +.. [3] Emelianov, Pavel. Resource controllers based on process cgroups https://lore.kernel.org/r/45ED7DEC.7010403@sw.ru -4. Emelianov, Pavel. RSS controller based on process cgroups (v2) +.. [4] Emelianov, Pavel. RSS controller based on process cgroups (v2) https://lore.kernel.org/r/461A3010.90403@sw.ru -5. Emelianov, Pavel. RSS controller based on process cgroups (v3) +.. [5] Emelianov, Pavel. RSS controller based on process cgroups (v3) https://lore.kernel.org/r/465D9739.8070209@openvz.org + 6. Menage, Paul. Control Groups v10, http://lwn.net/Articles/236032/ 7. Vaidyanathan, Srinivasan, Control Groups: Pagecache accounting and control subsystem (v3), http://lwn.net/Articles/235534/ @@ -978,7 +979,8 @@ References https://lore.kernel.org/r/464D267A.50107@linux.vnet.ibm.com 10. Singh, Balbir. Memory controller v6 test results, https://lore.kernel.org/r/20070819094658.654.84837.sendpatchset@balbir-laptop -11. Singh, Balbir. Memory controller introduction (v6), - https://lore.kernel.org/r/20070817084228.26003.12568.sendpatchset@balbir-laptop -12. Corbet, Jonathan, Controlling memory use in cgroups, - http://lwn.net/Articles/243795/ + +.. [11] Singh, Balbir. Memory controller introduction (v6), + https://lore.kernel.org/r/20070817084228.26003.12568.sendpatchset@balbir-laptop +.. [12] Corbet, Jonathan, Controlling memory use in cgroups, + http://lwn.net/Articles/243795/ From patchwork Thu Jan 5 13:16:30 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089858 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id D661DC3DA7D for ; Thu, 5 Jan 2023 13:17:08 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 4C3778E0002; Thu, 5 Jan 2023 08:17:08 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 473888E0001; Thu, 5 Jan 2023 08:17:08 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 33B728E0002; Thu, 5 Jan 2023 08:17:08 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 233148E0001 for ; Thu, 5 Jan 2023 08:17:08 -0500 (EST) Received: from smtpin05.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id CDC7E160399 for ; Thu, 5 Jan 2023 13:17:07 +0000 (UTC) X-FDA: 80320796094.05.FAC4333 Received: from mail-pj1-f51.google.com (mail-pj1-f51.google.com [209.85.216.51]) by imf11.hostedemail.com (Postfix) with ESMTP id 18F8840002 for ; Thu, 5 Jan 2023 13:17:05 +0000 (UTC) Authentication-Results: imf11.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=BAV6F8Yr; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf11.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.51 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924626; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=wkiZx8G6kdpCzam2vHq1Krq/P436bxFUUtcX4wR/YOk=; b=2jjF89s2vJvtbmF0lueShfpPUYguOpz03+sQZ2pWil+HdYFGlu3esqiAe1HFfEQ7GUGI9s E3J/0MFtY6rNssbKhu1nTjQjNSv7PRdB9q//yho7xrZzVn397ijwPNDt7iL0BkRTYqmjzJ inu3LMlp1y4hOQADa8FvCZ+9ygOSAK0= ARC-Authentication-Results: i=1; imf11.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=BAV6F8Yr; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf11.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.51 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924626; a=rsa-sha256; cv=none; b=AVLLe+O4+pfULL/ADA18zg/YIz4ZVKxHEInoaRigeDVMN2iMtO74ITZGaYy3QVFzqMK2Hv d2Zma8o7iDWMCLcIw50dMEh/OYdpRcN13/V1kktj/ltiqAqh8YxcGZgrdNqIaso9DMMCHh Wt+uZEmpm5dg7aN0aR8hXWfm8sG7DYI= Received: by mail-pj1-f51.google.com with SMTP id o7-20020a17090a0a0700b00226c9b82c3aso1982141pjo.3 for ; Thu, 05 Jan 2023 05:17:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=wkiZx8G6kdpCzam2vHq1Krq/P436bxFUUtcX4wR/YOk=; b=BAV6F8Yry5m7pE15IbeDN664RrsiJsNm9vbYob0JFJ2Ju/wOA0FWzzb/8xhmm9hA7C v/izEcjV1ZWW0M0eYpLFDCeiib6kON4L2EJObpomid/HgCPtHZuwpF/MZbVzgOOMVBxA 2eQ/j3CEQDk9/feT47ZDi8n0VmyCnOLONMBO9N6B87pyCEjB3dZEEQGjkaaTnHQVfsB1 9iSMexDvgOSQsSASKop+FTY3ugsqALhgHQCstrTJtedG0BviKysorT5ivSoL2VR9qTuN r2nMIplNNT4c3bC9AXof2DUjXncmHxPhxjzVUz8sHd3mIA/hwGrQAcq953i+u4hITGhc hlaA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=wkiZx8G6kdpCzam2vHq1Krq/P436bxFUUtcX4wR/YOk=; b=njidaW0jESqu5NRwa4Kq3Ca0p+DLszu2Ezqkrv9ij0Xiudk3qEBm9jV5LWvKa+2NVc KZxyXtG9Q0dvthIQjia5CqVxaqhxDmTeowV5/TKl7smNBAtCYLWp5gC5WiDvlsmXCLIm kP769XYCIDdAhtjUH8oI//cZrRKPY0ZDmpMsHme++iXmDejw4T/FVTMDDXTBSfx0mNOK lj0jEEGjseeFmOQGbfAMj1Kc+OQLCSUbOLA+lXV682fYzt/BSvog504UTusg3PgooQv+ GemlZEz5lkiMK/gyxcqqlu928l5OJ+7qTZjJcMfn9ZGcHtLgVgfYnPpwvCQbksrl7tJA bthg== X-Gm-Message-State: AFqh2koZc2F40SKTXlE+4sw8UWo63VtfbOOffZ3ar0xe9NZ65r3cVSeh 43E/HgYsDrnJ+i2qtZlrTdM= X-Google-Smtp-Source: AMrXdXvU6JEa6Mo8Z3q8vgd6itpg+H+sn8AbZc7dz53eHdr8Dq6kKktbkfhRPk9Vf4cl6fO4pJiFQg== X-Received: by 2002:a05:6a21:9218:b0:9d:efbf:787d with SMTP id tl24-20020a056a21921800b0009defbf787dmr61323421pzb.50.1672924624917; Thu, 05 Jan 2023 05:17:04 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id w1-20020a1709029a8100b001925c3ec34esm25318972plp.196.2023.01.05.05.17.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:04 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id E8F10104732; Thu, 5 Jan 2023 20:16:59 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 5/9] docs: cgroup-v1: move hierarchy of accounting caption Date: Thu, 5 Jan 2023 20:16:30 +0700 Message-Id: <20230105131633.553574-6-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1218; i=bagasdotme@gmail.com; h=from:subject; bh=TtcaCybTo5E7/N6tLTMu/WowHmwrmC15HAxU0Etkee0=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzm6QcbE4K32OSZZjtpvtW73vYXYp6j8ub5d/5Jc/icVt 0/PJHaUsDGJcDLJiiiyTEvmaTu8yErnQvtYRZg4rE8gQBi5OAZjIoiCG/67NdXrclae/rl4qPj1HKP 1KjaXzB8dJLA0uxtGtGaKxdxgZHjisMcn4dnP232h9H7YC7h1W0yar8uexCGecca19c8yFCwA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Rspamd-Queue-Id: 18F8840002 X-Rspamd-Server: rspam09 X-Rspam-User: X-Stat-Signature: hoyxwzoq7hiej9qp1cpthicdr61sa9xf X-HE-Tag: 1672924625-235593 X-HE-Meta: U2FsdGVkX1/fi2zTbbJwAH8MUaLezBkCYj1O3kv8ssB+pwHjVOxIRhvAAaljiognlFMIaFcAiHiO6cKH8MtcuMe5254PCo2kK0vYIpc3xLa0G7UHosutVN1qIDkUYerbKLV/YhFL5OsiEkPSim0yk1qyadJp1igrROROQ9VwvnR3VYxyBdoQSqtfkbUUiRYUm9VIAEdrr4hmr1Ohw2pnz9pJQCgSWzjAAoQRFQhN6ZV6Bbm5mBPI7ILa7fQhonhupSbDPy4E3P7F6b7T4nXYaILLETz6FmT+q7ns1UDD65WrM8tV4GLSb9FHjGP94wxTZoXIT3hLT/UNg+gOIMGgqf0CXEiSyHPJa7oK422Lkx+9Uw/uL4wi3dvkdH02aE+kdePqZaSlJ+o+Ra2nbjHDmTf+QYnXz6Ef62W21aD3yuOpvAZcOvQBB+gRmjMaM4kqboCqXE9T7n86v6pxE/MzC6gjE4uzPoBMMGpXJ+7qhSzodb6uoOUWgF/S+1Lmf2grEe4uqYO26nriBRCEHkWB5u01pVNdAUPtaHrl0DDQwdGymIfFoztyDw6fXkfWiKpAXsFQBNzxbCbw0ox1fPdv2s7OodsWzh80tMFLtjh4gZD6cODwXLOOUG4pGswCOO/hctUnzTZi5FwrwJ5ZijyPvrDh9tsCtHeWoZXfPpmE9QBzdSw/Fxz1vpwa3Foj3iCWD4/f07TuboY2Ozte07S0z0IbH8h61Yxh7fFkr0iJO9wQbHwJIePelFGRqPwJG/ejv7L6u8xYgdeya/RGbr/tWGh3OU3A2aj/uEGSa6wwK8Gr2Ww89ikNnO+tS7ZH5YHJCW5tYfVYd37cFxAL6d34zTPJnzDO1ibKjDFO6Fp8L7U3QGgLTy8cn3Htym3DilQ4zQB+SFhIwkCNLlx2xY2lQppQN/7GiaUK3fXCA+05Sv9x7Iqry8+Z+6a7UGqxRo9dHlyOgUTbZPG9BTdETVJ sAPUCzin WLeFRsrXkZafRmxEoKYg+WUQRv+uOgZcjzD26btVd1Ekz1QbI++u7yuFGe6JDtHpl9Z6QCnnqfGkT4lsudGQUYTTTPFiOSCUUA+DuXj6yzj4aQBZlDjZZGphaDdpr9T+F3qRF X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The caption for hierarchy of accounting figure is in the code block, which is quite odd. Move the caption into :caption: option of code-block:: directive instead. Signed-off-by: Bagas Sanjaya --- Documentation/admin-guide/cgroup-v1/memory.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 8d1cedcf44f6ea..4d96a5bbbfcfdc 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -147,7 +147,8 @@ specific data structure (mem_cgroup) associated with it. 2.2. Accounting --------------- -:: +.. code-block:: + :caption: Figure 1: Hierarchy of Accounting +--------------------+ | mem_cgroup | @@ -167,7 +168,6 @@ specific data structure (mem_cgroup) associated with it. | | | | +---------------+ +---------------+ - (Figure 1: Hierarchy of Accounting) Figure 1 shows the important aspects of the controller From patchwork Thu Jan 5 13:16:31 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089863 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id AD33FC53210 for ; Thu, 5 Jan 2023 13:17:15 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 53B7F900005; Thu, 5 Jan 2023 08:17:11 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 49D2B900003; Thu, 5 Jan 2023 08:17:11 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 314CE900005; Thu, 5 Jan 2023 08:17:11 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 24158900003 for ; Thu, 5 Jan 2023 08:17:11 -0500 (EST) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id DDACFAB3E4 for ; Thu, 5 Jan 2023 13:17:10 +0000 (UTC) X-FDA: 80320796220.06.940D159 Received: from mail-pl1-f179.google.com (mail-pl1-f179.google.com [209.85.214.179]) by imf17.hostedemail.com (Postfix) with ESMTP id 0D6114001B for ; Thu, 5 Jan 2023 13:17:08 +0000 (UTC) Authentication-Results: imf17.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=I+haejsb; spf=pass (imf17.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.179 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924629; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=xwHqK93GBSz13u5EOGerS6VNG9qcHKdmktoqbjmWNKQ=; b=XLir7458Q2xGik8Py/+kHp6puqJcQVngH0pKcAvv82fCATYTWYjEBuOLmbdDzXQXrz5G5m N4+0/RwqAg8UeD9P4Cw1t6v4fneYCLbK9V/p0Ecb7c4M/fJ01KJzO2lYX8rPWN6smZp4ct BzXBQQNz6Ysur98EVqXMBmeApBxs9p0= ARC-Authentication-Results: i=1; imf17.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=I+haejsb; spf=pass (imf17.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.179 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924629; a=rsa-sha256; cv=none; b=0kmEI0OeI4e9UhxPIa8PyCDfvesd14SjhsHduNVxzJH+mu6eIhIT+kVbdYqX3Yvaqgd8Ha ri6N00VZOoljlk2PFw02HlKt0HTG5cGaWgGIllD1mK/ecjgeZ8A5a5XlK2tnMAAas2aol8 QLxPkW8SoOjNhcSeTo5NadT/5mx10FY= Received: by mail-pl1-f179.google.com with SMTP id y1so3797825plb.2 for ; Thu, 05 Jan 2023 05:17:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=xwHqK93GBSz13u5EOGerS6VNG9qcHKdmktoqbjmWNKQ=; b=I+haejsbxcT8QansUCm5NiZgqf2JOyk2XoX+L9ANWJ+oZ3TVmy88uTaaDIAnH60Se4 QC+8pZ1DVABAn9fbxX+01giMJL8QxVbK5JPMK71xZAR5l7hIoZ2HXOLK7XsTFATW8Ixz q5RKiApAiRwuaEXAif1bny8NJyICU1d5b6cBVkt8ozpHIt9kHXCkiP5RwaeGheITxLGD pv66I/8vKCfVNCU4pCKkHXOn0aYd0sZ7fEE9fRKjDaTaPdM6tDTlOWpzJaqe86/t7zq+ J5IuSSFoT4VVRLtFO79+qqLr4ipbuvJqdL0XtgxljHoOaC9wrD8egICm691ltJy92+D9 o4lg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=xwHqK93GBSz13u5EOGerS6VNG9qcHKdmktoqbjmWNKQ=; b=JOvR1yi/h+NOs8/63W6uDH0N9vJRAZR6gCTHOKXTQvLont8J+ZM3DCXKbMfy7ZjupX RlX4b6gw+N/0cuMOL5wlj9r8fEWXM+7zfBlGWFUq/cNqPPX4tF+Cs+9TsJk0y/r/UlJ/ VsetDsNvki8mpF9at/E+tPZZvgN6itTobjgcrTc0K9ixC5emylLvpVFXLe6oqXpnry2E Wmve9r9umoHZWir9A8d7KeR3ywPTEDQpyMNLzElDOiYrn+6Bj8S83xtJ5m9Hk3d4TxRX aNEoSiBqu6iNuzyke7OXcrkhDrnqn0CNLSodBMaBBDWYdPuCEb6zk+fsIb41Hcd15S3B wfCA== X-Gm-Message-State: AFqh2kpG6qYDpWIxD2M9x5LxRiepwTQRECEEPcJEawM6FPsnZ4munV+W Ms62Lt/cJSAK7CwGJaDkpGXivtFyGok= X-Google-Smtp-Source: AMrXdXvVQHFIAhZFjXWcvmWsd4zYjHp8TCtZNuDhrgXiXGz/KDF8sgcU0cuj/xK31xQp+cbn98HKDw== X-Received: by 2002:a17:90b:4a8c:b0:225:a8f2:fa38 with SMTP id lp12-20020a17090b4a8c00b00225a8f2fa38mr51004080pjb.21.1672924627951; Thu, 05 Jan 2023 05:17:07 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id h6-20020a63c006000000b00478b930f970sm21709710pgg.66.2023.01.05.05.17.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:07 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 2BC92104C58; Thu, 5 Jan 2023 20:17:00 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 6/9] docs: cgroup-v1: use bullet lists for list of stat file tables Date: Thu, 5 Jan 2023 20:16:31 +0700 Message-Id: <20230105131633.553574-7-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=6795; i=bagasdotme@gmail.com; h=from:subject; bh=SoIEcDdcT5n5ldqzkBmfedkjJd/EdMw6QuqYA3S+KDs=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzm6ofK+yRrC/JWDHq/r1ulxRxxxnKLB3/v5w8IjPvxk1 Z7pEOkpZGMS4GGTFFFkmJfI1nd5lJHKhfa0jzBxWJpAhDFycAjAR325GhpZFRVP+NhbwxQf07X/ULH dQqH2NpZHRx3nVQsUaj+IvuTD8z7n7YJ5tTpdh076r6d6G/05xbVAXtfb+sau3RtPG+o4bBwA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Rspamd-Server: rspam05 X-Rspamd-Queue-Id: 0D6114001B X-Stat-Signature: io53frg6esxb4wf6g5xapkac5nd6crnt X-Rspam-User: X-HE-Tag: 1672924628-542779 X-HE-Meta: U2FsdGVkX18NDfq2BH83ixQ3xI5WTCbBL5xEmlmW5jfwoZFmZzHvwz2C+KU6GZGoHD4MCEyo/FLFGjiCrYpb3qMdqSmNa4iaCPL89aiIFZpp8p1yxVAI6gr6jdAbrnHVIkD1YpPry+UfWTBofJf6SvFN0SC2Kbxtjedn5d4ytfgrcE7VjQc9agzkW34l+9G0HmM6U1VKJoDh/eNGqCTzVykEef6LtOiv4xhzNVJ+KeCN2iA7kJLR8FAbo0No5qmu8ioXdkSM5sF9wx3RRHoxrN5yCab5CoNfdp8ODFDFMCRuQxqdr5dlDO5BRRktoV/w2kcdUZa+IACPGudtkzlaLUSbLMbL+43hQdf074yBQJaQ1vgxywoUK7P1CHLlkCcO/yXPebNgqxn7uUFPr0oldewQBxmE6MAP/eH+FPZY581kRlPkP0zyq6HWAn+nPO4cQlpohImfeNMeEQnyveKiqbB8u+bGtzRXb4JITyNe16QgAqx6hof5eluYO7BiW6WnojNgq2ofKRL5+1LZEqykcpubmrXpjN5oXoKvmzND4/HsfGqr4ygtmkz0FMHdyoldzUikw/3ZfqZKH4yu7+0+GecSfaIv3yUx+SIjW9KnyFWHYGAFAgMjP27uWZ0IYAd6cgvYNN5rx44gMhs5gd09AW32lvzWs9A3hHs+cE4bLKPMibLDqXzQ4wmsNvUpqTqpBfK5sH1cDnV0BIu/ell+9l25bop1BTQz1gSgmdin3pGREsqBIcE02bL6fQvt2MPpKxxOvHBkwJmSLWHLY4IMcYW33GpV6KJaHXQd5PgiyRFOlHZd9MVcap+IPMf/wnY7SQ+pQhbumRxiynppa2eBXoV2JRYCMg+VB2LnL3q7GTpMLNSYpSQ7RTNeHFPDbNuxEkgMMAat6rgPGLjxdPjTGfa9AbVoedks+CDbsuFGUDg68KrhIhiOl7QaGB0ag1y8kU/NWMgmmUjVcFczCCe Dx6xWTZG FxxBnEEVhdp0Ob24gTjg6I7+swz7TMIjnjuo5PmBosvOMjnVQ4nZ+aa/8P7q2FGEElpW+vp0cgiWVm4RnkFGlGrFPFduLE/Sel+cdQZAzP+3zVw/MnGjiYMPFicfq4+VlzU7q X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The stat file section contains three tables, where the leading texts for them are subsection heading. Organize them in the bullet list, while demoting headings into normal text. Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/memory.rst | 93 +++++++++---------- 1 file changed, 46 insertions(+), 47 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 4d96a5bbbfcfdc..162cc26dcddb25 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -519,60 +519,59 @@ will be charged as a new owner of it. 5.2 stat file ------------- -memory.stat file includes following statistics +memory.stat file includes following statistics: -per-memory cgroup local status -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + * per-memory cgroup local status -=============== =============================================================== -cache # of bytes of page cache memory. -rss # of bytes of anonymous and swap cache memory (includes - transparent hugepages). -rss_huge # of bytes of anonymous transparent hugepages. -mapped_file # of bytes of mapped file (includes tmpfs/shmem) -pgpgin # of charging events to the memory cgroup. The charging - event happens each time a page is accounted as either mapped - anon page(RSS) or cache page(Page Cache) to the cgroup. -pgpgout # of uncharging events to the memory cgroup. The uncharging - event happens each time a page is unaccounted from the cgroup. -swap # of bytes of swap usage -dirty # of bytes that are waiting to get written back to the disk. -writeback # of bytes of file/anon cache that are queued for syncing to - disk. -inactive_anon # of bytes of anonymous and swap cache memory on inactive - LRU list. -active_anon # of bytes of anonymous and swap cache memory on active - LRU list. -inactive_file # of bytes of file-backed memory and MADV_FREE anonymous memory( - LazyFree pages) on inactive LRU list. -active_file # of bytes of file-backed memory on active LRU list. -unevictable # of bytes of memory that cannot be reclaimed (mlocked etc). -=============== =============================================================== + =============== =============================================================== + cache # of bytes of page cache memory. + rss # of bytes of anonymous and swap cache memory (includes + transparent hugepages). + rss_huge # of bytes of anonymous transparent hugepages. + mapped_file # of bytes of mapped file (includes tmpfs/shmem) + pgpgin # of charging events to the memory cgroup. The charging + event happens each time a page is accounted as either mapped + anon page(RSS) or cache page(Page Cache) to the cgroup. + pgpgout # of uncharging events to the memory cgroup. The uncharging + event happens each time a page is unaccounted from the + cgroup. + swap # of bytes of swap usage + dirty # of bytes that are waiting to get written back to the disk. + writeback # of bytes of file/anon cache that are queued for syncing to + disk. + inactive_anon # of bytes of anonymous and swap cache memory on inactive + LRU list. + active_anon # of bytes of anonymous and swap cache memory on active + LRU list. + inactive_file # of bytes of file-backed memory and MADV_FREE anonymous + memory (LazyFree pages) on inactive LRU list. + active_file # of bytes of file-backed memory on active LRU list. + unevictable # of bytes of memory that cannot be reclaimed (mlocked etc). + =============== =============================================================== -status considering hierarchy (see memory.use_hierarchy settings) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + * status considering hierarchy (see memory.use_hierarchy settings): -========================= =================================================== -hierarchical_memory_limit # of bytes of memory limit with regard to hierarchy - under which the memory cgroup is -hierarchical_memsw_limit # of bytes of memory+swap limit with regard to - hierarchy under which memory cgroup is. + ========================= =================================================== + hierarchical_memory_limit # of bytes of memory limit with regard to + hierarchy + under which the memory cgroup is + hierarchical_memsw_limit # of bytes of memory+swap limit with regard to + hierarchy under which memory cgroup is. -total_ # hierarchical version of , which in - addition to the cgroup's own value includes the - sum of all hierarchical children's values of - , i.e. total_cache -========================= =================================================== + total_ # hierarchical version of , which in + addition to the cgroup's own value includes the + sum of all hierarchical children's values of + , i.e. total_cache + ========================= =================================================== -The following additional stats are dependent on CONFIG_DEBUG_VM -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + * additional vm parameters (depends on CONFIG_DEBUG_VM): -========================= ======================================== -recent_rotated_anon VM internal parameter. (see mm/vmscan.c) -recent_rotated_file VM internal parameter. (see mm/vmscan.c) -recent_scanned_anon VM internal parameter. (see mm/vmscan.c) -recent_scanned_file VM internal parameter. (see mm/vmscan.c) -========================= ======================================== + ========================= ======================================== + recent_rotated_anon VM internal parameter. (see mm/vmscan.c) + recent_rotated_file VM internal parameter. (see mm/vmscan.c) + recent_scanned_anon VM internal parameter. (see mm/vmscan.c) + recent_scanned_file VM internal parameter. (see mm/vmscan.c) + ========================= ======================================== .. hint:: recent_rotated means recent frequency of LRU rotation. From patchwork Thu Jan 5 13:16:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089865 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3BE5DC53210 for ; Thu, 5 Jan 2023 13:17:18 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 4270E900008; Thu, 5 Jan 2023 08:17:12 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 3D9E6900003; Thu, 5 Jan 2023 08:17:12 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 2C73B900008; Thu, 5 Jan 2023 08:17:12 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 1F8DF900003 for ; Thu, 5 Jan 2023 08:17:12 -0500 (EST) Received: from smtpin03.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id BC2BE40458 for ; Thu, 5 Jan 2023 13:17:11 +0000 (UTC) X-FDA: 80320796262.03.5C387E2 Received: from mail-pf1-f180.google.com (mail-pf1-f180.google.com [209.85.210.180]) by imf03.hostedemail.com (Postfix) with ESMTP id EB7D520008 for ; Thu, 5 Jan 2023 13:17:09 +0000 (UTC) Authentication-Results: imf03.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=lsPMxNWn; spf=pass (imf03.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.210.180 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924630; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=rGNG7VnZJT5NrQNN6BhNmvq0EdhUnj+GOmFvACaLTXk=; b=RHCRKhXbAwI7G3b9PLLIa6iA4apcQtX+MwnhchnN9S9UwbnVvv5xo12FAhTpSKgkR9m4sd wgFxENVYBksrIz/wJYAWtY+rivLiDTUYcDkV3ljzbrlqj2os+FzHXhSPdj5Y+H162AmU3P Xmj5as/xKD13m+HG/qefb6HtSeUXtpQ= ARC-Authentication-Results: i=1; imf03.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=lsPMxNWn; spf=pass (imf03.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.210.180 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924630; a=rsa-sha256; cv=none; b=xQgYNiPiQ/etVYcN91Vm89+wfNFBFEUeGuCS0AiC5cYteh4I78r6gQndtiEiL2m688a3fj ojPGoEF2VAgALwanKU+y9FfiGWakb1LSj+oKTpCcUDVfmkbuQDr4x5yjvl06UJ7nSt/Xzl vvjPP+qpo9LSwk/xP5y7HHseW4in+Fk= Received: by mail-pf1-f180.google.com with SMTP id w203so8651885pfc.12 for ; Thu, 05 Jan 2023 05:17:09 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=rGNG7VnZJT5NrQNN6BhNmvq0EdhUnj+GOmFvACaLTXk=; b=lsPMxNWnGO17JgyijK7xfpZgFbuz6KdZizssrHuAy+1vnSLEkHZ63zNwolvfA1EZEs Yopw5rWH6hUbO2tHXYC4UMNhlDh78F3wuO5FOS6QUvLG84FLyKpKHbp7hgUK0mrDE266 XFK59lSLCDz2YVDChTwwU7qUKHhu1uIN5laO41h+2Xb5hv3qgLeG3wzzfnlc0bTq9PX3 B9H6zlDTXgbwY9BgPwwxV0LscCEfKgt5D2hFe+ZZT8ELPkfmsPIC1zLGoCFfwT9ptYRJ OiI/zEhACIbeIQZj4gX3ZNOIZWwBHgLZd5nSmrNibY2Y9ohvzqWNBRiWXIYx71tYtErD dHeA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=rGNG7VnZJT5NrQNN6BhNmvq0EdhUnj+GOmFvACaLTXk=; b=oolYbk4kPxm56+9vKanPJ8udCtk/7pClJXDV3LwaBTXWfrWyXlL77xuroa9BO5FZAJ B2goJ+cgiwCqOCldpB1xIkZWGQT4tnzh3nH3XhMWe8qrM9Bzn5K4hmLDrUADGv9i6LKI lxw49l2Bz5J4ITWW1uTMy/eZhQWBH/h7mRVFZrjXn3yCDssruxlA5RjzzZQJbo5Bz08q 6bMndfZfbwQ7SVBNJtR5spSvNHljzyCb4jce2GZx4znm0LjVsMYtgF/rwGVv0pI7pWbD ptorQli0fMfg3bbnVEgtglFVOud5OCfe7FFI1+TyTfM3SpRg2FbXa3tRm/f/kI/luZxa Mn2Q== X-Gm-Message-State: AFqh2koB7BN3VV9KIuSNL3vIP2TeittZ2O7gUXBG1scv7v5MHwicgiFS 0CWlZx6cDvVAe9DTeB1wKnY= X-Google-Smtp-Source: AMrXdXsYhU5SvLd2MIx5+aPldA/gYIlM29jQgf1iNhKcsHwH0/UyoUf4ASexAZm03c0nXR9s3Xbllw== X-Received: by 2002:aa7:94b7:0:b0:583:a62:d840 with SMTP id a23-20020aa794b7000000b005830a62d840mr4575121pfl.29.1672924628904; Thu, 05 Jan 2023 05:17:08 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id t6-20020aa79466000000b005772d55df03sm13996299pfq.35.2023.01.05.05.17.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:07 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 4464D104F98; Thu, 5 Jan 2023 20:17:00 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 7/9] docs: cgroup-v1: make swap extension subsections subsections Date: Thu, 5 Jan 2023 20:16:32 +0700 Message-Id: <20230105131633.553574-8-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1657; i=bagasdotme@gmail.com; h=from:subject; bh=uE+t77fun6ccoXEmhoP8hbo16qhF0xOO2tCNjGXW6A8=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzm5YGvPgaJDfiTkV7UzLnq4MEK/bPdWvcsokjUbebY/v rmbK7ShlYRDjYpAVU2SZlMjXdHqXkciF9rWOMHNYmUCGMHBxCsBEqp0Y/ulb/hKJai3vXfLFNSWXae H1vUlBd6u7eT2tliVyViYL5jP84arouyobqPV75r2/0RX/O3V5z9t+3Sd1Y83q6smtj7ZZcgEA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Rspam-User: X-Rspamd-Server: rspam04 X-Rspamd-Queue-Id: EB7D520008 X-Stat-Signature: bx1cj95oy6yudoo74pd7s8okfs4cbdt3 X-HE-Tag: 1672924629-780904 X-HE-Meta: U2FsdGVkX18syHXyOIcT2BGxTG2MehqOhGPj9nBdxVORT/3HP4+8LZ6GlcnTkOgJv+9cggnRK0WYOMpM0slsgMeRFatpXeGchwErM6UBul5HHMNgFTwCf53bEGVHEGfSKiWJqPmcQiwJXbqIyvrkfM/N2qOdmIRDttqtcUEPYOfCheU917gb1MEdoyBshC6o5p+Qaj0gxSuvQfUMTiiP0XZGktngn9Po/nHuGKndbFM9ukQ7PMcJSDoB/BHWn9sQjeSMeKD6CNDnf+A7sO3m6Avu67NCVaeKm/t6iLRnQpMgb6ud+5xVvcpMIDPq6nM81A3VPSczkIoBCZRKSKIi3GtDHL7cVQnUN2A4+TDBdOfiGT16v5ldUk7qUm/aCI/ubXgJ27hEx4cl/I743+8RMUpbNjGgEmskfA1dRsRFHrMrl/mvGkU6XWoynqpMV56uJuiovuWBkfP0APWiYTiDFby1scwvzc5YrLltTJDTRpEGA7kp9xwGLW+DOmB62gRDecdsSNnAoglgMy8mfiaTLQE+IJThG/SzwV3FCLB3bsiWloCfXSoNbQbtEUwsvQ/rPXn25GpSNHuQqX6fmpJ6652KadJ/9wB4VBcTC5mO7xi8rALBCxb3eMAw5Nr8J1nR2Shg06y4UvrcStk2hnprnNkPPssNZe1ztTnDmH3hiF9GQf4KvnzN4oY27cpr04LOqybYI5MPKw4feWymdFWDyxUI8LCCLWt9JLKCHh+VpYeoVuTsViOEs8ijxce4r/DfnOPTUXgDGJuoQQsS52R/t20SyQfxkaSlkLU1gQ+m1kE0fSkxP+rPRf/DB7KFv9XvFLuN5HpqACDABpVxI0WvyPcladN65FZY8zC/jzEqM9fWFsYyal5FvJLyaijGtuBw3NorwoBRIgHV2hnIEOQUoynXS2JM169egKTxwM3KNtvsinwKqpWi/Pp994Syznx2Dbhxie2oLqD4vTNlUfD Tr0pWrpM vfJnumyIQiEdSg/aUgz2n/DpLakbpjEVl9U0pIH5gyrY3CkAUk5FF/TcA2q8KzTf23/4Dlol9NeALz3ug6uu9MQG7AQmpkVp/idFjhkEsZ21r+t1gGb5Rig8eDtsf0G2cqj+v X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Subsections text of swap extension section is marked up as bold text, whereas making them proper subsection is more appropriate. Signed-off-by: Bagas Sanjaya --- Documentation/admin-guide/cgroup-v1/memory.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 162cc26dcddb25..0e583a6f783955 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -244,7 +244,8 @@ In this case, setting memsw.limit_in_bytes=3G will prevent bad use of swap. By using the memsw limit, you can avoid system OOM which can be caused by swap shortage. -**why 'memory+swap' rather than swap** +2.4.1 why 'memory+swap' rather than swap +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The global LRU(kswapd) can swap out arbitrary pages. Swap-out means to move account from memory to swap...there is no change in usage of @@ -252,7 +253,8 @@ memory+swap. In other words, when we want to limit the usage of swap without affecting global LRU, memory+swap limit is better than just limiting swap from an OS point of view. -**What happens when a cgroup hits memory.memsw.limit_in_bytes** +2.4.2. What happens when a cgroup hits memory.memsw.limit_in_bytes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When a cgroup hits memory.memsw.limit_in_bytes, it's useless to do swap-out in this cgroup. Then, swap-out will not be done by cgroup routine and file From patchwork Thu Jan 5 13:16:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089866 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 94999C3DA7D for ; Thu, 5 Jan 2023 13:17:19 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 90D01900003; Thu, 5 Jan 2023 08:17:12 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 7F74F940007; Thu, 5 Jan 2023 08:17:12 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 69738900003; Thu, 5 Jan 2023 08:17:12 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 5B2DE940007 for ; Thu, 5 Jan 2023 08:17:12 -0500 (EST) Received: from smtpin26.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id 3DD331C641F for ; Thu, 5 Jan 2023 13:17:12 +0000 (UTC) X-FDA: 80320796304.26.F3549DB Received: from mail-pj1-f49.google.com (mail-pj1-f49.google.com [209.85.216.49]) by imf15.hostedemail.com (Postfix) with ESMTP id 5EEDBA0012 for ; Thu, 5 Jan 2023 13:17:10 +0000 (UTC) Authentication-Results: imf15.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=U+VJkAFN; spf=pass (imf15.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.49 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924630; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=hZ9GcmF0SnvXW339uzqqW2SQ7HsUGzXwW7yu3PaudLI=; b=eX+UuQfuZ0zwA+fJneDBKVaEXl+WROZWqP7UdAq//o+NuNfzVpGqVOxXnlALp8+FM4gLDs Z5qmT3QCRVb464Hme5kzn9kbgodUdNbLyVMv7WQIMSPMb4K0WeNFd1aLCXesdJVyZNYCgT XcqvXHIdhbVy2uzS3Ke+gePPOZPWjqg= ARC-Authentication-Results: i=1; imf15.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=U+VJkAFN; spf=pass (imf15.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.49 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924630; a=rsa-sha256; cv=none; b=qHPKO/OIKPBx5jaruuSi8kN3JAq79x8Lpv8gQXoVjnH+61lawXO/wOAUEyKWf5d+nzgpGb sCPrSCvzHDXjLubwQz1bvho3c3hdbqc+Tyb64K1mNtWDUrblqn9XuenHLlFce7grk4LsHu 0Tu6q+37q5ou54ZSkprqqPSLDTI+ShM= Received: by mail-pj1-f49.google.com with SMTP id cp9-20020a17090afb8900b00226a934e0e5so3359655pjb.1 for ; Thu, 05 Jan 2023 05:17:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=hZ9GcmF0SnvXW339uzqqW2SQ7HsUGzXwW7yu3PaudLI=; b=U+VJkAFNPjKrvuGxUMG5FdK9BV2Zgpcr6N9Kl5CPf4JeKfIn3KcOiVA/VaAvD/v8AY wf3WOuiW7daaqG5zzM3ETBToqjQQZz9HO5Ch4s0bANKwqUGuYM7mpR1Cit+3+7OZR8uG llwNqAVYDTx6gKxaENyWQWVdcNTdJRTlLX60QpIfRnldj8L8WzvSzhjOj4O/IkchuzPD +TfEUpebH94+kSE9jQgYutOw6TAh6iS7on3MOT/qMSBjURg0Wv27l73QYTWa7630M7Gf rOUrmvszK+8FStFKklPRi7svReL6kUOvahUeFEAq5VlPPUv7TglqIuiXRXh4AmBCFf7C 2Qog== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=hZ9GcmF0SnvXW339uzqqW2SQ7HsUGzXwW7yu3PaudLI=; b=L/dWJDUvFhOymvKP8ASqGsGM+pxIMLx8+bitlmoSR6VEpK/Geo8KvHA9s2nmCvCloK zLS4RUzrtzxWuxIoGuNMF/Mico40bLtTeMu8k2SHPUk9a+TD8o7ndhPQkRzXYZ01or5o NLtQRyvCXJ/kyUQ43pZ/KzLlD4OrjeleoKSFc3S+WBE+eVxCiNorJgh9Dwq4gySrtZZi G55eFHaSFhWFIHYT2bWd15aC5Wk+DlYvkHVq5xkEyA4NgPUBeQ21CrY79tuEj4sYf6ST XXGmuUiD2CsltxYoM1tz4BLxoOmDk1VvvNHMd1vJD/vweTOhP0eHqVTj1HFPpk9+D/HK C9NQ== X-Gm-Message-State: AFqh2kqnvUi3eBZanhOa03vn/8oHpcGCf4BRN9wFyvwotMwHEXktUGsZ XfQawjMsCpg3q+Y64/TrLX8= X-Google-Smtp-Source: AMrXdXuHu4fwzgNkBxVRhmF9kMBUvwsG1omHZBNxm+MdNdBHvtO8e3QpJvmHXUlPxH0xkoMG30Dwaw== X-Received: by 2002:a05:6a21:3989:b0:aa:4d33:da52 with SMTP id ad9-20020a056a21398900b000aa4d33da52mr83542173pzc.1.1672924629286; Thu, 05 Jan 2023 05:17:09 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id x124-20020a623182000000b005779110635asm24590744pfx.51.2023.01.05.05.17.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:07 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 62D611051E3; Thu, 5 Jan 2023 20:17:00 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 8/9] docs: cgroup-v1: add internal cross-references Date: Thu, 5 Jan 2023 20:16:33 +0700 Message-Id: <20230105131633.553574-9-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=5899; i=bagasdotme@gmail.com; h=from:subject; bh=6uN0MOlYSzf0LERTdXFXUxc79s1bXfuIBUJ4wZga1/E=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzm7kiZI55vd7j6d/afRKneXuDXeknm37tFqhQ/HExAdm qs3mHaUsDGJcDLJiiiyTEvmaTu8yErnQvtYRZg4rE8gQBi5OAZhIQDjDfy9DU701t9w8MvWV1knpfg /1duwtYk6KsO957npefGftNEaGhx8mMzp0blnuy3c24tG8i2UlhjYSPofTMvU4p7jpLArlAAA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Stat-Signature: f6tqzkqno7gsyximkgniqc7ab7xuce7b X-Rspam-User: X-Rspamd-Queue-Id: 5EEDBA0012 X-Rspamd-Server: rspam06 X-HE-Tag: 1672924630-452103 X-HE-Meta: U2FsdGVkX19dGEVw+0qf5vY9eVYGjd/Xd7hE9n5GclFpuJ7yqERGXUBxMEblPIEb86+9lUe6gBNRuVZzOlOvJOURHtkiRfar4Go+2K9PbUyforr/TJA7gcKSJI2VuZFIqid2qG+04XHhwxldMwJpcVNR+Xswvolcmgrdu0BCYpHDNuSk/W/C8KwOCYxqU/+0bZxQt6IwGaNfWbUaZE9tp6gKGkT0ijcKa/2NOm3ztajCYq86pItMCKtw1Klcj8jljAx1e0iqDcreps44mYt2/gALNELDLvLecCpl/Cz/bEPLx5BW7jz9MplJ8b26+sEZlJIIU3aOWQnyOn550DFAHtOOmKgb9ztSua5QF1pKrvNi9HMOBnoFzvdXzRUcRLqCsDBXmHr5KUjKs6dgQJexpj0Kl8sWdWzDsu06lTqdpjjHQO5TOXPp2uvPe7tvBoD8+BDB6RVZqDk96FEaHbHdaSHbSvd3rdIzkJlHZW+eLBhoFIrsGUCPG/EOnlh44OgXwBd7Ym1on659Zip+kbXB6nb9zChRfW3uCU65ieBaZgx5xGq/OsCtvb6Wn5xJj4bUayVKYLVGuYq3NlXinPo8aemr8xJzVt1pbX+Qx1twFTEJ1N1TYuVKbdAGLvsbrUr1sdZxDoW1kaNtWFdtK9R+H+wdi6N2onxysgdE6G4mww1M33V8bjuQLtHvG9hIRDlEusibo6ZWhg8YI7U0sFTWdF2Qc4MpfL+XpOOornXdDvWzaZFXCaUIZKZKg3EVjct8THF0lyStM9o7g+/OwUKxhj5A+0lMg3XltUUdV7flo7M0pyXZR+cU6cbIE6SYjme+OlE7V70mSPwox+wakai1bVxAcCFmzBSCEkeqW2FG/3C468SU8wssxCUCMcbtxP/54tBMLCMzvBO1e/21qV2b1xIAGslybHTCt6QYSm/6Ir629EyTZQ8CVn4/FT82XEnsab5cVgmqisF8JVFnmy6 1bjxqkUJ eqVyM3PUHTeBojOVyoGGXDIVeqAhr0w8LrzjczHHABlE1EGL/fVLhi3iefWHQZWad3LhJeZIGQWUAww736ihAr+AgbpTEPW+UowYqwvCNviGiKNRflHXrGEWr2CMW7ZqvQkUs X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The documentation contains references to other sections in the doc (internal). Add cross-references for them so that these can be accessed without having to manually search for them. Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/memory.rst | 43 +++++++++++++------ 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 0e583a6f783955..16d938abe69f81 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -55,7 +55,8 @@ Features: - Root cgroup has no limit controls. Kernel memory support is a work in progress, and the current version provides - basically functionality. (See Section 2.7) + basically functionality. (See :ref:`section 2.7 + `) Brief summary of control files. @@ -221,8 +222,9 @@ behind this approach is that a cgroup that aggressively uses a shared page will eventually get charged for it (once it is uncharged from the cgroup that brought it in -- this will happen on memory pressure). -But see section 8.2: when moving a task to another cgroup, its pages may -be recharged to the new cgroup, if move_charge_at_immigrate has been chosen. +But see :ref:`section 8.2 ` when moving a +task to another cgroup, its pages may be recharged to the new cgroup, if +move_charge_at_immigrate has been chosen. 2.4 Swap Extension -------------------------------------- @@ -270,7 +272,7 @@ global VM. When a cgroup goes over its limit, we first try to reclaim memory from the cgroup so as to make space for the new pages that the cgroup has touched. If the reclaim is unsuccessful, an OOM routine is invoked to select and kill the bulkiest task in the -cgroup. (See 10. OOM Control below.) +cgroup. (See :ref:`10. OOM Control ` below.) The reclaim algorithm has not been modified for cgroups, except that pages that are selected for reclaiming come from the per-cgroup LRU @@ -284,7 +286,7 @@ list. When panic_on_oom is set to "2", the whole system will panic. When oom event notifier is registered, event will be delivered. -(See oom_control section) +(See :ref:`oom_control ` section) 2.6 Locking ----------- @@ -301,6 +303,8 @@ Per-node-per-memcgroup LRU (cgroup's private LRU) is guarded by lruvec->lru_lock; PG_lru bit of page->flags is cleared before isolating a page from its LRU under lruvec->lru_lock. +.. _cgroup-v1-memory-kernel-extension: + 2.7 Kernel Memory Extension ----------------------------------------------- @@ -460,6 +464,8 @@ test because it has noise of shared objects/status. But the above two are testing extreme situations. Trying usual test under memory controller is always helpful. +.. _cgroup-v1-memory-test-troubleshoot: + 4.1 Troubleshooting ------------------- @@ -472,8 +478,11 @@ terminated by the OOM killer. There are several causes for this: A sync followed by echo 1 > /proc/sys/vm/drop_caches will help get rid of some of the pages cached in the cgroup (page cache pages). -To know what happens, disabling OOM_Kill as per "10. OOM Control" (below) and -seeing what happens will be helpful. +To know what happens, disabling OOM_Kill as per :ref:`"10. OOM Control" +` (below) and seeing what happens will be +helpful. + +.. _cgroup-v1-memory-test-task-migration: 4.2 Task migration ------------------ @@ -484,15 +493,16 @@ remain charged to it, the charge is dropped when the page is freed or reclaimed. You can move charges of a task along with task migration. -See 8. "Move charges at task migration" +See :ref:`8. "Move charges at task migration" ` 4.3 Removing a cgroup --------------------- -A cgroup can be removed by rmdir, but as discussed in sections 4.1 and 4.2, a -cgroup might have some charge associated with it, even though all -tasks have migrated away from it. (because we charge against pages, not -against tasks.) +A cgroup can be removed by rmdir, but as discussed in :ref:`sections 4.1 +` and :ref:`4.2 +`, a cgroup might have some charge +associated with it, even though all tasks have migrated away from it. (because +we charge against pages, not against tasks.) We move the stats to parent, and no change on the charge except uncharging from the child. @@ -719,6 +729,8 @@ If we want to change this to 1G, we can at any time use:: It is recommended to set the soft limit always below the hard limit, otherwise the hard limit will take precedence. +.. _cgroup-v1-memory-move-charges: + 8. Move charges at task migration ================================= @@ -739,7 +751,8 @@ If you want to enable it:: .. note:: Each bits of move_charge_at_immigrate has its own meaning about what type - of charges should be moved. See 8.2 for details. + of charges should be moved. See :ref:`section 8.2 + ` for details. .. note:: Charges are moved only when you move mm->owner, in other words, @@ -757,6 +770,8 @@ And if you want disable it again:: # echo 0 > memory.move_charge_at_immigrate +.. _cgroup-v1-memory-movable-charges: + 8.2 Type of charges which can be moved -------------------------------------- @@ -806,6 +821,8 @@ threshold in any direction. It's applicable for root and non-root cgroup. +.. _cgroup-v1-memory-oom-control: + 10. OOM Control =============== From patchwork Thu Jan 5 13:16:34 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13089867 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id ED110C3DA7A for ; Thu, 5 Jan 2023 13:17:20 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id CB4FE940007; Thu, 5 Jan 2023 08:17:12 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id C649A900009; Thu, 5 Jan 2023 08:17:12 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id A395C940008; Thu, 5 Jan 2023 08:17:12 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id 92E98900009 for ; Thu, 5 Jan 2023 08:17:12 -0500 (EST) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id 6FDE6A0CA6 for ; Thu, 5 Jan 2023 13:17:12 +0000 (UTC) X-FDA: 80320796304.22.C897557 Received: from mail-pl1-f180.google.com (mail-pl1-f180.google.com [209.85.214.180]) by imf07.hostedemail.com (Postfix) with ESMTP id 9461140012 for ; Thu, 5 Jan 2023 13:17:10 +0000 (UTC) Authentication-Results: imf07.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=iCXg4LXU; spf=pass (imf07.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.180 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672924630; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=/8J8qW+Vq8pd6T9oMP3SU6TUuvWLiPg70zvs+kZ90og=; b=yaWS/JqleLnK85lA/BYsB5pKyun2/1HbtrI2YiBaKWWEjl3O3mpMePd29EYbe8xrsSnno2 t2d/80K3T7Y7yVAPG0Ko+Ir9HJnx1lyLz70p76n8iMnx70BpmU8X5yfbMt9l9OITWhTeO+ NbwliaY7ScoSECIixee0lp63ruJJ/w0= ARC-Authentication-Results: i=1; imf07.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=iCXg4LXU; spf=pass (imf07.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.180 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672924630; a=rsa-sha256; cv=none; b=fb0loRE/RUAOrZdQcSDBph/kcLTRosAVUFdE5oUy1im5hLmObGQEj2Hzzv2X71pxfwf/Pz 9CBEuMuYs+mllnFf4M3KSS2A3g9H9gtNbjklDNK6WrolggZ8r1mRJVjW0CLHq1cNsxIj3G bXf4FQoabSqUg+zsJ+fb9eve8c4ieBQ= Received: by mail-pl1-f180.google.com with SMTP id jl4so33030295plb.8 for ; Thu, 05 Jan 2023 05:17:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=/8J8qW+Vq8pd6T9oMP3SU6TUuvWLiPg70zvs+kZ90og=; b=iCXg4LXUCBckmKqWrrrxIf26SHrZFmi22auf4ZaicKRigcxRH4J1pPKSfOGqGrx+70 2Dz9hHlbyfiE4Ej5uw8WLiINWCrDAzbB2ANP3+/gbqzdOwBY6PAVA7BUZTzjTjN9cnpk w7tPekaV9ZL3vtm3yJhU/niRomQUa/kb4CWyJH8y8iuAh/qLPl6JCDrc6ste8rMI94Vb txsfBlJ+2NXRQscx4WGe5FgfV4qryQy/us+G8v74ohmJ9dZ1/1Yydjnm5pMDR4CGIFWd rFyAaog+Q+WI+4vFL84NNY7n+NkZ1tRC3x6sboqGdsT7/ikXBHb5637YYaiNJOQxgOy1 wIXQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=/8J8qW+Vq8pd6T9oMP3SU6TUuvWLiPg70zvs+kZ90og=; b=dRoQGUu/kK7M2J7mf4h0wYKJ1bjjjECtKHn7CyHvQu8MWNEMALsiz08v1gZO72hXv3 tHDe3zwDC+lrv+KzY4sjWkEgIQcqX7jObO4vmKEEuFKhyL0UlgtxMWLZeRzvYde2ajcv 2rDLr6PduB7Ve0UKW1bkwqwuSLXa6ZEuftLOhhf6sEFmaM8WWpTtrV8oH7iZ3ZMwNAMD /6u2lGpoVAGjAH71xhWBgPu8hTp7gotTf449mX8r6kFCf0gi3L81qw4CjSFftde5HQTp /bgYj8TtZDyhOkgj1lY9C5eZ9r5RQFDmsgthz/42ynDz3ZjYtbauVd50Mxm/TDXYmShS Pheg== X-Gm-Message-State: AFqh2krF/JD+NJ3vay85WOqC+zJLIh3gpVmcznRVvrlZaDdjGGYDQ/TN yeB/5ET45UpVy8eiuu19Jfo= X-Google-Smtp-Source: AMrXdXslOn7z2k07aal+6cIKgoQ5LswkwnJ95kNaoSJyQRPK/amOfoIBRXrc2Nm+i57mpW0/cAM3qw== X-Received: by 2002:a05:6a20:4295:b0:a8:8714:233b with SMTP id o21-20020a056a20429500b000a88714233bmr80647372pzj.57.1672924630106; Thu, 05 Jan 2023 05:17:10 -0800 (PST) Received: from debian.me (subs02-180-214-232-68.three.co.id. [180.214.232.68]) by smtp.gmail.com with ESMTPSA id q7-20020a170902a3c700b0018997f6fc88sm10893264plb.34.2023.01.05.05.17.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 05 Jan 2023 05:17:09 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 8148B105232; Thu, 5 Jan 2023 20:17:00 +0700 (WIB) From: Bagas Sanjaya To: Linux CGroups , Linux Documentation , LKML , Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya Subject: [PATCH v2 9/9] docs: cgroup-v1: use numbered lists for user interface setup Date: Thu, 5 Jan 2023 20:16:34 +0700 Message-Id: <20230105131633.553574-10-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230105131633.553574-1-bagasdotme@gmail.com> References: <20230105131633.553574-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=3017; i=bagasdotme@gmail.com; h=from:subject; bh=nysWUkfThi/UCTzfZAv3ZXQWTYDkn/SrXnv8ebwTGco=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnbzm5cWtCq0ng04TEHZ7mB8SLVvBOR8ztZH9yf/zX6aJlM um9YRykLgxgXg6yYIsukRL6m07uMRC60r3WEmcPKBDKEgYtTACbibcPwT83d3Ur0YVzhzYLHnCdO+i /VN2/wf6tmmSycLGTr8LlwKsN/L4kJ/ZbNi2Kc+F4s8DBN49CYLV1rXfH+fJz40j4rB2VOAA== X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Rspamd-Queue-Id: 9461140012 X-Stat-Signature: 4t4zsan6j99397h9573pfqai1umckqwu X-Rspam-User: X-Rspamd-Server: rspam08 X-HE-Tag: 1672924630-147232 X-HE-Meta: U2FsdGVkX19dMT0tSSgXQal2lT/YvRnlLQpoCpt+693EjizuYpBoByodPqmi0yQvCVDY9gc4A8LecFqYsE42PHfZtYuUKEb6nhI3H5XKlPYzq0Pxn1ogsZYM88j9xkoVNR28RinKMP3b2LLC5MooUrko39jgQB9McCadsQtfcdDleFr5gOXNj8PoCO0hceV4BQ1uRD0979T9dxLapOpYo+D1qM1gikJMCus2svQgTqVucH3Ta+um2a2aa2YOZ4O7N3uad8Cpqr4+c5WeHX5ZN0RPu0enz1lq5CrdqG1XHNFCXhyvdBLioXcHFsIJTcz7O8laDKRtjbIxI3G3HdvhoXhqTIMz/gV2vBrVu7DlKmU8BsAq8RcYax0HswrAmSTp4SzRq+OuoXWVVuTivGfF2sEf89nKw3rU0STZOrcFdO8tX6WT/M8NOnlQwK9KcxWilAaXF3+8d6kYCBxjaLYBguZrO9jS40mS8se5rEnW1G6yc4tecFuYtZ06sk6uOrPPcnoLHv9OX6UdnaFiKmR1c3b52o3UpZWdWDXCq8RlSHX2PuS5twvrcJLukjTtiUG7dGXkgVsJW7WvupveZRSu9ataJjHtMBCrvdTabEID1LfaNIgHSo3KrHC6augXdAtxm4vtXUK25tFBe0N+LClkSH8SeNfcDlEurlnPDwMQ1XZJMR7Sf3hW5z3JC4emHXikLTh1XmfbcdbrYLzJhUDlaePkm07sp/LQ1A0r82PDg3mNpUMJeGE+UVCGtP24MTacScgcQBKq6v1FfNeHdXsVdW2W55L9fVCJ01jvPqMJWJKROVJNzawFDZmT0yZvr04G07Rk/1lbi5DeI/D9ubbiYJBRBi+CM9fXKCY4C6V9G1W+cwjtw2koxlNi2LTo1BFg3OciZ9BZ8it/i9mwzXMPQCDVap/qxBNdoUCJiSW08dNyKo1Iya1/uMwS19bQki3D7p/hWQGvDmTwWC2UZmz I8f1PBfD TygNTEaJLG/WFVMTKhcTJK3cslmEZd6cV6bnt9Ed2qK7WWrgGBmTkYcV/i09kCOUMw+WME8nZB9ImdIIMAf0qhlLLWqxl1CzAVdcNInWadX8Vf2TXfDueNRUaN/yfoeqHnvGf X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Setup instructions for memory resource controller UI uses a mix of section headings and normal paragraphs, whereas numbered lists are better fit for this purpose. While at it, also slightly reword the instructions and add reference to "Why are cgroups needed?" in the main cgroups documentation. Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/cgroups.rst | 2 ++ .../admin-guide/cgroup-v1/memory.rst | 26 ++++++++----------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/cgroups.rst b/Documentation/admin-guide/cgroup-v1/cgroups.rst index b0688011ed06de..9343148ee99366 100644 --- a/Documentation/admin-guide/cgroup-v1/cgroups.rst +++ b/Documentation/admin-guide/cgroup-v1/cgroups.rst @@ -80,6 +80,8 @@ access. For example, cpusets (see Documentation/admin-guide/cgroup-v1/cpusets.rs you to associate a set of CPUs and a set of memory nodes with the tasks in each cgroup. +.. _cgroups-why-needed: + 1.2 Why are cgroups needed ? ---------------------------- diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 16d938abe69f81..27d89495ac880a 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -387,30 +387,30 @@ U != 0, K >= U: 3. User Interface ================= -3.0. Configuration ------------------- +To use the user interface: -a. Enable CONFIG_CGROUPS -b. Enable CONFIG_MEMCG - -3.1. Prepare the cgroups (see cgroups.txt, Why are cgroups needed?) -------------------------------------------------------------------- - -:: +1. Enable CONFIG_CGROUPS and CONFIG_MEMCG options +2. Prepare the cgroups (see :ref:`Why are cgroups needed? + ` for the background information):: # mount -t tmpfs none /sys/fs/cgroup # mkdir /sys/fs/cgroup/memory # mount -t cgroup none /sys/fs/cgroup/memory -o memory -3.2. Make the new group and move bash into it:: +3. Make the new group and move bash into it:: # mkdir /sys/fs/cgroup/memory/0 # echo $$ > /sys/fs/cgroup/memory/0/tasks -Since now we're in the 0 cgroup, we can alter the memory limit:: +4. Since now we're in the 0 cgroup, we can alter the memory limit:: # echo 4M > /sys/fs/cgroup/memory/0/memory.limit_in_bytes + The limit can now be queried:: + + # cat /sys/fs/cgroup/memory/0/memory.limit_in_bytes + 4194304 + .. note:: We can use a suffix (k, K, m, M, g or G) to indicate values in kilo, mega or gigabytes. (Here, Kilo, Mega, Giga are Kibibytes, Mebibytes, @@ -422,10 +422,6 @@ Since now we're in the 0 cgroup, we can alter the memory limit:: .. note:: We cannot set limits on the root cgroup any more. -:: - - # cat /sys/fs/cgroup/memory/0/memory.limit_in_bytes - 4194304 We can check the usage::