From patchwork Tue Jan 30 01:35:47 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13536662 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 6F611C47DB3 for ; Tue, 30 Jan 2024 01:36:16 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id EAEF96B009E; Mon, 29 Jan 2024 20:36:04 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id E12806B009F; Mon, 29 Jan 2024 20:36:04 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id C649C6B00A0; Mon, 29 Jan 2024 20:36:04 -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 AE9416B009E for ; Mon, 29 Jan 2024 20:36:04 -0500 (EST) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 9112AA19DF for ; Tue, 30 Jan 2024 01:36:04 +0000 (UTC) X-FDA: 81734261448.06.2C53D6F Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf15.hostedemail.com (Postfix) with ESMTP id EA80BA0007 for ; Tue, 30 Jan 2024 01:36:02 +0000 (UTC) Authentication-Results: imf15.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=DTmLfjtG; spf=pass (imf15.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1706578563; 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=iWu7WAEyRELmGhhGE8LMUQxtmurcGMJa0kUz/u26pBE=; b=xf8s073n+dadEFk806T558SPVXRaIH/tedcihtFEhI/gvK433auyLUYwc6DsQvmBFrcixR bsQ8S7FLH7Kw0C3bmXczT+lCfvDwa3STddo3KupKkUO80iUiuIZXU8AJNYQ0u+qc9DFKVa VtI/tC3KDW/ofIqHCvAnM7+XxremDtU= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1706578563; a=rsa-sha256; cv=none; b=A3suqFdNWm0zJw7ZsdyHVpsifE2FAjiiSSohPYq/WTGsRmfY/jbnPsOR5Ky5XIaImg58+3 zoVJnHwDbciPig5RspXP7HcEq6XmAHNqLfT3f2/KnVsaKmGFZ1V6B0txyAXGxbkc7B1RXV hum7dWxQbpo+d4VxyTvGsRB4Ju1w9M4= ARC-Authentication-Results: i=1; imf15.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=DTmLfjtG; spf=pass (imf15.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 4C42962278; Tue, 30 Jan 2024 01:36:02 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 95AE4C43399; Tue, 30 Jan 2024 01:36:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1706578562; bh=gcC9dmoQX9j+tKrb8TrQMZADNHfkIGHlBl+HK47V+ww=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DTmLfjtG2USxU7mvIhukf5t+rtNA8FRgHeVMxqey89fB+cw41bjtbJ0ueFc38YwMG 1GZRhvbIf8nTIBUWdJNAhYNnK4dDfMcibwZaDavmibS4wMMyapIrWDLAvXdUdwneWl ev39nvyIALH6/rtT4PyCtZHilUMxBH6g9myOiTK+t5TsP+hnfNQGUsmEncCI/ikxjg 7lQHveRVvEGITbaaGBHa3V3zlNBd7Je7mb2udpOJ+wZpXpegjej8rse/u3SpKAta3c bHEd2Xd4CnXuF3foqFXqLXiSLMsM0sX5S86kR2MIhHmmgTW4nOOcfuguf7K7YIdU6f 4wg1U09cC5rGA== From: SeongJae Park To: Andrew Morton Cc: SeongJae Park , Jonathan Corbet , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 8/9] Docs/admin-guide/mm/damon/usage: update for monitor_on renaming Date: Mon, 29 Jan 2024 17:35:47 -0800 Message-Id: <20240130013549.89538-9-sj@kernel.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240130013549.89538-1-sj@kernel.org> References: <20240130013549.89538-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Queue-Id: EA80BA0007 X-Rspam-User: X-Stat-Signature: msjxrkf1yxrfopgb41udgz538cgzr8ri X-Rspamd-Server: rspam03 X-HE-Tag: 1706578562-127389 X-HE-Meta: U2FsdGVkX197MKGxJfv2ASPoSaxVpYywecazKAqjHdnC4RtBqgZ5P5NbqxqUp48TFuM2gsC4kcbjsIa/mbFpcP8SFJWpbLYg9Z7eu749TSLs1NLXa+xYVsnCTW31lIQvmjiZcPRNaciJG1Mdh4zsYNUdkbs0+6MIocEO6K3w52cS1nVbTpstl4BHAEmuqvgjGS4j7j/LJnPKnQjb6foA1GjPloNdpD6K/UYfwZw6x2RSb/80z7n4iminXnEeueXpSrb24h+QjVnY3ZjeQDSYap8pjxHPj8tnxBydK8DdJYIy4y47dfN0LNG7BTnntit8yTw2GemDeW0gs8kpzRVqOulwQYch2faVFRL7LMJBaEgK3n2ni1gWxY0IzgOspBxQbiK4cWGexjLiiAlFW+UUa4FeHU8OTjzgYaUyFA+RVec926JiaOXjfifkRVcBAXsEeSWhdupBJjdEsob4JsV3KxN0FaAoEAMgGzHYlP8pSufl4+g9BsaOvu+xSABcUofZ2+v3OTj2UUZpuqatoS9isBiRsyqhEWjrYoCYWBzqYkjZWARguStlT5EJLho/qsNRL8mAuno1n2LioejekD1JwXOSDGVFrFIdrs5MHcI8jZ5gU/L9iQSh0GGeI8oJSgdXVb0tOZGTPPo8gRGnKEntyOHbvEDI5LJHEjosxuUkzppdpGRedMUmfCUmtKaPrsgJxb9Ttlczox+18B6dzKwVD+BYRGeRkLDen0kr9HyM1oeF405peggYVdXxwkuW3um42RGV73msKqJHFX7WnSJZAzKxiNkONGJnyrLnj5OF4rZdMCcdNH8FkzUkXBtn/nis0vzIHRjV+enfEy1VgWDbX0SKFqaSlfLsIu5Arm0GmDe5YgarU1OF/ZwC8zljjEYnaRydH/3+SSIUOt1Yl0Sb8NA/gE7oQqBP0vwS4yckunsn7nnCTaNP8owtk/ZCWXhEUqj06UGwVip8/yyE5oU jBPsUFa7 5WeHkKxRw+UIb4L0kiBKbhym08mqNc9yu4vjjujQIIPME9HlpDKFsM9h/yZYLEJaG7sewOzbYTba+ipGNto33kFC7zKk6bqvMY6XPS5ETHKcVuxz/bWhDFYpIfT9co9TV19Mvt1KkqqI8zRC33iiBIsMVL72ZjKe53Y1pj79zka6PquMoSMuNgpNbx+7SFSC1+GFOJaxgsEqsxwknKOe0qLBwzcVcSLs6HUvpllOzjim0bRIRtAdhfWnSc0qEw7MiLA3XfEQ+AuX8N45Fvs6XOFIYMDMGEuEHrURMvQpKjdVifwuSQPgIiE+bbyJH4NKq1zuEF+P+3cB7/zGliUNpYlw8QN/nu2K+XQ9h 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: List-Subscribe: List-Unsubscribe: Update DAMON debugfs interface sections on the usage document to reflect the fact that 'monitor_on' file has renamed to 'monitor_on_DEPRECATED'. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 29 ++++++++++---------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 5d3df18dfb9f..58c34e66b31b 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -629,8 +629,9 @@ debugfs Interface (DEPRECATED!) linux-mm@kvack.org. DAMON exports nine files, ``DEPRECATED``, ``attrs``, ``target_ids``, -``init_regions``, ``schemes``, ``monitor_on``, ``kdamond_pid``, ``mk_contexts`` -and ``rm_contexts`` under its debugfs directory, ``/damon/``. +``init_regions``, ``schemes``, ``monitor_on_DEPRECATED``, ``kdamond_pid``, +``mk_contexts`` and ``rm_contexts`` under its debugfs directory, +``/damon/``. ``DEPRECATED`` is a read-only file for the DAMON debugfs interface deprecation @@ -855,16 +856,16 @@ Turning On/Off Setting the files as described above doesn't incur effect unless you explicitly start the monitoring. You can start, stop, and check the current status of the -monitoring by writing to and reading from the ``monitor_on`` file. Writing -``on`` to the file starts the monitoring of the targets with the attributes. -Writing ``off`` to the file stops those. DAMON also stops if every target -process is terminated. Below example commands turn on, off, and check the -status of DAMON:: +monitoring by writing to and reading from the ``monitor_on_DEPRECATED`` file. +Writing ``on`` to the file starts the monitoring of the targets with the +attributes. Writing ``off`` to the file stops those. DAMON also stops if +every target process is terminated. Below example commands turn on, off, and +check the status of DAMON:: # cd /damon - # echo on > monitor_on - # echo off > monitor_on - # cat monitor_on + # echo on > monitor_on_DEPRECATED + # echo off > monitor_on_DEPRECATED + # cat monitor_on_DEPRECATED off Please note that you cannot write to the above-mentioned debugfs files while @@ -880,11 +881,11 @@ can get the pid of the thread by reading the ``kdamond_pid`` file. When the monitoring is turned off, reading the file returns ``none``. :: # cd /damon - # cat monitor_on + # cat monitor_on_DEPRECATED off # cat kdamond_pid none - # echo on > monitor_on + # echo on > monitor_on_DEPRECATED # cat kdamond_pid 18594 @@ -914,5 +915,5 @@ directory by putting the name of the context to the ``rm_contexts`` file. :: # ls foo # ls: cannot access 'foo': No such file or directory -Note that ``mk_contexts``, ``rm_contexts``, and ``monitor_on`` files are in the -root directory only. +Note that ``mk_contexts``, ``rm_contexts``, and ``monitor_on_DEPRECATED`` files +are in the root directory only.