From patchwork Mon Dec 19 04:22:00 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34390 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2188104wrn; Sun, 18 Dec 2022 20:25:20 -0800 (PST) X-Google-Smtp-Source: AA0mqf56q1ZCpIFXmnbdNidJAfpzEXH+WPjgock5gRt/GCeo0LHPcsk8tABja5C5QJBitEeRJjpw X-Received: by 2002:a05:6402:6c1:b0:46f:d396:a7bc with SMTP id n1-20020a05640206c100b0046fd396a7bcmr26309757edy.28.1671423920168; Sun, 18 Dec 2022 20:25:20 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423920; cv=none; d=google.com; s=arc-20160816; b=Xs4LfV17+JxIuot9JnpHniGgg8diavpbfvNNk0/VwzNZP/2m5M15oAqZH3zi8J85zp hlmS+mkGSGXTQbVuLZrM0n1LvwBtNXLgcpXeGVKogxTlQ2r4emFMr5wAoJvMXStNfSwT WHU6Zu80wSmhnUGKEVAkKzBCeBoZ2oeCkUDPmbxXMb0GlLfZsrULRXb1K8V39LrqAK/l lIXIta23gyuVEo7PvcjcbfpH5vGO6pRKHuKEgtgtt5ZYChLQTSx1FMDEIhoa9WfPX+A4 tWVX/YbbsLY0VmToDENcGdIwr2b17vt7hFXO5ak+NFhzthzPZNLzxF9LSWNH/xlrqwap sS6Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=rf1ACU1p6R9dNKmN5MUoIBYgA/aDmrGTefWeFw4FNFs=; b=M0p4jP7cPOxLJZBnxaBn4ANB0e+JVsL5gRv/qmeDZwW9YJ/3MjUrVjAcUe6hFaUWr8 lKM3pWpLa5DCFJnt+rUzU4RbdTRflvDwYZLLpOqjrbokR/Uuh+q8wYdScWYPqkY56cPw qntFSwi9ZEVqCDod+nCUr0wuFepPzQFJhyVGe3aw1ygf00IO9MyoDR3OYUMcsqYmiY3F JKJLpKFb2h+rsL+IJ4HQpW9dBo0pURxTuEa79hWy3ADXuN9SW0fFYfs5LrWzMgGk2UQj EdI47uS5cVMXfu3TUhVVc1YZCq8wxv+vi2E2QxJ1oA/bNc0rvm2nqdwgiYkNBPrAHdnO ylxw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=VVMSfTlU; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id hv13-20020a17090760cd00b007418a1e877dsi2522646ejc.580.2022.12.18.20.24.56; Sun, 18 Dec 2022 20:25:20 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=VVMSfTlU; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231470AbiLSEXh (ORCPT + 99 others); Sun, 18 Dec 2022 23:23:37 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48436 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231290AbiLSEWX (ORCPT ); Sun, 18 Dec 2022 23:22:23 -0500 Received: from mail-pj1-x1033.google.com (mail-pj1-x1033.google.com [IPv6:2607:f8b0:4864:20::1033]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 478A864C9; Sun, 18 Dec 2022 20:22:22 -0800 (PST) Received: by mail-pj1-x1033.google.com with SMTP id b13-20020a17090a5a0d00b0021906102d05so7694172pjd.5; Sun, 18 Dec 2022 20:22:22 -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=rf1ACU1p6R9dNKmN5MUoIBYgA/aDmrGTefWeFw4FNFs=; b=VVMSfTlUA9HuhH9vvEonzOiWvAjByqAsh2y6ihUJpOuzLOlRxVdAkLfNeqbgB7+jiV d4PUUkwZjROAjnuSiuOXJuaumnRRKMFKmX+3ii+MFBcQEGk7orUj/VXGC5/ZzxMHMMKK s/K7XksauWGoqPHEoVii9LOZFwR7B1plzXiad4PktoblqlbNXJhiBBTXFxwNMeYHz/uz P6il3KL0zXD/Yyig85v008Cl4r4AWYuO+g4f96/sJXngmDBKIKapc3Vt5HTZdz8Fo96G f7r2t+Dg4DytpKegAj6jU2kpEgWAnH9sYDGmaxF4wbwIRicVejpWwdZw0XQ1DirZ28ey wl4Q== 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=rf1ACU1p6R9dNKmN5MUoIBYgA/aDmrGTefWeFw4FNFs=; b=5l1B0mzo3gWNV0/eDoOoKBZwjfpIKqD+YPg8OCIo7KVakFX7vzHDFYcfiC+x/636xm WcXXVOqIvYXzeZpCkzavo0fRpldO/SXHp7zZLXVCWMxuoU9k5nneafpvkewFBBGLRL+y kBYd1tD3Ab7Pm6gAahmL4oiVc/+iHYWTwCPi5EDLrdkzE0+WhV1udZrLfFGewT/nVkpC JPETDTJnVHHsiXz808u9KxPPS6POYGPvTnoUBiTqoS7zAgJyYwW5Rr2bDMPohRU+WalV cs2qCxIDd81fXtoJq+qqYKIJWVKm3DazpjFFtGvZDNVBqYlQFKlFCPgLSlon11ptoCzO La0w== X-Gm-Message-State: ANoB5pnwgy8p/HPppb1TvbnuG6cg8ZOIWbL/iDnwuFHiMd8f/6PrSGy2 h9Euv5vPk4DKkrQMKYcU1qw= X-Received: by 2002:a17:902:6bcc:b0:188:5256:bf60 with SMTP id m12-20020a1709026bcc00b001885256bf60mr39973300plt.25.1671423741785; Sun, 18 Dec 2022 20:22:21 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id e10-20020a17090301ca00b00189af02aba4sm5911773plh.3.2022.12.18.20.22.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:19 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 5AC8A104051; Mon, 19 Dec 2022 11:22:13 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Linux Memory Management List Cc: Tejun Heo , Zefan Li , Johannes Weiner , Jonathan Corbet , Michal Hocko , Andrew Morton , Hugh Dickins , Shakeel Butt , Bagas Sanjaya , kernel test robot , Stephen Rothwell Subject: [PATCH 01/10] docs: cgroup-v1: extend underline of section 8 Date: Mon, 19 Dec 2022 11:22:00 +0700 Message-Id: <20221219042209.22898-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1318; i=bagasdotme@gmail.com; h=from:subject; bh=0T+nIwJE0sYswok26CNbNxcSAtUv7ROGjQG7VnVQn2o=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn71NK+ZaFhzc2aXak8LgGWHHYbhsgYtg6swzgg+TxHY0 XvnYUcrCIMbFICumyDIpka/p9C4jkQvtax1h5rAygQxh4OIUgIlkcTIyLJWR8X/FmmKllbdoCVviWs tEk6mP/c6cYhAU2hQbGnFCkuGfdtXiks0XNS6t+VKZce3olRLBlsg6oTkyWwuXXXOxFNvIAAA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752615008800708914?= X-GMAIL-MSGID: =?utf-8?q?1752615008800708914?= kernel test robot and Stephen Rothwell reported htmldocs warning: Documentation/admin-guide/cgroup-v1/memory.rst:723: WARNING: Title underline too short. Extend underline in section 8 heading to match the text in order to fix the warning. Link: https://lore.kernel.org/linux-doc/202212180030.OzPG7QHL-lkp@intel.com/ Link: https://lore.kernel.org/linux-next/20221218062235.443758ae@canb.auug.org.au/ Fixes: f8bc956f6ea695 ("mm: memcontrol: deprecate charge moving") Reported-by: kernel test robot Reported-by: Stephen Rothwell 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 87d7877b98ec79..258e45cc3b2db1 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -720,7 +720,7 @@ NOTE2: otherwise the hard limit will take precedence. 8. Move charges at task migration (DEPRECATED!) -================================= +=============================================== THIS IS DEPRECATED! From patchwork Mon Dec 19 04:22:01 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34389 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2188040wrn; Sun, 18 Dec 2022 20:25:05 -0800 (PST) X-Google-Smtp-Source: AA0mqf62hBdxo+qGVwt95gmSmK0e5kRtO+ko+jXPeuAJuMPBsUWcX2/HQ9bYJAPtl2EIouSpE/OD X-Received: by 2002:a17:906:f106:b0:7c0:aea2:e910 with SMTP id gv6-20020a170906f10600b007c0aea2e910mr47023272ejb.3.1671423905293; Sun, 18 Dec 2022 20:25:05 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423905; cv=none; d=google.com; s=arc-20160816; b=KvAt7K+U6V9MsOKdUfEVXEs9g8QdL4WxynQ/RZyzOe9RH7CLQPrFRg+W2/KPkhqzbD c0bTCw34m6ibNxF7BGpcaQqDiMCz6bfRu7Fwl3hXuAS7zq6Rf56SC9+gxzTISD2uXrue WVNIebkBbMIHUXvIVpMqW3qAuexr3ZIFHHfZ79amGchU4iNNm/G091X1hbi04wmzkcoX bL+z277cYhoO49qsr248Iniqh/aAuBt9blmsDD1G+NodHs//VJvWuj4tXwULgU2SHSKF 3OebLmO0zngGX/9nhzy7t1xMFYH33DeasmZcZmOIopRZJSEGXj+RKZV22M6EJUSOHq8F 5YTg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=szBp/K72BE8/BicOSwRE0ZIF4ays06I72BistI/53Pk=; b=RhEbcCpW26I1L7KQftRSiO+fWaCq3w7dNxYKkPnNLAok6/5AwMe5/hF8CCRtYYnZgm 2xiTNMKtrvI97ntxLWhxONOgQJLVbnBlqxyFEm8qjiCvziVU7AVPi/s/1hCVunwmtJlX RudCxqcUHTvr4nGHKeGBlESmoy3gyblEcNwpQby2Je2bEeeQzUVzXMCh4mTsFpQd6j9/ W3x8FmTfB609z+YokGpYmflzGxRUnREaY+C21G1bq2z6NUpoyDkQPU3WsoOFE9Wf1Tgk eIXj5lr86gn9odeEDtsHykQ3m3pklxCd8rx8xWNeSNzxxwaGzAcUZeG6EbMlGcWlSxvm DGqA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=U8mV2UMq; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id xg2-20020a170907320200b007ad943d0608si8976241ejb.630.2022.12.18.20.24.42; Sun, 18 Dec 2022 20:25:05 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=U8mV2UMq; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231463AbiLSEXU (ORCPT + 99 others); Sun, 18 Dec 2022 23:23:20 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48438 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231339AbiLSEWY (ORCPT ); Sun, 18 Dec 2022 23:22:24 -0500 Received: from mail-pj1-x1030.google.com (mail-pj1-x1030.google.com [IPv6:2607:f8b0:4864:20::1030]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9C122B7DD; Sun, 18 Dec 2022 20:22:23 -0800 (PST) Received: by mail-pj1-x1030.google.com with SMTP id u15-20020a17090a3fcf00b002191825cf02so7721943pjm.2; Sun, 18 Dec 2022 20:22:23 -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=szBp/K72BE8/BicOSwRE0ZIF4ays06I72BistI/53Pk=; b=U8mV2UMqqjrK76pglD8zq0C3ETUIxiTKnqdujwOR1qcvaxNfhqdcHidmBUWAcceOzr y+Suw92hyd+cGnMxdplh2Zbh/USuOlHnACokA+9qPliCRmT3CwZK1r7vEHS4fS/8lpwW rrUnQpmiPj2h/meLZp8vgu8PHs0S3QalFVHJh1AJRCji5YGu1wpEjCICHGPLZvnmIJnM jDBTxQVTtcluZTysxPluqLoFbhmLlIxw5zWp9dHVlhkRyLhCW5xG9LptVj7zoxUOqE5d dzytGhmBIrO+zIgiFqlSKYE3HSILCOMh7bDi1pEmu/rC1qR83Lu5voDaYXHisXoGJ15K JMtA== 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=szBp/K72BE8/BicOSwRE0ZIF4ays06I72BistI/53Pk=; b=Romy1HmaH2P81gJLXKbApAnBp0Ftf663qhHBQGjl+CryBzN1wLoc+ugr1ITdNtLRFl eJAdTv67nX/5SwKPaZovd49C11XVWeHXAaswf8sMYZswdm37Rc7BahRApWcHfZTFknb1 v4aPQXTw3+EKaO2ApKoxGO/bZyrjLoqHkVGQkxNRS2qlfcHv40Bt8ER/VOCmxpYHxPIL CNAjyrKREO5LsC5fKA4qvZjBEnRn97XIx5OByYJyQUicwZQa/ledn7nLdIFEvJii0MVU FK+tJ1+GwCRegIvE2r8IaIOPb+rkswUn+EQSfQYA2cmxgPJQt6MKF8kUybYR6LLG4dmN yOfw== X-Gm-Message-State: AFqh2krE5kXBsfSnhO7+Fd4WICPrmjQVuKGQVgCGFdpFXoE6oWeLzheq hiswr+3gN1FYO4mahRq7ajw= X-Received: by 2002:a05:6a20:8f01:b0:af:e891:f4cb with SMTP id b1-20020a056a208f0100b000afe891f4cbmr15555056pzk.27.1671423743336; Sun, 18 Dec 2022 20:22:23 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id a3-20020aa794a3000000b005750d6b4761sm5349770pfl.168.2022.12.18.20.22.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:22 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 0136F103F5F; Mon, 19 Dec 2022 11:22:13 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 02/10] docs: cgroup-v1: replace custom note constructs with appropriate admonition blocks Date: Mon, 19 Dec 2022 11:22:01 +0700 Message-Id: <20221219042209.22898-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-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=9M2vbQHkCDEOiNLeCwV/da0jjZmiwfDhmvzgespqc+I=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn727o/DpacD63LWPLCMXrVpgbzrTSVndwerLZ8EPS6Lv /NTO7ChlYRDjYpAVU2SZlMjXdHqXkciF9rWOMHNYmUCGMHBxCsBEHlxg+O/IYedZt37L7my1VOdDb8 21Go2P8c1/+5VdziZaPcWJ+yojw60tUjpXliw1T/4m5S1/XfZ4gcXjkL/NL7cphRcGcJ1mYgAA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752614992579548811?= X-GMAIL-MSGID: =?utf-8?q?1752614992579548811?= 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 258e45cc3b2db1..ec99bcbd55c2e7 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. @@ -276,12 +276,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) @@ -369,10 +369,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 @@ -407,16 +407,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. :: @@ -576,12 +576,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. @@ -712,10 +712,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. @@ -744,17 +745,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 Mon Dec 19 04:22:02 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34385 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2187927wrn; Sun, 18 Dec 2022 20:24:33 -0800 (PST) X-Google-Smtp-Source: AA0mqf5mfpf9qdsHDJU/TEWEuJFn71T+yEFZJ7WDrvAfpCBrnGbohL5zDa/POpL8ymZ2cShqH98u X-Received: by 2002:a17:906:917:b0:78d:f455:b5de with SMTP id i23-20020a170906091700b0078df455b5demr35759892ejd.30.1671423873342; Sun, 18 Dec 2022 20:24:33 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423873; cv=none; d=google.com; s=arc-20160816; b=jY0AjerORkp0rxZhe9t37h8yY4MqR3jIzqhdxiIk7LVYknCxYGg/8PpSJw57twPgqa siwX140Ml7HLgLPkYexs5r7/M+pq/R02O0RoUsyYxSBnVurTcHNbfp+aR+Quv72pgpwa SsZqyKSDzJqESOnPvTPjyP1VIplbfJtxRUGio1r/qHJyOREmaqX1EGF5dcwmQlcUwfOY vPZIOdUBvk4uZl9KcREvTuWBc8WCGHM/kDpWGvNxVISUAs1PI2xXklf2xAcfGFVWNwkw 9vNg38i82WQ7CXUse46fEcZzPDLQ3+lVcyKDpfK+orcPtlWGxewB1EtRCnIOWUFhHzgj /udQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=dm3StokzlT7Szh+BiWvCYI/X474BbeHVmllPMqNHQFs=; b=kD+mkSA/QvcKhDUZV/DDWiK3a1vBMs7JwLQ1F+yRDWuFJUTU590aCZYir4V65w7Ear /41pAgu9n4fSOgOqVzlfhz1cA4G8DkPRR1OIhnene0V3rvps8JmCArYiA9HniKKAKq91 Mq89rlk6PQ7SIgl0d4jXlmCu+TBQFRAdxwsM3Fc9KD+pAmt98vwHHTQfGBMf2lSIc/zu HQC3G4n6LtLcRGI/ht4ge81gAq91CRnCl0uit1cd6/+sTSFQhD0+huO3ZJlDk4NEDpSy NBCpifU/ypAt7ENVYfvoAQ/q0ttNHBC8iLmprWPyv0G/p5iWlxc0wIs+PBjU8RqEHsZF oKxg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=CivmBZcj; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id jg3-20020a170907970300b007f5e85a453asi5945428ejc.354.2022.12.18.20.24.10; Sun, 18 Dec 2022 20:24:33 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=CivmBZcj; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231434AbiLSEWq (ORCPT + 99 others); Sun, 18 Dec 2022 23:22:46 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48416 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231237AbiLSEWW (ORCPT ); Sun, 18 Dec 2022 23:22:22 -0500 Received: from mail-pj1-x1035.google.com (mail-pj1-x1035.google.com [IPv6:2607:f8b0:4864:20::1035]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8BD2F64D2; Sun, 18 Dec 2022 20:22:21 -0800 (PST) Received: by mail-pj1-x1035.google.com with SMTP id z8-20020a17090abd8800b00219ed30ce47so11728184pjr.3; Sun, 18 Dec 2022 20:22:21 -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=dm3StokzlT7Szh+BiWvCYI/X474BbeHVmllPMqNHQFs=; b=CivmBZcjEkCkLhyVLzlphxvDMwl6nheUGKlegj1hnyWxPXopZtrKelMJg4NLztp6Ei 19ap32V2lPltBGqPJjF1yBiq+0421am0efG9yS/XctjfSJMUHJPg2KbY+drosobdJh7n gghu6w/mHGHBlxzAbFf/3ky8O7nGUoI16/HmaFoXCTM60F0g6N/aa3HWSmyxvZZBroOs 0IUlMvIpvPq9EUVRd08Us5p8bQ/ETvUMY7+aK58/0yKxoewBuKFZb0FIc8vWRY1rerdg ofnz3i0Kc4V+CwnzTxo9fb0DS9JoKTh94ENhKF8b6RzRqJ5RcsZp2hXo25O5OqXf7Mgo 1soA== 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=dm3StokzlT7Szh+BiWvCYI/X474BbeHVmllPMqNHQFs=; b=IYltYxCf6RqE6TyvEPzge33MQDbzlbm+9qNJqSv1DI45HRZGxSjNOmY2MdvuHbqEQp Ekw0kvCwn1NMcl+eFhZgucT7FzlhG/zIZKQCahM02bUsGZMX99bgbAj5IqiwGo01kad/ 4YZj/4EuamRA4u0C3QTHxy7ANZgbu3nK/+428zgGJFFen07mgKHgGxm0K2qxhSGpx51b JpRRiIHM1id2qlaT1kdOOMBtOZ/y/cW1QQuaGkB+M8SegdwoO/DHDKYON9lW/Ju80+3T +HlujrQwVlD7+km2ahq/BsMiq6pUkOvFW4zxBmo0Ep4kSHCipfG4gWI+x3WS9viiQvdp CMjg== X-Gm-Message-State: ANoB5pnJc2vK1BLYN8yuNphBBwt+y3j4r42P3eGg6np1eII34GMF/Dzw BbukgfAEj5Bs5fnjnV8sbbM= X-Received: by 2002:a17:902:7e86:b0:189:eaae:a19c with SMTP id z6-20020a1709027e8600b00189eaaea19cmr39764943pla.30.1671423741073; Sun, 18 Dec 2022 20:22:21 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id u6-20020a170902e5c600b00189e1522982sm5876404plf.168.2022.12.18.20.22.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:19 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id C45D310403B; Mon, 19 Dec 2022 11:22:13 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 03/10] docs: cgroup-v1: wrap remaining admonitions in admonition blocks Date: Mon, 19 Dec 2022 11:22:02 +0700 Message-Id: <20221219042209.22898-4-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2573; i=bagasdotme@gmail.com; h=from:subject; bh=lpUMV2xz23OWCWVLnriwcRj5xPuoIGRu0Ewl15SLIFA=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn71z7D2sLB/nI+epfmjX8TWbYy0vZXxnNyt0vbLVJ3OP 3IINHaUsDGJcDLJiiiyTEvmaTu8yErnQvtYRZg4rE8gQBi5OAZjInU0M/2PY0lqe7C6p53qqp9STtv jzwfmNq/u1OK6wh/Gr3U9V1WD4w7ObbfXhP2dvCXbryN/+9eeUl0qKzZdN71um3rpuJn59MhsA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752614959543141581?= X-GMAIL-MSGID: =?utf-8?q?1752614959543141581?= 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 --- .../admin-guide/cgroup-v1/memory.rst | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index ec99bcbd55c2e7..f828db2a671be4 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -13,11 +13,11 @@ 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: - 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". - In this document, we avoid using it. +.. hint:: + (For editors) In this document, 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". In this document, we avoid using it. Benefits and Purpose of the memory controller ============================================= @@ -723,12 +723,14 @@ If we want to change this to 1G, we can at any time use:: 8. Move charges at task migration (DEPRECATED!) =============================================== -THIS IS DEPRECATED! +.. warning:: -It's expensive and unreliable! It's better practice to launch workload -tasks directly from inside their target cgroup. Use dedicated workload -cgroups to allow fine-grained policy adjustments without having to -move physical pages between control domains. + THIS IS DEPRECATED! + + It's expensive and unreliable! It's better practice to launch workload + tasks directly from inside their target cgroup. Use dedicated workload + cgroups to allow fine-grained policy adjustments without having to + move physical pages between control domains. Users can move charges associated with a task along with task migration, that is, uncharge task's pages from the old cgroup and charge them to the new cgroup. From patchwork Mon Dec 19 04:22:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34392 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2188174wrn; Sun, 18 Dec 2022 20:25:35 -0800 (PST) X-Google-Smtp-Source: AA0mqf6GeGvrKA0m0Z4UCdiVODYGleGWzx7ChienJWLdZUbVUbwK6L2DpXSoXVoMd7VSvQiJqXaU X-Received: by 2002:a05:6402:1389:b0:45c:835b:ac64 with SMTP id b9-20020a056402138900b0045c835bac64mr32913335edv.31.1671423935702; Sun, 18 Dec 2022 20:25:35 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423935; cv=none; d=google.com; s=arc-20160816; b=DG2vPxiWomkF2nQpLa1Isz30JwBSixaKIVIMjdDgBnt7eKRSVjH733tDvWT/eiY1nh eI3Qi+93iDCrL2U2u7VtPLjnGZEuyoMLp40jzlvt0biV9PEp3hhrIu4SEk6HhWfU7DqU FVgac0rYpRf8FkprTQJzBnUmD2OC/iJ2AruO0bssYP8xpYJjVUby6CWavNP9tK+aZfhX 9cntjgEc+tY8+UhkRIGAOQxRZLnbMuSOzwu9MwwdunBEGCyAR/jB8hOCbU+zBEB9XkSD n1agx/Snkg2FThWYsPRTUwYe9Nc7lD4DjG6dECrS1Rc6CsDaadJOsjioSoVktYOYbNGd rWWg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=/nm7j4zp8S75Gf6ZgO/l+49FQ5Ia2zwvn+/ND79+AHM=; b=QvJ+yhyTzvr4R8b4SArsvbf2RLxm9bWLy1bgB64SOPYJL4KDpjfc8dL/lO9QLjYJ/6 MMiNu3getV0I1jnd5223lb+kQ7SgH1ysb+jBnZQ+inFMP3vV2WbpNwc4akwbPIiuYXH3 k2YPt22Jkopfrk50D+/D2uRgClc+ItnU6bAD+pQFNbZ7yYrNzYhWRGwcEE5gXr8m4grB DbQC3Y71lb6NFvykUG/+HfbCoem1ZrPVmT6MUzwWxHHPvxWCQcSxupcStmvmKaKac7wd 7KdjSJOcrpARLFk5LHcmEju2CR2xWtEVKAseohcXyjFDL6ZbyUwEXtwBusuHDROOupJT 00KQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=RehRdEZi; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id g20-20020a1709065d1400b007ae9bc0b977si9161327ejt.486.2022.12.18.20.25.12; Sun, 18 Dec 2022 20:25:35 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=RehRdEZi; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231481AbiLSEXy (ORCPT + 99 others); Sun, 18 Dec 2022 23:23:54 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48382 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231343AbiLSEW0 (ORCPT ); Sun, 18 Dec 2022 23:22:26 -0500 Received: from mail-pl1-x636.google.com (mail-pl1-x636.google.com [IPv6:2607:f8b0:4864:20::636]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BAB5265B4; Sun, 18 Dec 2022 20:22:24 -0800 (PST) Received: by mail-pl1-x636.google.com with SMTP id a9so7846723pld.7; Sun, 18 Dec 2022 20:22:24 -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=/nm7j4zp8S75Gf6ZgO/l+49FQ5Ia2zwvn+/ND79+AHM=; b=RehRdEZifLMG395ppV/7LVvRdnCDdwl9Hfk5Mmn0sswBZr2pNnW1dWd6YtLlfrIL0K oqFZJeTpgIBe4v9P3jAHQ9dobxEbwfP4nRMw0pL4/19ifX9Wwh5VebaXq3G0TckKJT5Q 3kqZoZbODRk6hDbPJJd4GFJwl9htH2bxOx75GIbhK2rZIKB2c/2H7a6LVwPUGFKq6dG/ voKaNBAD4+uMB8PRT0gAzEa0OtrUnuL4iaXuxFPQ2hzvgPrPfj6mx/ywyY5yaaXZ/NLt mBvHQKq1T/lpaZO+0hDhimJVesG6NF/drKn9yloFBkV8jzeDVvtTEOdeCDnZ9BCUi30G zz1A== 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=/nm7j4zp8S75Gf6ZgO/l+49FQ5Ia2zwvn+/ND79+AHM=; b=4ZIhAokgVmUqh4GPgTW/jSQXMRYb6A6w68QJiK5eCX4uOiyV56Rw1P15UCC4eoyRD6 gwdvzBTVJmb/uiFFwx/aYlvtBWARO829Mxlqvrk79Oo/chsTGrZbzEMujZ2R8v+Imp4f X9E0gYK3wqpY4pprPZ4VRy6QTPPQTA7exUviqVgEWF+IWzkc8i0POZc67CwnV58YFZ11 BNUwrHxlfCnDL2EHoR0d2ZV95K/nBqg+ifH8PtELoHCD8hbdNQrsh6KJ1L86regRJhwL 1niSXc2aFXSkCb+CB5HtiW4OiZ4muR/ana9WKmGvewgaw4CMPDTqqcjEu3csk9O9B3zX QhSg== X-Gm-Message-State: ANoB5pkmiVM4+zDhofz5sPA7Pt+WC7ncOB3KgSR4Phh1lVkFG97DRMNl o1SXEmVK7sTz+IKXtoLVY6s= X-Received: by 2002:a17:90b:2685:b0:21b:c5d9:3478 with SMTP id pl5-20020a17090b268500b0021bc5d93478mr41654253pjb.0.1671423744293; Sun, 18 Dec 2022 20:22:24 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id u31-20020a63235f000000b00488b8ad57bfsm2735607pgm.54.2022.12.18.20.22.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:23 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 3A60E104053; Mon, 19 Dec 2022 11:22:13 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 04/10] docs: cgroup-v1: use code block for locking order schema Date: Mon, 19 Dec 2022 11:22:03 +0700 Message-Id: <20221219042209.22898-5-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-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=myLqQWWL5ny5cfaM/c1+RVILw8UoUUmH9P1+d/iRWF8=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn70zn9QX8TP45KkeoY/d0cnefcv2Fi8TMpOtTxa/U5hk vTWwo5SFQYyLQVZMkWVSIl/T6V1GIhfa1zrCzGFlAhnCwMUpABOZvInhn/En+655Kw+EtDmba0gcLq 3akbQju8Am0mHuv99/CyRu6DIyTCuP1Cr+cCL9uti17M/FphdjK1O0XvOHHklgXN1wLpWNAwA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752615025110571947?= X-GMAIL-MSGID: =?utf-8?q?1752615025110571947?= 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 f828db2a671be4..c21ce0b906059f 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -289,7 +289,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 Mon Dec 19 04:22:04 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34386 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2187962wrn; Sun, 18 Dec 2022 20:24:42 -0800 (PST) X-Google-Smtp-Source: AA0mqf5MJ9i3hJuaNCw10tZtFPmtq88rknKe5A3dGvKZYroDlWErAmplZRKSupwfzrTwhweiR4Zr X-Received: by 2002:a05:6402:f0b:b0:46f:fe46:acec with SMTP id i11-20020a0564020f0b00b0046ffe46acecmr26641660eda.27.1671423881892; Sun, 18 Dec 2022 20:24:41 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423881; cv=none; d=google.com; s=arc-20160816; b=StmT/HzOgEN/n0UZHOamEV8A8kjvKY5Re6dYINel3ttKx0lMOn/trd7QKSN1opn7cz ivDqXMVFgPzLedOscv42Deu1SQGt4NKnAFnCY1m2jKNAEfASjkWivspr4mgnjQdOUkNs QYMg5eLfuIPyauHvPe2MThMGWNuAkkTpT36SWUkICyNeFmce84tjx6QpA9pHn4FrS3x5 sc3rO84IHO6WHTUzMT/bq6hW0DuU5j0OjmnZ4DLgPIYliRQo8CzbA5GxK1OUPrKohTaW zRgLRHjBSGnC4808RCU/GYQ2oPIyogADFEpCzV5a3GlP6dRYr65+TPqnuoEV2xkA7fbO uMyg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=QEwa20X9A+wyrh3eoohiFgEbSAwTbPLRyuDyRq0+iJI=; b=Q0Vk4UZ+JlVqlkugY8rl1VNWLO2FGEuHfPM1yMyBjhdEOTOzP9Y7XvMPpncp9tUvvW RKlUYFNHMrnjfxirzEfMCZlv247xCQ8cjEweFp6pkFsPoIs1qwFSRTlBUkDLGUYJ4ehI QzWgK5VQgzNHBje0kIG82ZmLr9+0nivbK5Myk7JsqwW/I6Ls/1zaQ0c0dZdXEox9xUIb APx4zTaYZLdEPoAyYky8GM/5G/EhaA/An68GWVr1zMZMYYtfK7BNjpsC0FYLez8zfZtk 1+gJn5UDAf5R/p+56RBjleSIChQ/nhzuzSOTHEEKJAYUJ5dEL5b9XN+PDwkjjgiWG72k 53ow== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=II0wTtuX; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id e12-20020a056402190c00b0046c9522362asi9213959edz.269.2022.12.18.20.24.18; Sun, 18 Dec 2022 20:24:41 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=II0wTtuX; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231449AbiLSEW5 (ORCPT + 99 others); Sun, 18 Dec 2022 23:22:57 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48406 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231234AbiLSEWW (ORCPT ); Sun, 18 Dec 2022 23:22:22 -0500 Received: from mail-pj1-x102a.google.com (mail-pj1-x102a.google.com [IPv6:2607:f8b0:4864:20::102a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BA60F64D1; Sun, 18 Dec 2022 20:22:20 -0800 (PST) Received: by mail-pj1-x102a.google.com with SMTP id 3-20020a17090a098300b00219041dcbe9so7702812pjo.3; Sun, 18 Dec 2022 20:22:20 -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=QEwa20X9A+wyrh3eoohiFgEbSAwTbPLRyuDyRq0+iJI=; b=II0wTtuXbBN9IR3zSvAIoImZqLWv0Oeuf04Gufnq1MigHIf67TLDV0jn7TB8epZsFl 3sobPQazNVCSNREFsj+waKJmepN4RKRGv5jKhGOO8xQ3FeFMzjxswnj+wJX6zJuVVKtD vRlBDOOCXf+uqa8v4WjUjVsV5efjC6QCtCju7xnXLNyCWjRxDOx84+zksXWKn2HTT2Hc VEhTup0H5OoAJZe17tUKAxcqCseN4njXFE8lC38/Jk2FkFYYKlooS+tYXbKC8MZgXjKQ bg0846Fhh86noJjama1Be+g7Al4PFbe0WtzrpNcNqNgtBIbwrZHUf37b32x+NPmZMMOX 0zeg== 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=QEwa20X9A+wyrh3eoohiFgEbSAwTbPLRyuDyRq0+iJI=; b=oZ9M0cpmBrzXiZr+cjRfWGf0gHOWYHt/yOGVHMN305abHSGOAVB2QGZs4oCVwuUSBy 2LpFRh7gOWcfXSF1o/hn4bNt8mqbweBGZrlv43c/6cj7tDbfRZ5Fo9HjQSqo+ypSVH9c RGyjqbhzaqYMGxtYhb0wjV6RMXTEdMq+1WP6zggLE2hNYd8WkdBJ41B13LH1iXnHnFNW wI/9Rezu7WmQAAawFuWVGRzrWnhDww/ru0Z1TNvjL+/Hr+N/iaxnqy6REMNupEJewYoB ciLp6ac3dXfppOkm8srSAFSKQsYJVh6Pvq3778mKw/2UiT18skM63fNSGRdhDZAHAABD 4b2Q== X-Gm-Message-State: AFqh2kqdMVbPiTJwONReXsuTVTo7ZsJaHV6rEUc7ighyClO+b+E98iyT 6L++o1cNlbhv6YFDcTbKLU4= X-Received: by 2002:a17:902:c187:b0:186:fb90:573d with SMTP id d7-20020a170902c18700b00186fb90573dmr8523902pld.3.1671423739989; Sun, 18 Dec 2022 20:22:19 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id q17-20020a170902f35100b00187197c499asm5882262ple.164.2022.12.18.20.22.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:19 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 93250101314; Mon, 19 Dec 2022 11:22:13 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 05/10] docs: cgroup-v1: fix footnotes Date: Mon, 19 Dec 2022 11:22:04 +0700 Message-Id: <20221219042209.22898-6-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-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=JPQvjZYEry5PAqc04yDM29al0BTsUtfNTgHs2tjYRDY=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn713s2ALYv7Qur7Z8OQ8xUPaUbXSj7TzHyttWtb8Zc7r WimDjlIWBjEuBlkxRZZJiXxNp3cZiVxoX+sIM4eVCWQIAxenAEyk8gHDP8uTjBf7tATssl9F6ut+mL 3WS/eK9VIWiadnj+7WDqq+JsHIcEb+29LkV/o8IVzfVV5WSz7+2/dD1uj8A4E/ce+mWqx1ZAIA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752614968700488197?= X-GMAIL-MSGID: =?utf-8?q?1752614968700488197?= 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 c21ce0b906059f..642ef0bb20380a 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 @@ -109,16 +109,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 ================= @@ -971,15 +971,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/ @@ -989,7 +990,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 Mon Dec 19 04:22:05 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34387 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2187967wrn; Sun, 18 Dec 2022 20:24:44 -0800 (PST) X-Google-Smtp-Source: AA0mqf5yQGxnHREn0ydjhPtC3Km5d96Nzc4hCw3AhxU0/puVGbZYwlkLhiuVV8jgec7D//xpNgWn X-Received: by 2002:a17:907:770e:b0:7bf:3627:df32 with SMTP id kw14-20020a170907770e00b007bf3627df32mr36248910ejc.75.1671423884385; Sun, 18 Dec 2022 20:24:44 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423884; cv=none; d=google.com; s=arc-20160816; b=f4DbcX3yq1UCPGkxtDsCyZVYnF/soAJQzZgxYWm7ZaOyoBMGndChkLDluqC+FMT+c1 17/DKCVqQm3PCROiVm8hRYn27mi1Ry1ZxPsYywa7BSfJNBK7Fjtp/4PWrOkSWp6BkUc0 RXDTNxcEhFpMm8RhrwDXEMdWuZLzMJrgEn3B9Oxm70bkcByZc6QZZEhmBX1pJwv959tU N2TlWr1qs6ThL4U8pjc//XgbPwiFh/YLg0Ue38835jwP/L4fcgawdepBrKq0PJbzu00h YQ19yI87aKiTD5mqBkpidB8KSwEDvy2Y+tmJ/mlGSh8AjopPcID2aHtTkRifAkcrR13D jbnQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=4bkaFHH9828XqB+keHudWE3HrJtGvwGZpCKERfRezL4=; b=AZYC8YfubocYpp2Vmz2s/pP2ThD/H3WAkI3vrOWUA+lAp7zllvESWbFKqGFEBjrIdD M0oZFOdmERhvbSlwbc9as8iFcTwSYfhOppBrHo2bBgfDzVnY9xkZpcvF1LVHu/Ir2UWQ DjMj5dyiYNi9lNDJ+0sHI0oX0RYVLUKtZCkuEq7jcJDbQl5j1+uBvivlzO7u/SaSu4in m4TdLPlBcTCz6LJDpkbKZxCiqsG5uB0qo/Pc36SfjlottHJX9XJu1wKFdtVHVSR1xtIK NoI9FvzUBaib1NYt+ufW5zkiKVPrjiEGEGVIaVA+KEvCDCugbVm5Q0QwvoE+Mq6NdvJO L4Bg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=UIKz0INg; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id i23-20020a1709061cd700b007c0e15c30b0si6773230ejh.777.2022.12.18.20.24.21; Sun, 18 Dec 2022 20:24:44 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=UIKz0INg; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231234AbiLSEXD (ORCPT + 99 others); Sun, 18 Dec 2022 23:23:03 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48362 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229730AbiLSEWX (ORCPT ); Sun, 18 Dec 2022 23:22:23 -0500 Received: from mail-pj1-x1030.google.com (mail-pj1-x1030.google.com [IPv6:2607:f8b0:4864:20::1030]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EF1A765AE; Sun, 18 Dec 2022 20:22:21 -0800 (PST) Received: by mail-pj1-x1030.google.com with SMTP id u15-20020a17090a3fcf00b002191825cf02so7721897pjm.2; Sun, 18 Dec 2022 20:22:21 -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=4bkaFHH9828XqB+keHudWE3HrJtGvwGZpCKERfRezL4=; b=UIKz0INgkJM01u8DImabW8vV0MXUcqTEWZ6ucIGfJpJGp3Ik7KfefxrEs5exBi19qf XOlxIyF1jrI3Sq8Uxn+VtjhXJOy7+fB74CPXeuahB4jkAnrIaxlbygXxHDuIt7YxoZRY SEKriY2DNUbP0Dz1n2r3FsmrLK38p9D0i4yJyz1BoG8JXNOnHiXiBS+fb6ScQ8dmQxU2 /b1NwJV6ZymcsU+LSeAsDigeFh1FLNZTKynWuqlRIdJHw9djnkAV9Cncv1Kb1fH9oh8Y Ajg8/GvAGXhcsO/P7JDzYZlwUAH3vmMR7bOyjo8yFrMnt++B2ZI2h4gWSuOJlPi8fT9b Ppjw== 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=4bkaFHH9828XqB+keHudWE3HrJtGvwGZpCKERfRezL4=; b=N5lIkeQtgZjtYSsy/hWaEoAqwaIPW22mcDU3bBK+7Wd9rB2sxoOE5rVhVaDwAjFCd8 4kI+Yq5Z1LCdXc4CH1UGd21NehBand36jXoJZwQ2wck4WRzGn2BmdnjlqcU5dA7K8ngY +LCf1Cd9bHaMKqRiNyst5qZ/HOd5BJU4jiDRxgPIBMTe6xy/kI2XuvpU7cIXWmiQJAa6 SgzpeA551DmNhEK8o1seCzwRyU0L9HJDL7xHwRVoC/5DW8+HqDWelerdqIO+tdBTpRx+ QJkDbknaU6XYsm4unoAPmVutYhlPfsPcF5UkzVKy2hHTGSiWWVqFS023lwTlpspwR/Jv usJQ== X-Gm-Message-State: ANoB5pkdOfxWYlqhf547wJQuHla9jp1IYxyrwLxjaF0RBbgWsDdKp2+K RQso0vhFK0gPACyAtm4BF+s= X-Received: by 2002:a17:90a:fe0a:b0:219:8cba:cbbd with SMTP id ck10-20020a17090afe0a00b002198cbacbbdmr42968593pjb.32.1671423741351; Sun, 18 Dec 2022 20:22:21 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id v12-20020a17090a6b0c00b00216df8f03fdsm8134652pjj.50.2022.12.18.20.22.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:19 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 2471B10016D; Mon, 19 Dec 2022 11:22:13 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 06/10] docs: cgroup-v1: move hierarchy of accounting caption Date: Mon, 19 Dec 2022 11:22:05 +0700 Message-Id: <20221219042209.22898-7-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-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=WY+LE4Uwh5JcjEow4gYNYbipiHLpv95jOJMY0+5U34E=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn71fJaiww7539/HXxqIn3C+/eS/vd6Yu/Gpqw6WMPKkb bl4ZHaUsDGJcDLJiiiyTEvmaTu8yErnQvtYRZg4rE8gQBi5OAZjIXheG/wnKDwPkTj3+u7Lw195Dd6 /bbN29cslWj9BNfq5itgw1HA6MDCeeahssk5yXulP18q5tq2oS7uZ/8lmlmDfpCae0vWLIOhYA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752614971426466750?= X-GMAIL-MSGID: =?utf-8?q?1752614971426466750?= 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 642ef0bb20380a..3b365a72996be5 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -149,7 +149,8 @@ specific data structure (mem_cgroup) associated with it. 2.2. Accounting --------------- -:: +.. code-block:: + :caption: Figure 1: Hierarchy of Accounting +--------------------+ | mem_cgroup | @@ -169,7 +170,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 Mon Dec 19 04:22:06 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34391 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2188135wrn; Sun, 18 Dec 2022 20:25:24 -0800 (PST) X-Google-Smtp-Source: AA0mqf40U8Qlqkia/GwgdQvbwqlyfER1Is5wOzuwYfwMyr4RasKYK7RYY2L4sJfM/wIJB84Sb7bu X-Received: by 2002:a05:6402:104e:b0:46f:a73d:6bdb with SMTP id e14-20020a056402104e00b0046fa73d6bdbmr26766966edu.25.1671423924442; Sun, 18 Dec 2022 20:25:24 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423924; cv=none; d=google.com; s=arc-20160816; b=TvO2dvdt5yIZGozv/0SwqGeixwpNeUOf7OP7Gg3kfiq0EVS6pCAbb51C+Z2GCJzDqV ZHSNPozdsHaFh5rINwmycAE3fPWN2AafEaStYP+4Q603zrIb8DXtOpy08qIBYucP8Zbw HBVlKsc2JZq4m3B4Bm7VzCTZy+hmlIocmod8wAF8zijOSkkibfSGnetobC0HcNX2PWSf skHkE4KyArkMfd39PNYcV9LBBsR8WLHC/z5nHd3i7ZCMCCHTfd7KQMHsD2o1hG9KztdI LdMsPC3e7FQTpK419+lofhJLThlL2LwvBqSS+jyPPbIe+xSI+CJxvS6y+4i8jcoNHh+3 Adfg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=lRDhbAuFFMtCfx+H7ZJIpQoYnynck5HVInZvHowpBNk=; b=pqcADAt5TgME7x0YSO/Ie4y3cgA7BQE+N4SdOfONUpNf68fIcJ9CG9a0VHj4RMbDT8 eYfSiMs9R/4mbsylHBR2ESygY4VnH154J79BDsQ0WxJB9npZUQqWuZp/qFXqQSPFL/JL lcjtDdcStsh3nmLSMBdo0M9oyGdFvn3yeQ1zjcmMvdkYogOXgk4Dm8kIGL2xhPSG1erB AvQM/lU+/OdPhgh6QW81VfEc3HsqTOIvdh9OFU9umi4GkqA5eCZIbukVxbsk2AM0Ht4k 6+LLC4ysav0GDr5fOSKI/SEqlhKIbGrB3DLL1Ya1LIsy4xgiiNFvy88yvxYTKuQlERM4 skbg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=aJ8LYUEr; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id dm4-20020a05640222c400b0046b4ea89826si7245950edb.616.2022.12.18.20.25.01; Sun, 18 Dec 2022 20:25:24 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=aJ8LYUEr; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231429AbiLSEXr (ORCPT + 99 others); Sun, 18 Dec 2022 23:23:47 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48388 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231347AbiLSEW0 (ORCPT ); Sun, 18 Dec 2022 23:22:26 -0500 Received: from mail-pj1-x1031.google.com (mail-pj1-x1031.google.com [IPv6:2607:f8b0:4864:20::1031]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8D6A465BC; Sun, 18 Dec 2022 20:22:25 -0800 (PST) Received: by mail-pj1-x1031.google.com with SMTP id u5so7819873pjy.5; Sun, 18 Dec 2022 20:22:25 -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=lRDhbAuFFMtCfx+H7ZJIpQoYnynck5HVInZvHowpBNk=; b=aJ8LYUErJn/ZPG6EC26fQcgCJgiRXAOf+Wbw+PidOOWMUaiVUsUcSgo8htcy1YlFQ7 5bm1d9ZM3R2uYEKryoIQ4t6aV5PBbAJSRU1yzOikLW9IDPs009uccbn2P3EEMCtnWvJR +CyqWbBcyowHmuqUUkGyOLvHs1ktvjGk7UMvLkomuT7rgqpvddtVJC/vMnYvTDSX4Uz9 unhqp0K6PAkA6+9AIErzHE/RGpYjG/w/jfoTnxq83m5DMytP1sh8csjErB9nFyUidNm+ woDrW5wk2XJcVeUrU1oFu23rb7xClFXHHQdRWDYcarrITAEVGSjXIOwCNx5JycJ7tL5+ /HOA== 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=lRDhbAuFFMtCfx+H7ZJIpQoYnynck5HVInZvHowpBNk=; b=bcywHCPh7axeisrc5YGteKjrtZDDc2NLkxdQhJ/cObMs2wM+7UBtSDJnYAvItExPhK rK24tm+V40xE2afERfITvPPl8PMyvfEhUBENcGIElxGYJdQ8HfIekVP7L/oYjIxStsps /By5+61R+BWGP87bqggWFDzBxoaZNPRmFU5ziTEVOr6DR4aP3zAeSEE8sz2WwEmni/Al /4Toa1JAsouSz2BsLKJ2emEwSupT8xVfiVCBSatRH9s79XbrmjZOiZ/6vlOXJpv4MVMW 5r2ip8++DUutYrmgMqaAF3kFf1pYymx5e7BGst9W9ClKLjKq/oloV2rbWPb8wgimntn4 9GjA== X-Gm-Message-State: ANoB5pknj+buOToeQ6E8bZFIT53p3muC56dS9v0gYtbm/Oi7eouLEFhF 7sCUD1kQkJ1yfx7ip6ul2VA= X-Received: by 2002:a17:90a:1b0b:b0:219:396c:9e32 with SMTP id q11-20020a17090a1b0b00b00219396c9e32mr43342946pjq.16.1671423745034; Sun, 18 Dec 2022 20:22:25 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id nn11-20020a17090b38cb00b00212cf2fe8c3sm16638727pjb.1.2022.12.18.20.22.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:23 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 1437210164A; Mon, 19 Dec 2022 11:22:14 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 07/10] docs: cgroup-v1: use bullet lists for list of stat file tables Date: Mon, 19 Dec 2022 11:22:06 +0700 Message-Id: <20221219042209.22898-8-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-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=Qv/IUrGqp6BPq2cwpkOiVBXASeOlAsriWizhHWQnHq4=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn703LdK1T/66R/jyZrvEyVzW0yr0r//Oum3vofGLRydv z+/ijlIWBjEuBlkxRZZJiXxNp3cZiVxoX+sIM4eVCWQIAxenAExk+lVGhjki233c9qqJ3Zpyt+jn+o gkR7uyW9yffms/71tXPOvhEVZGhmurJaxWvK0rVNIV2j5n64a4vZzP7l50Cfn0u+h7TswiJh4A X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752615012833035200?= X-GMAIL-MSGID: =?utf-8?q?1752615012833035200?= 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 3b365a72996be5..01104b459b4cbd 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -521,60 +521,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 Mon Dec 19 04:22:07 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34393 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2188182wrn; Sun, 18 Dec 2022 20:25:37 -0800 (PST) X-Google-Smtp-Source: AMrXdXt8gNYcozlTMCa1UUSsGfZaVY25jJ2rSwLWxj6/VDqgRYvsXnnesiP02ehMwl1+dIdVJ53E X-Received: by 2002:a17:906:3bc2:b0:7fd:ecee:c8ba with SMTP id v2-20020a1709063bc200b007fdeceec8bamr7754535ejf.42.1671423936938; Sun, 18 Dec 2022 20:25:36 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423936; cv=none; d=google.com; s=arc-20160816; b=DuALcw389sW8mqSVHmN8EVTdFXvyTQStfD0bt0duNiospelUXOIWq5CdNw1cwaapno q37I1Gt7Kw9dvwrrO8KXOmjj8LwYI7Rwp05to3eMKGPdsDHSZ/WUTeCBaMcf+r2vEXJ3 xX/vngKfzi5bF6YBDqyEYKWecfnlAKP0O/oMqpkucS7R5bi/8+9A0xFdD+9RKCpcG7/N 7YGUM4BfIP7bRfid2vZFWiGhck2aKY1OIQ17shX7EOBuY9+Kv6kxzGJAopt/YcBNL4+1 sshQdDuMb1xXksqepMZzJWNluXrauLFvgzmi5/zw16FhA9IwnJ/YfsbekDbUYEYnwr7Q OkKw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=agWt8CECL43NEhVRFwvhtAXySMNGigcHHGw9DmNksyg=; b=r9E+2WkslhaPr+R6H6W6jk8vWCP6sweccZ6q49eceWSANg+usKBqgmmy10co23TTWo ziEfINNykvs29bJrlvZ2+HxMKm3zCaKyBleEzebpW8eUB27aXnhA6qvkl3bkdx9viwcN 5d7KB0rcynb29vkEPSt/PO25X3ITdRwIAs7wZyl6C2g05oFeR11T5Uxxyr7ekrl0yIkr dO7OL4TYhuCyJ9dFGfSBrA0T9HiQZp/bqbXXETV5rRVnJI22lxLB7dp4fepjun7yCUb8 rwdUYyLckgQdchN7+5GqLJYag8ELbf9YO/APH9EWB4waIaJrWdcAURs9hZhI0Grfdqus VN6w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=Rw+DM6QW; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id c21-20020a170906529500b007c19ace9796si6714053ejm.940.2022.12.18.20.25.14; Sun, 18 Dec 2022 20:25:36 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=Rw+DM6QW; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231128AbiLSEYE (ORCPT + 99 others); Sun, 18 Dec 2022 23:24:04 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48358 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231344AbiLSEW0 (ORCPT ); Sun, 18 Dec 2022 23:22:26 -0500 Received: from mail-pl1-x62d.google.com (mail-pl1-x62d.google.com [IPv6:2607:f8b0:4864:20::62d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2024965BA; Sun, 18 Dec 2022 20:22:25 -0800 (PST) Received: by mail-pl1-x62d.google.com with SMTP id d15so7857630pls.6; Sun, 18 Dec 2022 20:22:25 -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=agWt8CECL43NEhVRFwvhtAXySMNGigcHHGw9DmNksyg=; b=Rw+DM6QWhhdQXktWp+em/fBiFTj3BUilx3MP8RgeQvvsMgLuECpixEMst4FxDtn7zH rAtjr2VM4z0g7bvXq3KMTUQq427rHE6DpnzawpIYLHC4ZJe5B2U5vgtq/CW3nPXjtUXL EOTbYjZFPwUdqOlRePgXbAKfKz3l/dBEmZ/BsZAW7kFA+JnMNfrmriDf/smpetfVAs8V zlEYA+1aASqKs5fLj9Ca+PsuWMPAqfGTOCRjtX4FPTomYaN9JIrxcQ83tuhIlGF3dTo6 tPX6UhACp5qTOwk+LxN3dvDkAeg+v22HECunwHxAfPX9gvjE+loAvHbiB0LNKPyfzp2b PG0Q== 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=agWt8CECL43NEhVRFwvhtAXySMNGigcHHGw9DmNksyg=; b=ZUsoY/D51Yvu1FG8IcBtlP6jdRo3nfPdVvyKxNqe6bTOxBX8/0G6ITdRp7s1BxUXQQ aMiXK1L7SBj4+wiB+2jbx6bfTD6P6jByji7BIBc2R/AKFmXcTiuKioCnxXIqL7r+MB9f U7yVYySA1bdU4uHoOKIUHnYIX030MKqj9nhMo+Uj91LJKUSy+CddzucSWhu2/8yXk1dY FjUKfnXFN6P+l7QMGLSSmUi0tMGZ0z7jQAnUqL2w5zPCrv9L2Udoj5CAPrHBXdwH/c4u hUe/YTMorZc3dQiFEVoUPtZM7q+Hea/OIMjwLO4JOkOzLnto1PQjcJzV4m/T30ZDSEma Up8A== X-Gm-Message-State: ANoB5pmqaZFzUvqeYZkDhNLGhYFyJEYhCIGPL2HEMw4NIXGldDQS9sEc 5oAy0NDNmFytk3NRY1K0HPU= X-Received: by 2002:a17:902:c183:b0:189:854e:93a3 with SMTP id d3-20020a170902c18300b00189854e93a3mr40668144pld.69.1671423744594; Sun, 18 Dec 2022 20:22:24 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id z14-20020a170903018e00b00174c0dd29f0sm5897250plg.144.2022.12.18.20.22.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:23 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 669B810405A; Mon, 19 Dec 2022 11:22:14 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 08/10] docs: cgroup-v1: use make swap extension subsections subsections Date: Mon, 19 Dec 2022 11:22:07 +0700 Message-Id: <20221219042209.22898-9-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-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=YB2axwGgINIOaNnBOhZC/NJ3W2+BU7qyWgI/kX2Gj+s=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn33I21Y795n3xfn/orzeP5p9r4RP8LZ3u0nrvSUhWSsM Gs4s7ihlYRDjYpAVU2SZlMjXdHqXkciF9rWOMHNYmUCGMHBxCsBEHv5jZNj57tBtd/9bL4qZdyzn+b l3XeqJ8pQY9pMtkqu/q8zcUvyfkeF0rtX/9u2rLSbq3bjgea+r+adr3/YLwY3svLk39z+RXsQNAA== X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752615026153858457?= X-GMAIL-MSGID: =?utf-8?q?1752615026153858457?= 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 01104b459b4cbd..863e0f17ca0067 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -246,7 +246,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 @@ -254,7 +255,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 Mon Dec 19 04:22:08 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34394 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2188215wrn; Sun, 18 Dec 2022 20:25:46 -0800 (PST) X-Google-Smtp-Source: AMrXdXuFnOV06h0iVWiTv4B9NOlWFPPZjdrreByu3A7YGwNzxJxSOZ921tbAa2Drw1nB6sQLmPm8 X-Received: by 2002:a17:907:a0cd:b0:7e8:c8f0:67f7 with SMTP id hw13-20020a170907a0cd00b007e8c8f067f7mr8127172ejc.38.1671423946240; Sun, 18 Dec 2022 20:25:46 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423946; cv=none; d=google.com; s=arc-20160816; b=0I0teALEHl/hLcn/L2yb9o9LihAkH35xj+rO14PHx9wNg+IbgqGE2IAPXuH2HCKXOm XbrEYp/JDGhRr2Pl7NqC+WDCMDkWMw70j8uUBo5z7JdmdicSPp7ty6jHtLwM+UXwzI9v posnAySHho2tY3ec1CURHBRVrd+3N0Fmlapo94FznI3mSk0jWAMt6iPmhnS8f8NKIgbv R8hgTCnMepMD+MIPqKtys1yd7t9t+zUSQM6cIYqTR/+Sa2yyxvg9VOlFq+Vd08se1WKl fNtsEEhmlYSECCZDt8BYsCEuh7XiWdEOh0sb2lPD4Pc2TJDe9b9e25o87cPFyauImcYW YHTg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=m1lEXUxDv+RQRfIU+EhWl1xsmh7T8TN0B09r+Rt+f6E=; b=HGU8bGIP4L6NnaP+8hfwBnRCNAZb4y2qUvj5LJfmhj+o1bOx2N4z7mJLFBKovbmWiS gyZ5pPBslPizQjThvMv0oFdtNV1GXSr35Vy83yM+2Lrz+X4qD3SDqMxYT/0EE48NEbrz 7fUuNXF4vCCEvMWXUAwEmtvTH6KBoZGyhbxSQ1ln+giRjxOD7HZZTaotGtt60ORrtAXV 02iRdB5CZdLtywJB4UJjQ0tCBHT7GbG4zGq4NHiLqwBgAf3/8HJKkF5vL+4EA/5r+34b YA7RLNRpL/u62u2UUb7kE2o/z8rTfvxy6uPIIO3ofq/9O2UVuYDXCnw5Nje7Lau7CJfS A6CQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=mRDBpTfs; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id sb16-20020a1709076d9000b007f46a3735cbsi6231039ejc.172.2022.12.18.20.25.23; Sun, 18 Dec 2022 20:25:46 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=mRDBpTfs; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231497AbiLSEYN (ORCPT + 99 others); Sun, 18 Dec 2022 23:24:13 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48406 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231350AbiLSEW1 (ORCPT ); Sun, 18 Dec 2022 23:22:27 -0500 Received: from mail-pl1-x62a.google.com (mail-pl1-x62a.google.com [IPv6:2607:f8b0:4864:20::62a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D3758B7DC; Sun, 18 Dec 2022 20:22:25 -0800 (PST) Received: by mail-pl1-x62a.google.com with SMTP id d7so7839293pll.9; Sun, 18 Dec 2022 20:22:25 -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=m1lEXUxDv+RQRfIU+EhWl1xsmh7T8TN0B09r+Rt+f6E=; b=mRDBpTfsKGJFj9sStOs+u6rafPXo1yrNY3co/JxzhxWdSf+Ee9lJP+AcKfTLxqHGJ7 /ruFXJ54tEJ4/+rcvJpAXQGBvu8w2UNqb0qeXxzf0gv8Jkp/oTNCrG9/na5e2adVEq5C WuJOTPR+DvmUilQKp2CDo8N0Cc5zHA/oHv8XtyTh95Op/bEJ3NuqFA7gFCBB7/YTl1bk h8H9Tdq13+dru7pjLYX0hoC91Z+4PFfcpUS8bKiUP/j1BA+kOvIF7kF1ElNq7ehaveTa 5BiBrlFzSwLanGEXndk8Nv7qoHt5phcg46YAkWLGp+UfoZmPVmgbEzGUnf4RnmEo06ab 3+2g== 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=m1lEXUxDv+RQRfIU+EhWl1xsmh7T8TN0B09r+Rt+f6E=; b=PO/K8LULBP3GcnYr8nZgxpOmmkmF14R1oTVFcZ4gUdXqnGWF3svggDYkXwCFUJAJo6 1IqmM3cHUW+1oiZiRplIxoJDpDLKV45LDBy13GTsjV6tLmpDlrSva2R0OSGGW6+XQ8eH 2jaTSfW46s/65tDlTOJA6XIxkEbcZiG7P0/rVFrhAS5diaaTzL1J8eyseMwAnPXe/wyV 2lPPrKSBiW8DDNtOD2KdauN50yd5/TxV+HpEw0wlBmyTQ3PRjRDDxSBe7a5lCx7bl7rr XpiL2E0Nch4hbV4A6WXoJSRIw9aZ4rxUc4ELn+kFKRYABSGhBRWPEKXelBPznFCU2B/0 a5Dw== X-Gm-Message-State: AFqh2krFR3LsXaMN+iFPTFHiiwdDeDKPaaZ2zO6loMyZevP9cIxsWzNq cT/so75CpSt4GYC/vqr0u4w= X-Received: by 2002:a17:90a:b384:b0:213:b6c8:2295 with SMTP id e4-20020a17090ab38400b00213b6c82295mr7583508pjr.22.1671423745509; Sun, 18 Dec 2022 20:22:25 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id b13-20020a17090a5a0d00b0021806f631ccsm4817086pjd.30.2022.12.18.20.22.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:23 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 87729104054; Mon, 19 Dec 2022 11:22:14 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 09/10] docs: cgroup-v1: add internal cross-references Date: Mon, 19 Dec 2022 11:22:08 +0700 Message-Id: <20221219042209.22898-10-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=5927; i=bagasdotme@gmail.com; h=from:subject; bh=9S/rkKjh7S+VIO4A14dIVvNcepKziJ1wiMcg1+yyND0=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn33w62KZ2zBTurxBrqKy41HuS1ff56zOJzwbQ/9xeLTv dD3XUcrCIMbFICumyDIpka/p9C4jkQvtax1h5rAygQxh4OIUgIlYGTEyvOj691Dsls78a7/0WFe6uD IcOLpg2rH2CUdm9buXrS6X6WFk6Jj/+OPi+BmnM//9uHV+710Pl3/vj6/KOTgzaOJd5+dMz1gA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752615035553619615?= X-GMAIL-MSGID: =?utf-8?q?1752615035553619615?= 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 863e0f17ca0067..ae3a1d3873d73b 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. @@ -223,8 +224,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 -------------------------------------- @@ -272,7 +274,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 @@ -286,7 +288,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 ----------- @@ -303,6 +305,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 ----------------------------------------------- @@ -462,6 +466,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 ------------------- @@ -474,8 +480,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 ------------------ @@ -486,15 +495,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. @@ -721,6 +731,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 (DEPRECATED!) =============================================== @@ -750,7 +762,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, @@ -768,6 +781,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 -------------------------------------- @@ -817,6 +832,8 @@ threshold in any direction. It's applicable for root and non-root cgroup. +.. _cgroup-v1-memory-oom-control: + 10. OOM Control =============== From patchwork Mon Dec 19 04:22:09 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 34388 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:e747:0:0:0:0:0 with SMTP id c7csp2187997wrn; Sun, 18 Dec 2022 20:24:51 -0800 (PST) X-Google-Smtp-Source: AA0mqf5Qv+QSpq+LCajGvBYFy9l73LKYo1gcgFAHVB3zsCc70smuhxqznvZNtNgcjfUbRwr9wBOB X-Received: by 2002:a17:906:fd53:b0:7c0:a247:2f3c with SMTP id wi19-20020a170906fd5300b007c0a2472f3cmr29532659ejb.1.1671423891386; Sun, 18 Dec 2022 20:24:51 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1671423891; cv=none; d=google.com; s=arc-20160816; b=LZ4dtQ/Qn2xnXUKuWptHuVOQpODbt3lGUR/Qiwd+W5S4kFYMh8OeRKiore9Rvkiuul fV1hLFhghENMSMXSALaK9cVuSvUlxzgSjTo86BJOVtlqQPhSmzwJ/2Ae7LtTzWI/OImP 9xV6jAgxqqN1MFz1zJHhZQNjB487JjGrZR63yyt0Oarnw5otBotccKKXfNNGHPEcKCCy JxTXMRwKZ2eAVb0wbMOKq8K7dqavu4hO76xwE1ASdQ5oXdkLBpLFMP4HHgSSeJL+fi26 RzPY+pDQXBg3vRBo9OW9xw9MSPRNqYU8zTM/Prsfr+bO2TkI/PXE43SmxOt5pKOBQNoY xe5A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=2eJ0PgV9osw1yzCFjYcppkmXI1mNsCk3sVd7FF32JKk=; b=FOC9D7ZF2DvCx3h+zVc/cMiMDRmJYAcPcwYglo10Mq1lSNiVIzJcr3F5JKx8P0WnRN 4umpqb9eVBds9gbVyoT50E8x8+BYUz64UYXDgqFsskDDttZp/b4cQGcDniuRTHZWwztB Pz5QlJPcWa7eA0hgecIxy8HdjzKS1PQBQfOpev2kcrjZfGEFvmz4adwglmkCNnZU0Oxa By3lJ71lQi2rCOlspmc9CcQaigeDl9+GIA+cPnjz7PVDtBvmMCUW6KcQo5MGvWWuTgoz noJG6v2xxa3RIyicbArIwVh3QwdIVsgv8TQph3zne0KknL9SrGpkozHZAYKoDuCcbEXf 1D9g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=DWj2vrOs; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id sh39-20020a1709076ea700b007fed8db38a8si3892759ejc.114.2022.12.18.20.24.28; Sun, 18 Dec 2022 20:24:51 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=DWj2vrOs; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231421AbiLSEXM (ORCPT + 99 others); Sun, 18 Dec 2022 23:23:12 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48376 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231341AbiLSEWY (ORCPT ); Sun, 18 Dec 2022 23:22:24 -0500 Received: from mail-pl1-x62a.google.com (mail-pl1-x62a.google.com [IPv6:2607:f8b0:4864:20::62a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 89ECF65AD; Sun, 18 Dec 2022 20:22:23 -0800 (PST) Received: by mail-pl1-x62a.google.com with SMTP id d7so7839247pll.9; Sun, 18 Dec 2022 20:22:23 -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=2eJ0PgV9osw1yzCFjYcppkmXI1mNsCk3sVd7FF32JKk=; b=DWj2vrOsmcNcemOcEX+STJ0rY9zglo4HAd+kl6qkuHXYj1Wn+icY7bqhzZvQZPEXZq q2GE6FnBygHaxi5XvVdiki3g+eQJkl7gjZr1Q4aOMaIIXj2g3RiKjVlAvHdORhkzVuS4 LKCmZkz7m3E1QfHnWerxeT51zEUy73Fa3T0MnAL2nY3N6bvLyTDW6zbbK3pew4Out7Z8 jjk1A2g/g70jdwVtmUF1V58q7Edd24yVBJgNwr+kfc2MrzW3xE/q5mUuXT3zwr81YB8D 3Nk2RzYCxxS+IpdEdLaruJm43t6qLYaz2ZiHbbSop+4Xt9I921ssalMCYn48uELg73fN NQpA== 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=2eJ0PgV9osw1yzCFjYcppkmXI1mNsCk3sVd7FF32JKk=; b=H8fJJDwoFf8MoP4bs39YEVUJmh+q6PsUEzZJuhWhF3kr9ppk3ixxU4fj5Dz37ea3Sw QC6ENsX9XqFbyzHER/SwXBQi9hf53OyTbHmQsfBs/hyfC3rf+mK4A2rR2XmwEmJwr2Mh o3lk8D48sOKoTxpIwZFd3wddD65g+fqi/uTjozYZcKfUxiOjfRFnvaeW5CfVQC3XOTi2 1r3W+x8OUS/DQR164YTMKu5I+EOYAruT9zIjesUNUn5VdnhfY4Umv9BqmokK90hKogYu 9T1fIi48tqcPWW4wNb4XAqUaf1qzCUL9qbfGuMnSLZNfeREwGb9LOMtfy3H1bmCCxXJU f0Rg== X-Gm-Message-State: ANoB5pk0MadVFRLY2HLROns3yUDRnFBDdiCaUtZvB2yGauLv0ceKnJFd Fvk44EjibODXbR3bMdmvvpc= X-Received: by 2002:a17:90a:d24f:b0:219:251f:d92d with SMTP id o15-20020a17090ad24f00b00219251fd92dmr42619785pjw.9.1671423743042; Sun, 18 Dec 2022 20:22:23 -0800 (PST) Received: from debian.me (subs32-116-206-28-20.three.co.id. [116.206.28.20]) by smtp.gmail.com with ESMTPSA id h22-20020a17090a055600b0021e1c8ef788sm6768182pjf.51.2022.12.18.20.22.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 18 Dec 2022 20:22:22 -0800 (PST) Received: by debian.me (Postfix, from userid 1000) id 50B64103F77; Mon, 19 Dec 2022 11:22:14 +0700 (WIB) From: Bagas Sanjaya To: cgroups@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 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 10/10] docs: cgroup-v1: use numbered lists for user interface setup Date: Mon, 19 Dec 2022 11:22:09 +0700 Message-Id: <20221219042209.22898-11-bagasdotme@gmail.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20221219042209.22898-1-bagasdotme@gmail.com> References: <20221219042209.22898-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=haqtoEyuEFE5UnwPbflPC/PeHSHq/t5MqztTHGRMvxU=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDMnzn31Yu6nM4+SR7DS266m3vv0SYTkjskqKnT1/2vb+2c+E 01fc6ihlYRDjYpAVU2SZlMjXdHqXkciF9rWOMHNYmUCGMHBxCsBEtCIYGSby1km+5D6Wv99W4+3DqV 9jop/ITFCZJ+BRZbfuSIH2LT6Gf7q/dRxd+6+pLdU36Xr6wNKyY9lSKyVHrU1bSjdLNW26yQIA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-0.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,RCVD_IN_SORBS_WEB,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1752614977925457020?= X-GMAIL-MSGID: =?utf-8?q?1752614977925457020?= 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 ae3a1d3873d73b..8cd46525b19c2e 100644 --- a/Documentation/admin-guide/cgroup-v1/memory.rst +++ b/Documentation/admin-guide/cgroup-v1/memory.rst @@ -389,30 +389,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, @@ -424,10 +424,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::