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: 13076235 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6EA32C3DA78 for ; Mon, 19 Dec 2022 04:22:28 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 42F0F8E0008; Sun, 18 Dec 2022 23:22:25 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 394B98E0005; Sun, 18 Dec 2022 23:22:25 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 149BE8E0008; Sun, 18 Dec 2022 23:22:25 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id C22128E0005 for ; Sun, 18 Dec 2022 23:22:24 -0500 (EST) Received: from smtpin18.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 98261140A5F for ; Mon, 19 Dec 2022 04:22:24 +0000 (UTC) X-FDA: 80257759008.18.02B85B8 Received: from mail-pj1-f49.google.com (mail-pj1-f49.google.com [209.85.216.49]) by imf23.hostedemail.com (Postfix) with ESMTP id CCBF5140004 for ; Mon, 19 Dec 2022 04:22:22 +0000 (UTC) Authentication-Results: imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=VVMSfTlU; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.49 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423742; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=rf1ACU1p6R9dNKmN5MUoIBYgA/aDmrGTefWeFw4FNFs=; b=lE5nTpDzQrn6HaCiu0uaW3A2wsRWxrC14hDmOq/tLWTGwIrPoh0UZIezr+dCyJgH3fojIh QBJobBpgKVyTSyDVjh6sMjZCFHrWd7hYJG7a+pt/6jgBla5O4pn9aoRh6g4R33R146nkcX +hwVkoQr9+HN3HH9J40fTc/XZ8axaPU= ARC-Authentication-Results: i=1; imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=VVMSfTlU; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.49 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423742; a=rsa-sha256; cv=none; b=dUN9NigaqGaUUJvwx2OxDaDVuLuMxRwmv2qM+N5cf6HhWaJXRyJKK48xaGF3wjQJk442GR 5NcYBoms2YcFARz1BAwNzINt/nBNQj9fY8c3Odipv9RMrro+z0dTUkxjBGsBiZaarGmrVq eIeitTbOLPZgvo8KdHjrdRZwIyGrSj0= Received: by mail-pj1-f49.google.com with SMTP id q17-20020a17090aa01100b002194cba32e9so11754198pjp.1 for ; 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=PJC+39TblHJ40OQHh4m0Ezm3EC0+6G20pVOTnBTD/VCVSCIP0Yq9a4ZhQ4IYA+agJ3 VlPu/xcOu9dFExzYP7xMWy/0nHQfcbxlndJnATRs1u92Z3fOKTzGevOV2+XooLsxesIp bRkwvvltuLC0qIl3pjy5Xx530yo7+mQp78pGNe9OJLrTJaP2VEeHe6fqJvQb2K/irFrf j51wpKrLydoGEOK0GEjxti+IBGlVisR38B6RjoPDyoFJ5xlQLuYO5un4wl2xWb8b4o/0 KUi068xpd/ASXtXVGw6ZfiSEqtrMbxF93bobnnchbNDsJcDU2PRIBlxsn8xTE8VofxJR oBew== X-Gm-Message-State: ANoB5pk1S0nqLB6Mvuv8FQUn5Wz+xP22YbIpcWzDPKIB48zlEgOIOgU2 pqU5rQWdh8iirVH/DGSW00I= X-Google-Smtp-Source: AA0mqf4hJrb1IMUCZfOeuiwBA1GJDdg+PA3U0hxFCMyXPUKIjGvqxIvxN+tzPJNknaNV1Df+ifL/1w== 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-Rspam-User: X-Rspamd-Server: rspam02 X-Rspamd-Queue-Id: CCBF5140004 X-Stat-Signature: 8qncji81f18i9kt4wknoxipm88xgedeq X-HE-Tag: 1671423742-674440 X-HE-Meta: U2FsdGVkX18sKoAkjY/5rX19GN+GNBJ+356Tzo8Ui2Q7QItzuUMRyjKlbtprxCc4YQgVfhth9JwVQ5IeSmvBDLiLwUGftu8Y+Po0m1dsmokWCbQCmaDoaaJ5DY0+OiIgEucydWV6pBoNCg9VOxVpwfcG3IU91mLi65B1tf9+I/33dwQL6C9TEKZK6WxOBeCm89lsUmKnZDndS++mRy5L/JJVYm75j3/95bH7GyfQgLEGYv7hXSBakt7Xz9bRSXs5PBK0nP5aMjwjrEXfXADck9ZeQsIjcpf/hGBRapZGhHMl4axXef+Nykqw+hEOO0dzCkHPrh62gv35vxukw9r5SbY8WRmTh4l1HxniswVBLECTkdG4m4ZDoHCg/pPr8aei7D/bnwviNl6TRqkQqVH8V2Tz0k0hrgntsyr4DuRUKoB4Wyua9q9aT1kuQkbGjKiv5v35MPG01ACjHFK5B6W/F2uhjGbodAQI/kNdXLSBmBcVzeHrFcSCV+vB4Cx4QSmoFVdXYI8dJGf6+o9RgsTD795NCttm1uXzfYmCx9LEpo09WwiwfMkK5fG3wC1jMJPbdN8b43ELEj4cychP83YIeK/k38o1T+KQlBkT0WM+rcBbhpre92/lKVQYxOPjBy+wpAPz3cMwGamwOvrBfywAUQANeq525SJlNoJwW2Cy3qGHuf/aacnxSQ5gMO1czP0mQOjfKPqQuZFTLCtoEib/U+1gpJhjGvcpFpK2AkLcBzalfIDOnHnu0vx5EFkCklQ8GRuRp2pmft6KW9dyU+OYQeddpU+Yk/LXVOk+SkrzyCzxYitmb3Z7us5dbY3oeMy41N0A6ppdT7DtChX/dZuYDGfgP+HSrZsYWSy1CzEsrGkSX1lCF77Ckt8NAdk7ppuG99ZT/3gp/a31CWSZgUsOpV7Q0A5fFQtsKJ3MrRBXu53HnTlektcyl74NVSmxAFAK2uzbLZTZMG2RQADrdk0 r/IaXKuo 6o8i9A3hD+uwGCQhBPVhvnO9R7+ROf+YnKW6IUE5PEb195QD2LJWQIsqFxavs04QV09PWKRkF6EduIWzWDtz1/Z5+gcQv7AAIL+pipHdVkXximQoxlbOrXng22Jjyqs4jAuNa X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: 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: 13076237 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0F6B0C4167B for ; Mon, 19 Dec 2022 04:22:31 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id ABF078E000A; Sun, 18 Dec 2022 23:22:26 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id A21DE8E0005; Sun, 18 Dec 2022 23:22:26 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 824308E000B; Sun, 18 Dec 2022 23:22:26 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 659AF8E000A for ; Sun, 18 Dec 2022 23:22:26 -0500 (EST) Received: from smtpin15.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id 2EA72A0A88 for ; Mon, 19 Dec 2022 04:22:26 +0000 (UTC) X-FDA: 80257759092.15.1040712 Received: from mail-pj1-f48.google.com (mail-pj1-f48.google.com [209.85.216.48]) by imf06.hostedemail.com (Postfix) with ESMTP id 6281A180003 for ; Mon, 19 Dec 2022 04:22:24 +0000 (UTC) Authentication-Results: imf06.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=U8mV2UMq; spf=pass (imf06.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.48 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423744; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=szBp/K72BE8/BicOSwRE0ZIF4ays06I72BistI/53Pk=; b=MKeQtfBQjsfl6m/u1AHYJQi4zK4KyGcUI5yEitxzGaqAk5x7PR7nde+iY9pYvcuXcMcsSS PqeIClbQJc3C43GeGsnYt56klrQTMCUC6UEGPA/CyIbNkNOa9nIyvbQhyJzmirYrLSpLdO 6pqO4clGacc/PYDbnBWNhsfD4duzEdk= ARC-Authentication-Results: i=1; imf06.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=U8mV2UMq; spf=pass (imf06.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.48 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423744; a=rsa-sha256; cv=none; b=r35V/BKsWUWFbV/M9NQVq4sU3spVIaURyHaa+wzdyrelHXGPFrCIKuoBu6k8VVAzAxw20X juDUCtT0CF75RdPEbe8r9nWG0vcUS9aZOtyzS6XIVYEDExAI0M0iMBEFsbcO4McvRd9pTy nRy23rt1sMrkvV7RkGMr/q6VM5/vs/A= Received: by mail-pj1-f48.google.com with SMTP id fa4-20020a17090af0c400b002198d1328a0so13200656pjb.0 for ; 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=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=t8TBmKXo+wPyE9YA+Aqczt7K6V32tKgHEfKslGK+vVdMKvR3+Ho09srnqfg3P5w1qR xQ1ERwFhE+kqhRajNxZedneIOTIWrNbA4SnAPCTtny74GsaH4kifUmZ8vUs5axVsj4YZ DwEk2vtNXYxFQ1tMv+KFeQD07orptcL6HxrbVfnhUsFDMQlkFyX9PKsCpAOAF+j0C5Cx vLriZUvzeMAlJ+xF338G90JYLHZc5q/GoYYL1MKYz8Yesv7iGha6BPs/jSihI7ZRqdku RC3wuAnuZRRztMTNkawz3Ya7/qFSpTfb2Zq1P/R/p6JhoDpz31SkUXXy/dKWzeKHOVaS bLvA== X-Gm-Message-State: AFqh2krax1gof45+1xZ3BLYny7JBVhve2eaEez5pCc3zse+usZjM48uG NDyTU2nMRNQTsH9sdCscmnqSLtnHpZE= X-Google-Smtp-Source: AMrXdXsaWnf+YsPfG0kbNpKSn0wN8/z9T5tw2wVXv1UitQlm7avF6zIUjxIy0Ns5NvJMeue6JNod5Q== 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-Rspamd-Queue-Id: 6281A180003 X-Stat-Signature: wtc9ins4kdpe4ry5bxgh7zd93fapx3mw X-Rspam-User: X-Rspamd-Server: rspam08 X-HE-Tag: 1671423744-867307 X-HE-Meta: U2FsdGVkX19NrvygFWXdBP2JQEulu1jKbV+72tA3JVyEuGisgW6vnlV2bkDluPLWjfJEQ259QJWxOx9l0MEhVnc6jzvrH/HlYom3n9cjQusOnS9f2LlwUkfly5s1FYKKPxbFS/oxhykycp2ScjkbsRLTcgPzNX395IT381FDZaL5dyB1hmrx+I8oPLmo1j4655u4TskF1Kh8/m/JMyGRXkvg50Xi5beJtEva3BLGufAfJNLHt845uB+j/qYPb3rdfLRPaEN0fEyXOTDI7B4tAh+YUz7XmU7ZkklzJjKxrnUAuVs4lRsEHki1DGYks17h87xd5dMdykHS3yU3ACJs+0rmMltU5nCG0OXzq7H63El39c3C17oOtbbq0G+1TX/uF//UPb2iTLdjz4M48vEUeL0aXBi84g01ALSVCR63oMjcJn06RERVMk0Q0wxx/Fys+YI6Xpgor7NuF2nRCMfoj70W3pWD2tba4eaqy4mG8mN98kf5voZoGW45QL10WAR+Iev2vdwwTCBbD/4iXcgnxdCRBeJX6iL6f3Us8Q7F34lPm4jLzRWdv0CCGie6CfEGtPcqCnD1JP/jewq4IK7w9JuhWynDzQH5mPtXXJ4bsjdgkiImEZAHgKqV8Huwh6dp6Pcu+QjXaU9TWYomVXzXjS13brxdy46+SFfJSF9qxJz+dYqa8/LSqJwhNXZB4QvmqzWzErPLzUyQRQMbsJ65xUkuNBrZhfFlKDrpwnuVlYDwmmb18VVbSL8ubN4snbngIK22STA4lWJZnNSr0sCzT+E1sp3TS/7we5SmcmBcESemNHfUHwc8+K9yJLB2DIM9Y2GgT+RhdYyTszitcTrAn/Ts8AZiG529RVatIztcCTiSda10LmgkLg130nZcKblHHkowlzwegd4oPcbobHF3ZiWHm0QcrnLhiDwBnsDF0q/mNXLJ5DiXmfJX/Y+lQjFtWx/CKhhjKRARIIduGwD DPZCIstY KO010kggTdnbJF0puy3SR2FpUBBCDj+hTzfYCOs2RBZrC2A3PrnL76hydhFOvlrQ7y75pX5sdFYTP2OsOF2DP14sG8/FYiJRwnxw+/Qa1VSgiBQJZJSzXq2Ify4l0FBuj2Www X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Admonition constructs on the documentation use definition lists, which isn't fit for the purpose. Replace them with appropriate blocks: * Use caution:: for outdated document notice * hint:: for memo * note:: for other constructs * warning:: for memory reclaim Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/memory.rst | 58 ++++++++++--------- 1 file changed, 31 insertions(+), 27 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 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: 13076233 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id E1AE2C4167B for ; Mon, 19 Dec 2022 04:22:25 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 9AC998E0007; Sun, 18 Dec 2022 23:22:24 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 89DD38E0006; Sun, 18 Dec 2022 23:22:24 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 688418E0007; Sun, 18 Dec 2022 23:22:24 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id 488438E0005 for ; Sun, 18 Dec 2022 23:22:24 -0500 (EST) Received: from smtpin23.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id E9A511606C9 for ; Mon, 19 Dec 2022 04:22:23 +0000 (UTC) X-FDA: 80257758966.23.456AF9A Received: from mail-pj1-f52.google.com (mail-pj1-f52.google.com [209.85.216.52]) by imf28.hostedemail.com (Postfix) with ESMTP id 2B30AC0003 for ; Mon, 19 Dec 2022 04:22:21 +0000 (UTC) Authentication-Results: imf28.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=CivmBZcj; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf28.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.52 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423742; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=dm3StokzlT7Szh+BiWvCYI/X474BbeHVmllPMqNHQFs=; b=C4x/6tRq/oC6XslC5Av7E27MZKWF3IA4OXnjKzXn9C3aaBUesnFPP74+BhmXkjLpa8YvUp BKWqzMmzEZyAPRFx2hGm6i9O1pErqQrJOOnEedIXMsAuk/5A6lAEJLMnD93F6NVYlm/Vgn H7hyoXDoUEEgmJr06iPLcvE1xlCOVbo= ARC-Authentication-Results: i=1; imf28.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=CivmBZcj; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf28.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.52 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423742; a=rsa-sha256; cv=none; b=mofCCMiau2FihdY0Xy/H0X/MChdHIeBKj/SVcbQrMi5v6PX0oMms3BDQdrFtzAVYCr3ZYi QbKX5iKiErJOu+xFZNI2PZHLFyHudxNg2otQo3eG8T7ltaTnDtga3W7Tn4F7RxPmjfH4/s /QY0kpW0wiUKLLf78e7TCzvyg+XUIaU= Received: by mail-pj1-f52.google.com with SMTP id t11-20020a17090a024b00b0021932afece4so11715955pje.5 for ; 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=VmUlTqI53dpGvD4LudOpUzwxkTLX4QHMFY8lFaIbwEnba56lRYELQH+RzAvm1pxhmp k5MCdB90seCqmm5EsXuYMVBb9ztU+X9E48T8sKSMZ56Z2bX7bnPEFmLGeOJR5QqQ2p2f vs4mLb/VZsGMP2RGL2bV7AuMbMsS+MMsFDsH3PrybiLBpJO0U2x8V5spxlZPJQZEl2wI ymh5Q35uD/8UnMXgpHI8JPAiJ16fHYJaSqN4i2SLWiIu/KY6eJ4KqjNo+y1FNnR7qFbL CcDoW3W2QG/MsJh6/w4P/AdQlF/Hyk7DVZvybzOpA7uWvE8rrTQerVujXMu+h5/8zlVB C6bA== X-Gm-Message-State: ANoB5plAIc8XGcF6ULvbd4pugp2CuJ/egD4taIqMG15+FoGVkqwmDd54 jHPfGBF8wVRTNX4vY3ECBEI= X-Google-Smtp-Source: AA0mqf5CnUHwvfX7+1EJIa5A6jcN2atInVT92XNpPGAKNN1DfPXiodIusuJr6g42L8vNFv6OI7Tt7w== 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-Rspamd-Queue-Id: 2B30AC0003 X-Rspamd-Server: rspam09 X-Rspam-User: X-Stat-Signature: 81yahetp6x6e7hmkb1i9nat8bdeky3gt X-HE-Tag: 1671423741-38969 X-HE-Meta: U2FsdGVkX194PFvaEUClPKHueLy0vK5u2O5PhDumW3ylhIgLxN6baeihAn/zDUr2d0Ranvyh6UQ8Fmbds/XE9956eyz86MjCTENM7NNAUsjqgdrcWjXi1ro4mdwNzYQoX9HTNXu6A8P0FskrPFU9qOT8S7pyOrV7AziZ9l/zjP4o129iw+Cz13yEIgmS2zT1GoYmfgcXD9Ava8erpb+rzvtYwQiYCMlnCW3AMR35KGw7qjhifJRkAmgMWY/jeV4CFAuyzksCTLJ5lhcRrwMkt530Mgfpsa+3N0RohyhdNhbe9fAXw1JO3qz3qamISTt/SzLQLuNhlQG7vlK8i4lIQwx/W861Ili9GkGORcE979/VwwpKviNSiemyXArK/PFjy8gtuhgA+MuuxMGrcFLel0mRFKhCb9o1vo2RgL9I75QWSG2Ig9K4Aeu/t2mfNJDqDovc+xpOwPvKKngUq9kAmBqT7H1zHPDwalfG+m88L2Mthc0uMbl4oPbqd9+Gh2JAilqSYJ0sFiteidmsd2k+61JMmfin4m1F14w3b1FtoUwBseTXNBNQo9UdRGo+O919WMl4qMdmGNp4vj/eDvfliWl+Jo7U72TDGObmpUm0BaB49E/a6VxCb7BP+Aypb07m0Y5rCFyLO11MUH/Q4iriJdkeNKGM1WSajl3eg8gYWRks1CeeftYSt8KgBtHlyYOFtedfXt91MPr57a72Ayk1YINero0GSCysUlv1auXwtaPtxONCvr0JbSbtVazRgWovfypgZgZ0bdGhu7BzWS/62WI5bumFiXvOLaIYe0qdfGD+WJV9uQQHjQrhRLV8EzU8f+qRceaCZ6lgHsUTMW8O3pyyvP2VTjzw6UY5f5zMmeWAYMVcaDJ3lLk66l4U83zWpHzrq6XvbIKzddSnGZ0DG0XGpoEaTEF4mrRxbLHgFGsXoJxlcVxBJUKFPUnv+IaHCIL+vqzrvv81+zK3eJw B0xVKxWz EhtqZ2FBLgRq9mvCuFnloRGml8Ha8rG37sIzHV2uTG6aDZFRcUdglYEf1t1GkjFfdvkQnDxRzjNRmqzqODIJj53FkbfHdhdBpL4kkI+x5FufAcg+i1guwgb2/Qz/MCcxz/6EF X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Wrap two other admonitions in appropriate blocks in order for readers to pay more attention to block contents: * hint:: for editor's note * warning:: for move charges deprecation Signed-off-by: Bagas Sanjaya --- .../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: 13076238 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4E1CBC4332F for ; Mon, 19 Dec 2022 04:22:32 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 7D9AE8E000B; Sun, 18 Dec 2022 23:22:27 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 73ABB8E0005; Sun, 18 Dec 2022 23:22:27 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 5B7578E000B; Sun, 18 Dec 2022 23:22:27 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 3F1A88E0005 for ; Sun, 18 Dec 2022 23:22:27 -0500 (EST) Received: from smtpin08.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id 06E891C4C61 for ; Mon, 19 Dec 2022 04:22:27 +0000 (UTC) X-FDA: 80257759134.08.389F20D Received: from mail-pj1-f45.google.com (mail-pj1-f45.google.com [209.85.216.45]) by imf20.hostedemail.com (Postfix) with ESMTP id 49E7B1C0004 for ; Mon, 19 Dec 2022 04:22:25 +0000 (UTC) Authentication-Results: imf20.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=RehRdEZi; spf=pass (imf20.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.45 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423745; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=/nm7j4zp8S75Gf6ZgO/l+49FQ5Ia2zwvn+/ND79+AHM=; b=SVZFEeeHKfri7CuAvYq9Y4ZW1+6DmoWPSljqh7mqD088edBSGz3mvw9RGP5n9xqn3AXZqA LZ0BDP8t0Y+tec1v5QwZek1yOlcqXuvyY5tiDC8PQa1qW3shUIqeJWn01HYnpE6uWafj7F Xz+ULauz5jsEpwSQeoCzO5krSSUOnsM= ARC-Authentication-Results: i=1; imf20.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=RehRdEZi; spf=pass (imf20.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.45 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423745; a=rsa-sha256; cv=none; b=SiTz8sza02RFHLp53AoPywyvjPMFjYAMHS76/dV9Zh+yp8tzgUPMkZvwKWzrYB3HDMY+uK dVKmm1eCxV87bBEgPO88/VNyCd8LqcmDmSZu12DcHDjDt9XDi4hRAQ8Bd9jxqW31+tAr/y uWFgZmhaSefjIzKnYfbn6c8iT2dtAbA= Received: by mail-pj1-f45.google.com with SMTP id fy4so7886743pjb.0 for ; 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=FNreijFvsKvJnfYEjDJP1EW2sJIOvzFNQK5b3oOmRhrdLwTEB6X2dcDnF6A0efYtvN AMGoS99aYgF4PJuxyAyUIU+hM+wEWT6v3ND9lv0daCejZyWrRDcY5HnkaDZVFdcySOPz FAAptFjluHeC6W85IZwTyL8uhYLadSP+l7+1V8B/ryfEweBL2UHGBEqL8ZOI0Aj+T9NC LBKV2L4/x86r6BTgqJNLM3G48ljTq9G2+A2eJp6tHNiCSFNa66Qf7vqnbiP+de2MfoXa +wRl+6krwyAYyO1Do0tePqIm8IeF0nePIlLbOPSQUANWWJkZZSmX1kQrKqx5n0imtX+Z wpFQ== X-Gm-Message-State: ANoB5pmTSGY8XtnptW2EfsPKdi2PtFHy0Q6NN8wTR90Y5ItfHxxuv9qv R+UiM4GJZtZ9hMICzwKGyw9dG6gME1k= X-Google-Smtp-Source: AA0mqf5qxCuExoyYlyieMwjF0eKAXLuFPRct34IG3Wobwg2OKrtfxxsUeZlvXStIvh1gBbS1/p2qiQ== 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-Rspamd-Server: rspam05 X-Rspamd-Queue-Id: 49E7B1C0004 X-Stat-Signature: fkipn6hsi41swd76ymya1fowes9zqzfa X-Rspam-User: X-HE-Tag: 1671423745-903977 X-HE-Meta: U2FsdGVkX1/X1fSKHaGJ98orcrm0NT56Gik1oj20nFjTzjcUifQfv4yND51eCTqAiBs1XX31zZH7Gy1fqlhCW9/scmGUhMXTq6DEmyp3R49X70szS+wqm1/OQ72lSa+F3pCC45t8oa3uB1fSijNDTpp/TAKzP441G6NBdlkZtXXysl3MrEflVygk6VBpr02F4QyeGW8HOWH+11b/l78s6o6vnLMk/DyJlOEE3HPG1HzER4Q4KvygVwSBJ07o3Z6SBWvNPYPllUJD/m6pDqI437TgM94pNIDLQPPOdnnxTMuhY1Lr2CHCmLfPHZpmp9tEmaANGzJRe9/UvGBxaGohXhnU/AL8LTFtYhO/A7lzvhQaZgo6Bqq/U33MSwPfI9/Lcrvk3usfrbTL22bHQw7XfJI05lR+VzijySVhhsdjH8c7okUg9sf3QxY/3cFzlmf8UfcYryusjSsQQzFYTWNklJy6m6pltFdI849xptm2krJXXzf6Fwb0xY5rY/7cik7AO6nfkPAwIic/1jHMrh/rkIccx+0h+tHJ2TbJOOWoCKqK9RblbHB8+95EX+kOVOaLWIB3bKm/P4Igu/4kULwc0zVRGS/hscUzzu/iYCujekX+uDWeiDZUpGv7GezM3+u2otbutZtq/Pd0dym0MF8MB8tmSnA1IoL8qpI7+mpexzy2Bal43xHK9VbYAqz4FUJB+lIicN0DIm+5MURwWccvi6m0HV4HFiG5xoHtPP+z9P38k++LNJMLLUXLw7jZ65U3qFs9JIU6UNzYzbeqDFcJXCTu0Fwye2+JYeje2MQFuJFec3siGTChcXIclyGa9nhvxjW9Ip7m/4X0QdbSceO75HmVqxs3mIl+SUeqyN5b7eEOXpsVACAKMY1mG5UifGqxqt+pG4/VJQi8IjJNrL8JIIYd2P10zD+eA+AJNnjp29OueJkYvCGsB7guVzSTWeh/WyNLJcIBUsFfRFF+9fS sELSwVk9 xFPTPob6wPBowAJz1xJnWUlNcrDPGuRzPkZhhB1yXESw7QEU2F4pbERR+Aielf3ukViD6kYbe1ZUmQdjvmKTRUqtkAz2AyMv8evhif7fsqn7JXUGQejrhKTAunNEwYCvEd8Dk X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The locking order schema is a figure (like diagram), which should have been formatted with literal code block for consistency with other figures. Signed-off-by: Bagas Sanjaya --- Documentation/admin-guide/cgroup-v1/memory.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 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: 13076231 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id DF0A0C4332F for ; Mon, 19 Dec 2022 04:22:23 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 3DF618E0003; Sun, 18 Dec 2022 23:22:23 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 38FF38E0001; Sun, 18 Dec 2022 23:22:23 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 230488E0003; Sun, 18 Dec 2022 23:22:23 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 12EB18E0001 for ; Sun, 18 Dec 2022 23:22:23 -0500 (EST) Received: from smtpin29.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id E4FAA80866 for ; Mon, 19 Dec 2022 04:22:22 +0000 (UTC) X-FDA: 80257758924.29.06EDE60 Received: from mail-pj1-f48.google.com (mail-pj1-f48.google.com [209.85.216.48]) by imf01.hostedemail.com (Postfix) with ESMTP id 1ABE640006 for ; Mon, 19 Dec 2022 04:22:20 +0000 (UTC) Authentication-Results: imf01.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=II0wTtuX; spf=pass (imf01.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.48 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423741; a=rsa-sha256; cv=none; b=rJ1ibfp8aBNcH9/wJnlqiFLQwq7KAFh49T590PPOu/vy83ksmnn1o90v7uff6NQ3wQpWeK qOA+BZxVaSrkVuCTGt9L0JtS1Mcnu5pbKKEtPbMsIUEB6tMikg3GtWLZgk/JtftIw3puAy KQW6okbZkhcmFp0G1lnmJInq/3CdqVs= ARC-Authentication-Results: i=1; imf01.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=II0wTtuX; spf=pass (imf01.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.48 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423741; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=QEwa20X9A+wyrh3eoohiFgEbSAwTbPLRyuDyRq0+iJI=; b=EHMeVgAc05hcpleJU84STI+qICgvaVsihE6SLVHafQ6oXlr7fdEuX6DWMulujxPEd0UQoX sjcqtxvvxXv1bCEEBK/QqVVz0q0/tDlL8Yp39encOtnLwdUjw98lGJOPKiiGi9eydi25Vh flYDtPlncu/T68Tbk7q4fnWu+6Eu9k0= Received: by mail-pj1-f48.google.com with SMTP id t11-20020a17090a024b00b0021932afece4so11715928pje.5 for ; 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=A6Q23UrgoOYIeOb6EZfVXNfcw7WhAMFBijSoutwFpG+1PncYLcj8qIXZBxSAqTVwIl QncJmIiOrC+JUT/zF9rd5uRp1gzbrIXE7qnpoodxC/PS/Qewk7s/PjiXOBD/qRc+oRoO SiZO8Maw0yIxTuMxT7rILJuOIB16EM0dmgEnaJ7kasQAsyo8Sqhb9h3RoPBmCV2NU+ar 7fWGRALwmHI4ep+w9vCrKxVwOetiY910bKcWl2K06DrXDxPXlYDFiA1tyQcduOVD9pIF VENTzEHJZ6f8A1UAh9ij4awiir9PuBihqO9k5rRBTYNlnMc4Rvo804BzdM1CcxaA6CSr FgOA== X-Gm-Message-State: AFqh2krn3PlB5T8I9uFsA70O6fjoieVmLN6w/El6jPhRmvV1viyNrS3w igItN1L63eDd5qSssEJs21k= X-Google-Smtp-Source: AMrXdXsGNlWGG3n6vP6It4uosK23dRFLrGgn17glXzSNE6kRoir89VzcMFMpQ7rLtZjdeTa4FFao4g== 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-Rspam-User: X-Rspamd-Server: rspam03 X-Rspamd-Queue-Id: 1ABE640006 X-Stat-Signature: xfijyj6izc1x49k8euk65hewgbk5tmrr X-HE-Tag: 1671423740-885548 X-HE-Meta: U2FsdGVkX19qA4kK/ybwJobGmKln6KkFAJVv8I8fFCXEdfXT7P3UeLrm1uwdHYXOVlTckLl63QfvOufG1lj+h3nedwOGzHhwwwE/HoKuFgLjCyqB8Abfd88XwKGCCmNn5UJBq7LtwekZOjjP7DB1gA+LSU8gletFXdQaLk/gdpLfQ8jPa1L6cliifvVwfLMqVNgg9D84Br69b8yjLCXW8XcZwXmmAi1bU5Oaa5KwYWxsvNYCa9XcT5WX6CnN2MekhYTGoPfrppsH1LrLYOTbqQCe7nr+g3rvSfJPlh9NeYc0OkwAkIKIaUJOZq7X/J36b/b/gY5XPKrzgsiAj5059zGvPhrwPpiOKb9kbksmDq9Sfbx87Rzw/b9GoiUqCsxNR3iirL1+jywpzBOdRfNM7e7WCRrEUwLE7299GN1SzydOtJ9OgEsvgDQ+XqE3uyMQEZ0QmSYm6GMmFxwGwn8XnIXarQdtuGRnQ+PGBpKS8ub7/HQYFeS2StBA9lbVwNtL2sVd9mgy9LaKYrHoBGmKPhsDqn1CLFtRxcqNvYKKmWV11e1Fjxib/eHK0trlnWcRKZKQn7NntTSXj1jLg49oOX/5jmUJxe9mEa9QUmk8jWJLKT39K1ZX9TkhNeZo78JeE2WpGMzkJ4MT5wjEcuX4DWfK1myxRKqHxitgobRLyy9oHs5GhCMCiIMvCh/TmA4g3nFt6MGiAJfPV5KrXAjsxvEet8oOW7blGlHkVD5A8qxhVZnGYg5prc0j5HGkyVpw9dgcr+7is/lULCquX5ujDH9ZhSvt4gqRwjQL0zaqksfflmb/B/OkTcoq3wBgHm1w7pzlEAf4W9Y3ZoAeCm+WUNlVg0kBtuWhRxDDC3Z8neni8q78ELBxFncxHa2sOawzDGNh+2qz+TabF+98CZmB/Ed4pt5aKTpak7jFIBO/kCAzoeeLgFyQibfDnltdG8PfFQTf2yqiQJd/OUrH/CA 8M1COHSQ EhN2jFpjoV6d2bhxmqZLiQsyHd0ZFJ5ABEop97IJmO51/YNJF/qgwd+URQhCMBJc6BzexkjoNZZUChMWliAFNGz6x35X1BZkJHQi5uxBvTV83YROdS7BG6Mf+yRKnWIJOWvsN X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The documentation contains external references, which some of them are marked as footnotes. Fix the syntax for them to be properly rendered as such. Non-footnote references aren't affected since the text for these is aligned the same to the footnotes. Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/memory.rst | 36 ++++++++++--------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 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: 13076234 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 21E62C4332F for ; Mon, 19 Dec 2022 04:22:27 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id C2DCA8E0006; Sun, 18 Dec 2022 23:22:24 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id A4D878E0008; Sun, 18 Dec 2022 23:22:24 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 800328E0005; Sun, 18 Dec 2022 23:22:24 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id 642F18E0006 for ; Sun, 18 Dec 2022 23:22:24 -0500 (EST) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 22A2C140A5F for ; Mon, 19 Dec 2022 04:22:24 +0000 (UTC) X-FDA: 80257759008.22.6822682 Received: from mail-pj1-f52.google.com (mail-pj1-f52.google.com [209.85.216.52]) by imf08.hostedemail.com (Postfix) with ESMTP id 65BD1160004 for ; Mon, 19 Dec 2022 04:22:22 +0000 (UTC) Authentication-Results: imf08.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=UIKz0INg; spf=pass (imf08.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.52 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423742; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=4bkaFHH9828XqB+keHudWE3HrJtGvwGZpCKERfRezL4=; b=70M7p0Opp9xqwKYlWw9lQ5cco6cXp2uyz+sryvF+9z0RM6/oYhwhoeVwlt+bHGrHkByWso d0vfNB7TM1RRhvmm12XA1CUvh27XtInBhzrwDhT/X+10hxvJ8B4aTW7IsXRDBbz6jyVBVp v0lWqgSpaKVldmV71U8DWVMF+kReey8= ARC-Authentication-Results: i=1; imf08.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=UIKz0INg; spf=pass (imf08.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.52 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423742; a=rsa-sha256; cv=none; b=vAEbJZlorTqst95S5C410TZJtyd7RkT3VO5Bt/1kJc/YcMhQYkL2Ye/kkgaNki3sqgElCT dYdfrBbstG5iyLID+1ERGGm+bPfc+uCZT/XsbXlhHhB6nyj71/RA0Q0Vy1Ew5IgIBPbZdh s6EUKF8noEATgxQf7uBj6zwzm5v5/vo= Received: by mail-pj1-f52.google.com with SMTP id v13-20020a17090a6b0d00b00219c3be9830so7697178pjj.4 for ; 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=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=LUEm0mES4p8Bo2rrdzkEoxq/qZ1BJISUeV3YBuUMVlZlSUHOACb0hwJAl4eHCGaveT GayIRLvT1JAA187Wkr195adEp9KjFfqkcbs7ygkYMBx2qJUuT+7eNm913QLYU6dy3Hed Ye3jsesAWuxgcqrVYe8XJAxqRC9yY+3NNfx44ZkjQm9v9KmbvnC5uce4UEN4uBlnHSJP fXRSeX2eC8PezfIcCOtbOr00u1dQzFwmBoxUkK9otQU1JiMC4vpVYne6hIpmyuF+p2MC miZadsTwNza8TAPrVV6a8cgvv9AoVLC8lv5NKjkDBpp1bWlNhoQV8UbBw0/eb+VUPDAg NVqQ== X-Gm-Message-State: ANoB5pk+9QHwXxBfpgY3kJnYNB48eVs1Lx/SD9h+DdkljKCYWs1e9Dmt KPDR2OwN+Q1isesTzUb+c1Ge31ODGYI= X-Google-Smtp-Source: AA0mqf6I7/d0mc3irtLSumffry2zYvwZBOzD461YgTGyJYmyWAUOgar/8T2H2806AsXi+Hck7ffldw== 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-Stat-Signature: wtsb6urzs6teodcas8o173d473ckwox1 X-Rspam-User: X-Rspamd-Queue-Id: 65BD1160004 X-Rspamd-Server: rspam06 X-HE-Tag: 1671423742-983704 X-HE-Meta: U2FsdGVkX1+3U/K406f50iQc9dRNbsxo5a/XAkHBBSZz2QKUFMwZQ/QcP719eNEOnMZkEEJhlI82xM4XjFzaBpj6D8axTHvUb2LHoKNvYRtTHBIAltgks2x6RezI1GgCPGM4gdGq6dw4/hHrI8JepXnmRggAT65E4jV5fMHYsE36FvFHb/5f+5BfNXg7Y41pyEfrRio4v3GBMc28NN4/1CDwiwrPn3GH1GVLNgJhEg/WVbQaXaB6CnW3MBfpaQuYoWo5j732bWpOvv81iC0cltL5qulcnGnDern6OUW3q9Bp6Ch49wu3BEyNWfBt53iVBbHqTuq5ltJ0vvKZiM2J/b8g83U5RD69sd27lCDh5pD1J6vuUGvhLQx5n7oVI3raQ4sRwYx37G837yE1lbQtK6Rgu742W77wR/c4W3f2iKK29jgJN6QONfYaqQ6pPyN7j6a4ikMAzwhPTwubYcVoyTRXLRWXLO3X4S5804wAAY4sH0CRJJDBu03je7e0MFPpmZvfw15vkkripOttI3tvE7Ey2fNTSUbD5P3TU5kgmZqEWbVdj2Csx9z9ax1Doxj9+OyaHkdP5v5k590PDQC4I47FSyI7fVat6nESdJTldDmA/sgxRUDHWXjmsGQOAePbE+z74CrHQFll0X8tXG3vYZicC/z7D3BrMRdECB/jm0FwFKJ5Fk0Lo3PDoomrGnGv/LRr0XQAHLxwM7PYFTBtfzFCHcyNHrfRQF7I7jT4Q+8eS1IKMkUvPRP0/t3XK9d22A+saWXwfU9WQz7dwocyI1h3H1KH4WHKMrggkBt+puOs+0v00kCuMwZUQc/niz7ZPCUn9kD1vhzqY7yQYOneusmHmcAFKKsjHFenRMNFuS9QCgBbRASGvuzTnkHYFOMZeKBvF9lqbbNeAvoxyG1KPQbHqjatpdeq4ihebc3Eb+Q2TUeZBDc+ais7hDNbYB9R2DiC89XTgT3zi20+XSU vfclYU1O xe/omMt075Z8vb1F8LBzLt7qKPVg13u0bStj7uET3FQHKGiZ4cb9GdDOw4tiS8KuRKu0b6VJ/eHi6flp1NuXxHH7UMFGkQcOQI1j3D6S4ivQxwrF4EB7tDtMTiDuMPP/uzUkj X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The caption for hierarchy of accounting figure is in the code block, which is quite odd. Move the caption into :caption: option of code-block:: directive instead. Signed-off-by: Bagas Sanjaya --- Documentation/admin-guide/cgroup-v1/memory.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 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: 13076240 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9461CC3DA78 for ; Mon, 19 Dec 2022 04:22:34 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 60515900002; Sun, 18 Dec 2022 23:22:28 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 5B5438E0005; Sun, 18 Dec 2022 23:22:28 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 34CA9900002; Sun, 18 Dec 2022 23:22:28 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id 032CC8E000C for ; Sun, 18 Dec 2022 23:22:28 -0500 (EST) Received: from smtpin02.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id CDEAC1C3D46 for ; Mon, 19 Dec 2022 04:22:27 +0000 (UTC) X-FDA: 80257759134.02.AA0F827 Received: from mail-pj1-f46.google.com (mail-pj1-f46.google.com [209.85.216.46]) by imf23.hostedemail.com (Postfix) with ESMTP id 15FD014000E for ; Mon, 19 Dec 2022 04:22:25 +0000 (UTC) Authentication-Results: imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=aJ8LYUEr; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.46 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423746; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=lRDhbAuFFMtCfx+H7ZJIpQoYnynck5HVInZvHowpBNk=; b=qKuMiaAJ3LKkFwBI3ME9OkHoPLOx7yJfMnlRxWj10h0NLNisvdEJWghwBe+WKw2eZbKNOe BdZ9hAg6pgQtamcZlYIaHq469g5ho3e+/PwhraGN65LzlpfKni5pI11V3wNcomcPm8rDFM mdbbyBzv1HTLwKElKtMtdLNB6PLLz+M= ARC-Authentication-Results: i=1; imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=aJ8LYUEr; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.46 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423746; a=rsa-sha256; cv=none; b=eujW701+S81lH6bvL2wTn0UvjITqLMtyIG3Fux8L9nhil8v6vnWc3QYcFLP5DB/uR0Ciud o1/NCaZ/eKQZc3/GeqMCMeAb6TodPyMUtjW27eeUqAMsHVaNmw7PnfbCj9KiRXa2l1CpD1 8fL3EtRn2mL0LfV2KezP4MvVS13kzTg= Received: by mail-pj1-f46.google.com with SMTP id fy4so7886759pjb.0 for ; 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=MZInboMw81K+qfF7Hn1d/XVVzCq9xgn0N7IRSiMijegGrT8Nw5I65TW4AdzQ0PGjb7 NTeG9MtFDnBsdfJ/sW4KTAOOA6Ekiw84irF7eEppBsoH+22Mn68suxiMNZ6KeSU8b3O/ 4N1jIZgcncnktLaITS1jUYzYJgiYbDWsvCopqNu5A3bhVWKjysl65gDdgSmdV6tJNKKV 22PZoP+nf4gteT6najZ+xEukmEToHWKD6ImRIFTnxMLhv8ePOvIWl3pU1CeX9bE3nKIE XUC3Hr1vhx0a44O7dFDe+miKJ2Dcgl8+Uu6srmX2cWAWPUCwqs914yJNIjCUqYqHVeWO lOeA== X-Gm-Message-State: ANoB5pkRfnR88HoWttgEPyAZSr20NQdWG5ytiU3qqRo76d17XofPw8Qs wYjX7vPEKEjm0f2UW2zzPHo= X-Google-Smtp-Source: AA0mqf50Q60/cHOKADaVTGJceXn1H4SLjSKCSi1WgOTYDrJ97ZGoPbiT1Y4BH9GfoxR8lLFlpaar3Q== 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-Rspamd-Queue-Id: 15FD014000E X-Rspamd-Server: rspam09 X-Rspam-User: X-Stat-Signature: wqmu7ejf1bkfdxee48sdtcks439j1h3p X-HE-Tag: 1671423745-690416 X-HE-Meta: U2FsdGVkX19Gnott4nOTAogE4B+Zc8+QeVWvVA6lpqRDKX9LUz6KUvxTz2aitipgvUSS4RfKrjRyLrjh5ccVByghEGdXZFIzh0f1m9nWZ75HLBJUi2/kgVVkj8e+VuYVv2owNUi+i2pedJE7DDmYBPp61i0FbK1jzev6J7dNc23e3hUxlvHePUqZk79RIRoJIPOMhExdieLUYmXFOeNMAL0SJSmWf9kEAnjqglsp3tMnbQCikhKgYlHEe/gBKCT5zAEBxyPj37pZ+n0Ua73de0Le3+ludpwm0SyxeW2kCuOH68htLkr21xavu8YjZ+vinG/UXrDAyEpavcwRwuDp+RW0mqZaAQWnnJq4/1lDs0SrUiXFYvKzTYC9gWrBPfSRliZ8+FfYy+zMw/fcadUsv0Dtez+U9jUgnon0+hiZPggZIE4iITIGuCHAYfs58I7m1vMTJ5QrqU+bvqkI2bgWyrV5IzCGZARj71clZHRUprcsAmgn1uivBTXwNtiuFYuR0G/KBy6FIvCBiCEbdpluY4JfS0dQngKZsxwHWKZyM+wbYDA4VQjW+dy6IrcxbQs9mDhmtkdx6VyRMWHyfx4nj5EcMAEdms2NYTHz3oucOOkqdfslNntExBQNnsfTO2o6AEZWV1lDV/1ACMvzjOJQKTNbNjrU5sKDdTrbaoW4euzu7Mar+KawMIRnz6b5mviw7c77Ntzda8alQTzyXB072tqDLJNsv1gfTRapAFhBFaDg5cLAM8bcxYIME4qK42XlZAHlq2W6+AsBWFr+rogTdOBQkSOTIhsE1hZD2Tov5lJ530YSeGmx01DZdNU/ScJ8xPN0gGX4y/YjC1cjMdBI49jOd6m/TmuNoEWm/4R4zfPecLVquWt1q01w4+0jXwYH5DmwudqXBZYogrEurXbHtfFBf4C/ciDASdiFknkveweKWDdsNLoH98lctczxyaIM/AgHCm9AW4bltQMZ26g UKKPa9cl pHf90li3vOHvf2l9/GGwZhjjYOQs73tYfRpbD7e+Mk8etO0xODY37BhFnEwQJsHm4tBgYoMkcH76k0iUmkLP1ppIOoLe2rkdkhCOEyP3b7Q/0v6eOXyj7RoXrvK9OJhlqeEs6 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The stat file section contains three tables, where the leading texts for them are subsection heading. Organize them in the bullet list, while demoting headings into normal text. Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/memory.rst | 93 +++++++++---------- 1 file changed, 46 insertions(+), 47 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 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: 13076239 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7742FC3DA7C for ; Mon, 19 Dec 2022 04:22:33 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 0FED18E000D; Sun, 18 Dec 2022 23:22:28 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id F0B958E0005; Sun, 18 Dec 2022 23:22:27 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id D7D9E8E000C; Sun, 18 Dec 2022 23:22:27 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id BDD1B8E0005 for ; Sun, 18 Dec 2022 23:22:27 -0500 (EST) Received: from smtpin07.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id 8B9C4120A7E for ; Mon, 19 Dec 2022 04:22:27 +0000 (UTC) X-FDA: 80257759134.07.34AC24B Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com [209.85.214.173]) by imf23.hostedemail.com (Postfix) with ESMTP id A278C140008 for ; Mon, 19 Dec 2022 04:22:25 +0000 (UTC) Authentication-Results: imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=Rw+DM6QW; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.173 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423745; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=agWt8CECL43NEhVRFwvhtAXySMNGigcHHGw9DmNksyg=; b=0cM75W1eLOwAKC9ydwqtZnUZsA/QCQYaZGw/cSg+6IOoXgtfz6wKiHsJmxmJG+Xdi4dlnC gDPOw17RCtFrqczA2r7TDVk6ijI1f0jA2rA5C55OXxIs6dh46tmmZNPMB527yuF1NN384l fozYbjBI8RYmpJsI8R4Txds2Wqiedv4= ARC-Authentication-Results: i=1; imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=Rw+DM6QW; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.214.173 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423745; a=rsa-sha256; cv=none; b=nSC2ktvnDL3Duem2WguuGCUyQktMpGkDw2mEK0eZaA5b9KJj9rkmAgeA9YdM5HPyxfjhj9 rqCjkosS8qu4f55o7Y2IPg6kFTJk67lNBo6AQT0VFwF4Wo3zRXck5RpoafExuEAFzICfVb c7NhmHsZtH9sVMs2TnRhbM5YhgN13bA= Received: by mail-pl1-f173.google.com with SMTP id d3so7831839plr.10 for ; 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=C3DWphsRBacbUzXa/oZgjhw7DgNWkAVkjZXU2xtI+AGxlfKdvnHdYma2geyRHDX36n MxYR07JSFksJAy6p6j89Z/x3xvTd0iuNZLnnM9kE2c4MXF/fnZZKL+wdB1rF7SOf/kC9 QFFALq0PA7SJkmot95jKctInLRL6FU0orPO+/56+Qg8daIsBbkuiTEyr0glcKhXqTzCT ffddpIZOylmtpIFkjGkPJxHjg9pvlh1qBrGFCvtr/ox/WCNarEppOJIlY76NdiFsMsBN t7PPNNNkJkmeXQY8DTIVcRnT7UwfK82o2vx8MMzclcGVsl+ebwuaTkSR7anY1A3WAZmp wf5A== X-Gm-Message-State: ANoB5pkj5DC7WJEUaTqoB1+dsnhiaB7b1TCS82NFeBcD85zIQCKbOwte z+XlZSZ4w8xXVl2zaAYXres= X-Google-Smtp-Source: AA0mqf6BCBYy+YpcHUop3GwiAxAif950akyz01hjK7kttTKC1Ch/bGKyJy+8RAzPOIHGCelhPQJrwQ== 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-Rspamd-Queue-Id: A278C140008 X-Rspamd-Server: rspam09 X-Rspam-User: X-Stat-Signature: 5bzqi5xt95py4nq69rm66wbskog845bi X-HE-Tag: 1671423745-748432 X-HE-Meta: U2FsdGVkX1+wgAXuz9ng3tavsQ+2gH1LV1VTspbgSQZF0JMkOzyY7okpKHxBBPbfOzCY8Nm983SgGEfSMjTzyf1OSiYWWnLB6JeTXgTLrxJg1Dd5XbhvjTUANAlD2yaElAMvPAs9hW7fjy6zEbtrE2bM1RICqdeMYUBqmrfxUajn1Gmbv6vKHUQ+lfhvYBKwYjv2W4D5VLlE65b/4Kn+YtqJd3azp8yBj5q7d4eaMtJGr87WrmJhfU3Xl7P/ST5rKs7F5H+TacTZ8wq9o2cQPXjwCqeLTn+Zv3JTk7XVaoGeQ4qLWOgBiFFKj2gWJTHX1omNwjf+zH8Cbz7ctxehvJ9usV1rhwVEWqWNTVx368HklVXG8jmkAesSTnhXWbGd6NHFUMKJOS0zEFDF+0EppFgk8LEaPWlI0y8rQVi+S6O691qPpnRsaNTlPxUYjEzRY4o6zapg+AdiZMEwzj4I/7/dfkAqCNt/HhcdIWtFurtBaW3lDGmiAKKmFDFu1Dl6wZPRGSfBIsxms92VUA44EVB34wEyjtxVaiqNpf1itRlPvuDT2A6Lj1W6fIn2ycElMXC8gQbozG83Q+VGRPg2CKJNaQ3p8aeG+c/KTqSTmVzGuLDlc6Rd/YhM0PFSoDTtX4vOs05h8O7iAj10QfDn8PaqLsTldXTsDZxRSyzUkttm4WNf4wmWJrKt/zyeTB4OWBfpb6vmjIwsyMTM6L2mlMuVLnr3PsTKlTVE4nh/ICANdX5rc2CFUjLSkVOhDzg4Vx70hxgxnRv10ow7EdXXzCsqL9vk5PhPv9u2diTlHq2FhMdpRckJcPitW77mL1nW3PHndtM55/8lcBsGXIx3M6NwTebAiGtYh2PE71HO/+M+Wg8AjIkeHMxRqKFa5rr8rVuTRNYpfVoRznq2ZzOrBP7Gt7kmb5IcIyah6SYTM5jshFfZWkLLz5iI9NicnfWKkuVtNmtqf6WylKajiym /CM2H+Fo 0DqEFmWkqWrOzDNZ8zYpciICWWBeJAMY4AScXyH42PnPWeaJzMhVM02fbA875fSIa14DcboyRJwVxWwsvvEaW25Rb0nOIFir4xV3nn4AWb03cZ9leG2tIHejVpweWL3pSw7nZ X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Subsections text of swap extension section is marked up as bold text, whereas making them proper subsection is more appropriate. Signed-off-by: Bagas Sanjaya --- Documentation/admin-guide/cgroup-v1/memory.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 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: 13076241 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id DA5A9C4332F for ; Mon, 19 Dec 2022 04:22:35 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id B83DD8E000C; Sun, 18 Dec 2022 23:22:28 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id AC6ED8E0005; Sun, 18 Dec 2022 23:22:28 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 824EE940007; Sun, 18 Dec 2022 23:22:28 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id 6B578900003 for ; Sun, 18 Dec 2022 23:22:28 -0500 (EST) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id 53E1B1C3D46 for ; Mon, 19 Dec 2022 04:22:28 +0000 (UTC) X-FDA: 80257759176.06.CD68859 Received: from mail-pj1-f43.google.com (mail-pj1-f43.google.com [209.85.216.43]) by imf26.hostedemail.com (Postfix) with ESMTP id 90D75140006 for ; Mon, 19 Dec 2022 04:22:26 +0000 (UTC) Authentication-Results: imf26.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=mRDBpTfs; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf26.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.43 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423746; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=m1lEXUxDv+RQRfIU+EhWl1xsmh7T8TN0B09r+Rt+f6E=; b=npbKSTr9N6vhStGSSDlDKxnjQervCQP4pVNvndKh3df0pM8k4V/mODPewRP0yWq5DhT8Gn lWfqLhBPy/1goBQK+oWLvUhvG3Q0qbtztCGuXGM1fO43i2zXYV7SzK/iM4fjCg0BXEU6dD WRj06LFwOF9yyK197453R4uiS4MH4RI= ARC-Authentication-Results: i=1; imf26.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=mRDBpTfs; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf26.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.43 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423746; a=rsa-sha256; cv=none; b=WPi8K53U12/RGxvNkXmCvhIYHEHX5uHO4X5md1zotThSM5cXGJmrMEsa6ttCMk3ei41Cf3 FyQxE3dwcOt6qFqa9i/2XIc6Wg2KPLDSiRXkUCXmgffUR/sCNL21OfeK7tAZrsTIKvjB5S JhvCBQML5jqlA3jj2Ni+PrBmm76encg= Received: by mail-pj1-f43.google.com with SMTP id e7-20020a17090a77c700b00216928a3917so11723756pjs.4 for ; Sun, 18 Dec 2022 20:22:26 -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=T60PSfr9oVMOUmEZj88p0CwvYuLHf7/vF4iGHnR7DkR8TKuvroJijAplZYypJEJS4O lgBODNEJFrJgL5/8l8Sp/DWY2Lzbwc8upE05fSfEmWSW1l112YVqlySGU4qUBlZ+o3hQ EM9GC1OJsL7WU1ru9VuAyTWjb7F0pBQ1bEWWK+jejSEprLuWHLx78z3eOGb+MQaSw3a1 zEWpzuR//cjvllh7Q3z5/C72zRKqQX2mTauPi++N5H5lVx99h8RWGBQkYvS7K9AKXfkf tCk8Z5HAiAnmd8ONsqHe2mAXSOhvWeUPNxhCBVf5BqHESTX33TnjdDl9y4GOvKZHaoka OEPw== X-Gm-Message-State: AFqh2kqJoHojsZHGS/5x33piPlX2ntzQ+QqgSFG+kc8C5iNbi9SzxIwp KDFgmZmNd/O6Rhb1UctCwBc= X-Google-Smtp-Source: AMrXdXuHTIuf1k1NZ+BSaH+fLP88vjx6aUE1R2UTN8o/LCwMK8JQI/oHDBZOqtPYKI0Wdfg3I4Phqw== 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-Rspamd-Queue-Id: 90D75140006 X-Rspamd-Server: rspam09 X-Rspam-User: X-Stat-Signature: 5c58sfab9h94qhc414yg4xtnua6amqpx X-HE-Tag: 1671423746-228079 X-HE-Meta: U2FsdGVkX19FXes0UQamHTUJI4iCFuS5B32JhoVqWnRnNoCpM+FNjCEGkQmwe58+XH3GTSOO+M+Xv9iMBBALGedBVaTeXG8nfcIxdgKPxgtSAXAhYdQr/XhzOaNMN0NnY/m6INrkBwUu4jYZcPaxpqbd6tsoRMU8j+fdOH1jicwRIjfS4xO+5xKsgr3xxzqWGRqqHZK4W61aMdUK7QggcxuL0BZ2h6tf8CIRFVdq9ZvaU8cjP17i9SoAGSRrWOZCs4qyeIARmkHiAEp8REoZc44kG7jegY+TLMIx5XdOihlxa22ODm2TuUuCXn/8IEl7eq6pbTWT4rxT9XL0nu9u1bRAu8g2bCkHVQMrDqpp5vQ6woKvEdPsUm4UCKBL/3nQ51UpVTb3clmSkvSl2Aa4w7NuxjjYy+pryfejKXEb/FMhmTAliZNo6p0yZfyU8cy6Jb6Rm4NOrhfM5pTGHFvZ1N8z4QliKwME33tLbPZSo2Xzd3WxG1tnUZ1m0DOF+Fu3hTMNMMgtyJmKgiDlCgCyPatctcKAsaacwxkuwfvUxysMgZett7i5PN6AiSCEv79J1+8SQygkWCsGoQFjKgH6+jAhlLwccqB1DGr4s8QejMtVKbbGKg8Sm9UkbY5eKBaPx0hIzpTLV7RQlkFRHI3d1uuW4YiKLHsx91ny8auiF3+M2QLfjyh3t23QztSvRVMxsW5kHsB6r1rM9RYO3fC4vqbcsy1b/j6Of1KvYacKYFlU4+y25rg286pWQ3XcQzrpOeCeNj+DUEqMaCyX9j3kyC5gfTTu/HKH/pGjEl3+GL/5MuhAwJK3QjreQJGEQDy6bzDlsGN1TUETZpzoAG1usZqRpUX8kFvruEG0nj6TPROWYQetiUshPFwitp5bVDbUzH7/krw6/6oIsH14cNbkwQWhITuiBz3sZhszcOd8QL0m2yefzt+epeGRY1JeEoFtpKRPxKhoUlQ6svqUBE5 gSaFA4KU 2QDKZwY1X5q2X1/fVHUNKc4F4mPxURmwBa8aJCgsriFTKnVi1c7TD98kaXAOkosk4Fuhee77RjSRZKwJ0Admp+5TBmy7hSSaEGqX1UkulAtUSLFSNFwNaVmdVq+74lssKK0gG X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: The documentation contains references to other sections in the doc (internal). Add cross-references for them so that these can be accessed without having to manually search for them. Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/memory.rst | 43 +++++++++++++------ 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 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: 13076236 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id B9A08C4332F for ; Mon, 19 Dec 2022 04:22:29 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 569108E0009; Sun, 18 Dec 2022 23:22:26 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 3B9A58E0005; Sun, 18 Dec 2022 23:22:26 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 171048E0009; Sun, 18 Dec 2022 23:22:26 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 024C88E0005 for ; Sun, 18 Dec 2022 23:22:26 -0500 (EST) Received: from smtpin14.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id D55CFA7685 for ; Mon, 19 Dec 2022 04:22:25 +0000 (UTC) X-FDA: 80257759050.14.C17EE43 Received: from mail-pj1-f46.google.com (mail-pj1-f46.google.com [209.85.216.46]) by imf26.hostedemail.com (Postfix) with ESMTP id 13A3414000A for ; Mon, 19 Dec 2022 04:22:23 +0000 (UTC) Authentication-Results: imf26.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=DWj2vrOs; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf26.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.46 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1671423744; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=2eJ0PgV9osw1yzCFjYcppkmXI1mNsCk3sVd7FF32JKk=; b=jHTzr9P0HCVSy73M90NyGmpw44mI0pR4Vy427W9ItJ2c/wQyWuYkBKvrC+FoCLhQwsq4Mt PV1vD35xhdLIgmrI8zv1altaOnZgXFyMUoMzix6aQ2CelB0VdZ7ad0W/OQS15cFiUGLg/9 Cxfze4vJTzl+qVoRXZWKRiv6M+0NXvA= ARC-Authentication-Results: i=1; imf26.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=DWj2vrOs; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf26.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.46 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1671423744; a=rsa-sha256; cv=none; b=bqWjheJoZokWO434gdkt9rxKrLLj05e/m/bBXC90hzwv0hZ4RbRzfpl+1ECd7/xVLG/U6/ 6dsZnCkXnr/yKkQtKwB30YaS5zaa5xRRb1ChL5VpgQMqhbOeVe9jYLxNG2ZiaLdL6MC4fL UtFfux0T7XzA5Yi4otHzohWwLHfRlD0= Received: by mail-pj1-f46.google.com with SMTP id v23so2597435pju.3 for ; 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=6V0BMH02SE33Hw5pTtWCwYp9waLAriykG9nQ2gfztenzc54t7EDU+P0dUXxJeSH5+s DqXNYrenms7uEfvFQ1DcF3D6eAhbWfhFRWdqhxqgIMmUVsG7qRX7OL1yFHrtgH0NfmvV ZVzH6g3utHdq9m2e9tzeQUBeg5MWY5IRS1BEItbb7Pb6UUi8s9H8OAx6vVRyoIhRo0Kr FeZHRnvdlVLhvzDsUvP+zuL6hOdRSoZVNa6lOpGZjF8463Mk+3Ddjpmca2CTE5opW5Z7 Tp0vXoGVA2tO9HOsIU5PYIeDooVyKxcuIaDS94xB8L6e9pZv4/8oZDApZu+cm9hBgknI 72GA== X-Gm-Message-State: ANoB5pkidhKJjjYLRqTYdgdbAXJa4BROlI41wLPigHxV7YfX2DgkKNj4 +VPo07G1FU9S5Sz7/sczxuw= X-Google-Smtp-Source: AA0mqf5MV88rivDFHbXAo0wF1vc9fTd9ZJ8yZVxW/J5PoxzMPwtuA4ml+Kh2ZZH4Hkxwpc1lxQbtzg== 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-Rspam-User: X-Rspamd-Server: rspam02 X-Rspamd-Queue-Id: 13A3414000A X-Stat-Signature: yc58cjojfc8o3hgbk9z3zrwmct38qje1 X-HE-Tag: 1671423743-977019 X-HE-Meta: U2FsdGVkX1/qZx3kj/8MovFUJydYZtvo/hiHFtWfp1X1+3KERHfkYGf80yBAP2QJjGpUk0uGba3xitL3D8nehAow1KKyxQOajAluUGsK8mXLwpaKfjtquixd9Q/OWmspXKUgp2jOyyvmKw7SU318p1GEHlZBthbPN3v4UGfoedikROgmZela4l6ZJZrBbD1UP5A6/9ydFc+pHuPknMWiOwQOtb1MQ22LsPWTDBOUdnoKkBy7xalnbOQDK9wzITQ7VDSa7pLFrL1eE/bjuFG65145DCr9lVCF/HNf7FQtVyd8YbOTiK6atryhh1FuWRYs/kTkjhtqIzb12C/LOPwEZZEh4T+GqlVzyJmjcEv9mjPb1cxJEjcPwibHSn7RyxMQ5hpJGXAY+XZPnkKJhAOPShf9Oug5dkdRTUb5GbD8kqPVXTo24A06b7Jy/9fosn9WwAxVxTBL1+H0hvDfCKddfAqu6ef935bVGZ32i8GK/KwSOSak4uWWUfPk7yUu8Iyi/RMYXbOIk0AkJbv4Iit7A2JMUx3ZiE7LCG2brviaTi9PF9NmC/3pmgk3RrywhrI1yyHJtMz/mdItI65/bV5MKSFLB8xdOOoe1lpBU5+Bx9RCejmxaRd2fQZ9rnuf4Pl00FQ0vaIuJ8SfkJkDZ3PCuaIwrkl8WsA8m2TKfLf1+MxyO5vHrWiQp3hs67ZsQNTLaXURp9ypJXtY2C2nukvp+QbngAqrrZgKxK7jMULNYLLFcE6m7QBEw1OvFf1mDVz8PMDy/jyA2U+NNGrMYtLv5xAxo6G2zbWxPi5N4EnOoMckG1rl+MK5xlqN0VXSzqELARArLs87PCBpXVs4LIJdFhwyM7d7SSggnPX/cm322GKYNpdWDQJWyA/tp8BIFPGCZUJHCcQfAchfTPhDAZAf7jIKZBYsxW0selgkD/Q6Gc65pJFkchPR+yFGhFdBL3izqPsAW5pP8SPQuKtvcDW xeVJA7Kl cww7FL3X/JpBl4THyRh67ns31Tchsv4XRZ6jHKT5HJdv4HCTmLpa2Vkw2Wg46xHu9XxOnUV/llnERh6gEzEnHMsp8Qlgg+dCUjoa+PDXMmmbfxL7q24A1f9+E2BqKFDYYQkEF X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Setup instructions for memory resource controller UI uses a mix of section headings and normal paragraphs, whereas numbered lists are better fit for this purpose. While at it, also slightly reword the instructions and add reference to "Why are cgroups needed?" in the main cgroups documentation. Signed-off-by: Bagas Sanjaya --- .../admin-guide/cgroup-v1/cgroups.rst | 2 ++ .../admin-guide/cgroup-v1/memory.rst | 26 ++++++++----------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/Documentation/admin-guide/cgroup-v1/cgroups.rst b/Documentation/admin-guide/cgroup-v1/cgroups.rst index b0688011ed06de..9343148ee99366 100644 --- a/Documentation/admin-guide/cgroup-v1/cgroups.rst +++ b/Documentation/admin-guide/cgroup-v1/cgroups.rst @@ -80,6 +80,8 @@ access. For example, cpusets (see Documentation/admin-guide/cgroup-v1/cpusets.rs you to associate a set of CPUs and a set of memory nodes with the tasks in each cgroup. +.. _cgroups-why-needed: + 1.2 Why are cgroups needed ? ---------------------------- diff --git a/Documentation/admin-guide/cgroup-v1/memory.rst b/Documentation/admin-guide/cgroup-v1/memory.rst index 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::