From mboxrd@z Thu Jan 1 00:00:00 1970 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 F127EEE14C3 for ; Thu, 7 Sep 2023 02:30:04 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 5DAFB280029; Wed, 6 Sep 2023 22:29:47 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 3E570280030; Wed, 6 Sep 2023 22:29:47 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 21015280029; Wed, 6 Sep 2023 22:29:47 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 0009828002E for ; Wed, 6 Sep 2023 22:29:46 -0400 (EDT) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id CA28FB42B6 for ; Thu, 7 Sep 2023 02:29:46 +0000 (UTC) X-FDA: 81208220772.06.53C7A68 Received: from sin.source.kernel.org (sin.source.kernel.org [145.40.73.55]) by imf21.hostedemail.com (Postfix) with ESMTP id 9C77A1C0004 for ; Thu, 7 Sep 2023 02:29:44 +0000 (UTC) Authentication-Results: imf21.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=P13xdxS4; spf=pass (imf21.hostedemail.com: domain of sj@kernel.org designates 145.40.73.55 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=1694053785; 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=8qVOlJbQg5WpMY88dRdLG9yIZfdeC+Hc8xuFzhLuiEk=; b=vTxCyRbJrtDpnonBSdAJ0DKY4/NTYU5sea2fTNNQmnH+4VzBElckBMRNudKfjEFgZMS0sR +JyXuTweflZ4bM45Kx7JmPVOhRQgJ8YckYVct80QQnC8AD1OCE94BGKByWXl5WyWsMcFwR hdZgM6WaP9DMqERXRRBzYfP+5K41Rqw= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1694053785; a=rsa-sha256; cv=none; b=IRrg+1vJDszDHuyap2CfzIr15RNIpYfRstGwRR+WiGkjKIphkNpBr/CcLK0SAkU/Xjd8sm EB3L5k1ofhVuc52E/YfEf4g8uCpyij2okoVjMPwNw2wwKJdtWfvb5DP69IAaL9cD/lXjh3 Q/PCZd1vQCDIna2pQl+mPVg2hApyomI= ARC-Authentication-Results: i=1; imf21.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=P13xdxS4; spf=pass (imf21.hostedemail.com: domain of sj@kernel.org designates 145.40.73.55 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by sin.source.kernel.org (Postfix) with ESMTPS id 56841CE1843; Thu, 7 Sep 2023 02:29:41 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 756FAC433CA; Thu, 7 Sep 2023 02:29:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1694053779; bh=ddAwo+PJ4HbDbLRCVex0LmwHXE3nv9K1631hg64QSQQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=P13xdxS4wlGAVIBUe5kpWPR/UNmFyYTU4FLLLMcCHrKh3uUJ1xUCoyNRngufVl8B/ VvJ+If3uwJfzB71IHKAUD238aAFRPRvh8Uc+23igy+x6rguGNyGfpt4cIiqz/Rwyvo cdqrwQY0g6DFBeJuVmSoMlAdEBwMPPBXGOpAGZSZW9CAoGUbfGNuZuucH6JmAOaim5 xFvqb7c55zEtR86oxNiJVzFYZMGAV/FfX8LJYvMggb+uNfja4GUtBfiHvpAUH9XBdL 2bsLXJNCa0vHIZ7Ef6iRQ0I/ijEwT0vn62cEXBrYQpc4PQITTO9myhuqgpaT2/1QB8 suwu4x18IKU/A== 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 02/11] Docs/admin-guide/mm/damon/usage: place debugfs usage at the bottom Date: Thu, 7 Sep 2023 02:29:20 +0000 Message-Id: <20230907022929.91361-3-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230907022929.91361-1-sj@kernel.org> References: <20230907022929.91361-1-sj@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: 9C77A1C0004 X-Rspam-User: X-Rspamd-Server: rspam11 X-Stat-Signature: ihce3brrdr633qbcdhou3fer7y9c881o X-HE-Tag: 1694053784-104125 X-HE-Meta: U2FsdGVkX1/3K1Rq2GwAj5huyoR1W9igWObUhb6/Z/sn05PmSBU+Dfr8xVpPofPvbul/YaiG57NrI8n7u68DpsrruDzyAEtPPsxHKg0wOamb1xEcOGy47mTUFpc064Be54hpSpOOlFNr1OgkWQ9sIQ64Ertv2qIJJWr/gs9+w9HDHcqd9lcg/28/dhz61EUVxVqY6yFeBCibsCw97V9EQcyhyHpSCeJ1y6BA+MakRYI7nMqNy80Xi0xhmYLIpNVfoTwaX0ulr5KRlJwJuRksBFpsSDC6uq0eLbFvLCxzlV9+SAQD1XudzHejB7uNuybVE0ef1Ot4x9Kwx8shlUL28a/wRnJdsnzO92WIsvg+b8Zu/VwdYu9qt7j5lhPX68D+HXSdATlA5wfnKGq++erJBhXobAG/+g0O28K/Ih28D5ZQYeSRitDfhSMAA3DPP+fgPU0B+nWAxI9kbQWXXSsLZvY7v1DO7a/uAADpPmc+qIwZI+fW/dc6UUVMQTuAJDxcUYlzvEm19SNF2HymMbEjyEnuS91x7eMjyX18W3xsAuTc6LiXp7V4Th317QJqb1wIjPMIfEuNSqtCpzb7I+ZBPdYpYuhMBCkm0qUm+kdGVzFv7cuo+HcV95KT4PTdgMg/9s346hjlCH6stFIf0DOiYfeXki2DUHRjMCAhaSIfajrKNPHWTu0rNYwkLX81LgvbC//gwjpgd9pVR6wPq1x9NyfnJwMBqHyTTIIjggZSfwbi55gE0AyGNExr1e65qqDVXah47frVhcPa34Z5aURQ8/GPJTKso3p10+eflHRgVOR1MPXrdUtKPOryk0Qi0NyfPaDzU9uTBCzEfJ4/HsPAXvm3mcS4+t2NdrxF/65Zie3EwOc39XoArvH4RLE+SCTBetCEqJ+7mBxo6re7IAJ6jDD+cC9pJ4h5b+qzHuSKs0wBcgBGX4Op4sC5lKvsXDinMH1GKX/8jyxa0eeEhEa W8lk+GIy MuyMu8lLHsBKUKShQb4UAYNdoRRXBOig3A8F+JXdGXS8Q6ucsNngb/iVaVIid5c02sH7sCb6Ga8pH5kF93q4p/wjiHg4mV1ifCM5z2lH7RN6tdyQ2lcVKwXXaGNGxLJZzixYxSeochQlPa7Ye9Xu88+0LYNCnIZZB4rPTgg0FQAkjn6WXd0Rsk2blWivEefnSZMVycHAGd5x14rZwnEoSagtw+d8I1dJGNuMh7f9DwW3QuKUmA5/A4XP6Ry2TFZH8C42KgonxylK3hss0DWUuC1Mvn1iNGc5OloK1B+C26TzPXy/Ra1gn6sRnrmMyaJmpg2NEUrjJOiOBBu4EkO+tdZkjGma5fnelMQE2MpS9IMsXSsU= 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: debugfs interface is deprecated. Put it at the bottom of the document so that readers have less chances to read it. Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 39 ++++++++++---------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 834eefe39650..bffe9dd9b0d6 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -495,6 +495,25 @@ Please note that it's highly recommended to use user space tools like `damo `_ rather than manually reading and writing the files as above. Above is only for an example. +.. _tracepoint: + +Tracepoint for Monitoring Results +================================= + +Users can get the monitoring results via the :ref:`tried_regions +` or a tracepoint, ``damon:damon_aggregated``. +While the tried regions directory is useful for getting a snapshot, the +tracepoint is useful for getting a full record of the results. While the +monitoring is turned on, you could record the tracepoint events and show +results using tracepoint supporting tools like ``perf``. For example:: + + # echo on > monitor_on + # perf record -e damon:damon_aggregated & + # sleep 5 + # kill 9 $(pidof perf) + # echo off > monitor_on + # perf script + .. _debugfs_interface: debugfs Interface (DEPRECATED!) @@ -790,23 +809,3 @@ directory by putting the name of the context to the ``rm_contexts`` file. :: Note that ``mk_contexts``, ``rm_contexts``, and ``monitor_on`` files are in the root directory only. - - -.. _tracepoint: - -Tracepoint for Monitoring Results -================================= - -Users can get the monitoring results via the :ref:`tried_regions -` or a tracepoint, ``damon:damon_aggregated``. -While the tried regions directory is useful for getting a snapshot, the -tracepoint is useful for getting a full record of the results. While the -monitoring is turned on, you could record the tracepoint events and show -results using tracepoint supporting tools like ``perf``. For example:: - - # echo on > monitor_on - # perf record -e damon:damon_aggregated & - # sleep 5 - # kill 9 $(pidof perf) - # echo off > monitor_on - # perf script -- 2.25.1