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 00E05C636CD for ; Fri, 10 Feb 2023 04:48:50 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 8A9A46B00EF; Thu, 9 Feb 2023 23:48:50 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 85A7A6B00F1; Thu, 9 Feb 2023 23:48:50 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6AC216B00F2; Thu, 9 Feb 2023 23:48:50 -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 4CEAB6B00EF for ; Thu, 9 Feb 2023 23:48:50 -0500 (EST) Received: from smtpin16.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 2D8CF1A1263 for ; Fri, 10 Feb 2023 04:48:50 +0000 (UTC) X-FDA: 80450152020.16.D5C6A51 Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by imf06.hostedemail.com (Postfix) with ESMTP id 669A6180004 for ; Fri, 10 Feb 2023 04:48:48 +0000 (UTC) Authentication-Results: imf06.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=FMLebj8I; spf=pass (imf06.hostedemail.com: domain of sj@kernel.org designates 145.40.68.75 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=1676004528; 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=mkZoK0/aAqvT+1zrAd5/4wcBd4tA7+DHKtF9ign+pSA=; b=buvjHQ9256X3fFn4zfRUn2aR5evJ+zI57atbePyuNY9CXBiH2GtL2kSLqwYuTPqYlwcFqK ks58CNO7HJ6HMAVhQKTfzg1FUEXsNSB9s+bH0b0D8Df0LPOikcER+G3uZUIWKz74CUMzdd Wn66Ek9kNcMTAwrnIFvbFQpZwiEy4QY= ARC-Authentication-Results: i=1; imf06.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=FMLebj8I; spf=pass (imf06.hostedemail.com: domain of sj@kernel.org designates 145.40.68.75 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1676004528; a=rsa-sha256; cv=none; b=WP7bY3nAYaSBjh1xUGlas/SVAtowjvhK9VEKEwJTYY03AVyUq1WKPByWrsiDB2j/43INmg hUEGvD2kfhw0XSKnSPzNJkyjdtouhWy+dv/O1W1NID7eiM2zFRa/Ndo9h5UqfskhL6OedO NUiNp5ZDrxYm98SIVHWadPut5FlPSF8= Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id ECB7EB823B6; Fri, 10 Feb 2023 04:48:46 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 20213C433EF; Fri, 10 Feb 2023 04:48:45 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1676004525; bh=x39PRc/T046lvvssIPKrbvAhJnKd48hEXRslXo6G51Q=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=FMLebj8IqIs5vo3DVpcyJ7/HYGRcBna7bSZLxkCSGshx/DP4CdpuHOVAaOReZtRS+ mvg6Lcq2EvaItJZPKIFui4VtCK8HVABM7HJGyxpj5ZGGmKpXW0kQyBXfY2fUYKtXOc b5aOsOV2S2N6G4fwtA249ibOtNcjB+m3qgzqcTtlLBnImql24nHqtawmTX0sBceEtc OB2CmTl4Auf+1ifxMouvM7y9Es+WBzZOujAgRbNQ1TSfqoSz/PizZds/CK1iJm0L85 Hw3gZtC98Ki9w3YCcHiUvF58EOttEltnfi8IHvB2yQjDSobfBf1fgqIaLvbwZDEOQl tZieONTUe/zXA== From: SeongJae Park To: SeongJae Park , Andrew Morton Cc: Jonathan Corbet , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 1/3] Docs/admin-guide/mm/damon/usage: add DAMON debugfs interface deprecation notice Date: Fri, 10 Feb 2023 04:48:36 +0000 Message-Id: <20230210044838.63723-2-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230210044838.63723-1-sj@kernel.org> References: <20230210044838.63723-1-sj@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: 669A6180004 X-Rspam-User: X-Stat-Signature: sarp5qkwrqfdcynugghjpkjtto665sy1 X-HE-Tag: 1676004528-240783 X-HE-Meta: U2FsdGVkX19zsBqy9fVS/PJzyzDMU4e9LOC9eA70iseddaGyV5V64LZfFrkvwjHPPbQlgnOFVYLwjhgzJ6hMsgQz3F0KLSSm45KATHYQypPUvUmKmQYxBdgXWDLZwaF/7v9f+xXVg2brsIP72yiV5ga7nZzgLL2SMxSI7GQDNLP+nW1b2nMEdzGx42aadQnu/yE15Fpickf2ann/QHXY4n23blEPxWMB1jtld4AeMyzT6eBucESHYSyDg2VD4smOfE9t5ZRTIb+YmF41I7YR8cpR8hd9i8GRd3h2mWMCvlIOvBj8pvUCwaC02JLYbPKdun/9lMZGLFNruqqtsFvJW7TZWzyjYucuBWO/Z8jEP5hhDKteEp+y2IMG/MAf+XYJ4oPmKmuCDszkJH9Z+R+pUub8WXoYztbkyiHEVMb2TTRb3q3agbEr1CDVYWJ8zv432ey4YYRitQZ0uFfSc4mSTAUXAr/muHoAYvuZr4CyVexjMuwL1zOe4VekSv5FjSKTSbpG/iReUoz5ffp9Rgjb5/LtH88BcDIxFP06plsvHgJoinAMro4uEPSu+KpJ85Rf4HjwxIRdrkyN8UqjylF9D7AYQm+GNnXVogaNjXiMSM4WffudxWQ90J8YyjVuWiQwYcXamcI40VcyDHFe4FSytl5Hbxla6BC8FHLQDV4lqXDTCdxDTqqrf5KaV/R+tnpFOQmOR0jg53Ef/cU5Ybek4H/musvNGfyZoubpfs83mSGYR4qqwwtdn7GdYVfqjUQLT9ngGovvdhRt6PONdNQDv03fPTG3mn5AA+wfUm+bx8J9opsi92JYE57I6NI7iNs8RN3dITUXyySnld7Cck1AjtdEc51IvxeA1+W1H3Szt/4CfgGPwtdyQY5mT3eLoXj4cfP+6KGbIPyDFelHsnL1Ehx4Hnd0btuoggGVl1lbxWW75CIpPsUqMA4RV64JdBNu9AZOR6cYP61hwzFYsMx nZ/pJETc TM989pERKZUTQptqTRyuG6aB4rZbeP5rr9vOpVnbF89g0hnNc62TcrJz0MEFuSYCh36C8VknbNEHvg1nj7Jt2ehZtrPoegfXF7voySr+Wqbx08sk4+4SVe3zySbn+NI4MB7naRV+/79EEnkkNSkv4JKbuad52wUQGKxM5njIdB2rPgkqTXL2r8eJ9PzAvVEDPrIs++/ksEku1qkqr0QYJwmLszltv+GGaj/ULiN8aPgIO9Xn29S+wzTMktB8NPjCGnvT7pn/315C39fJ6/NNytk4MvP9MJWQ1H9CXLgSxC9IyXTKtLjChQ0qHChBUcktFWyG48GCCEsaJ2UkQFSODpwLbAAKcs9aDfRgszxIVake9cQnp6PERNQdB9js5gOwPZM89yx8iFPxkPYwWZ4ZW2sKePtgmbuYlahBB 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: DAMON debugfs interface has announced to be deprecated after >v5.15 LTS kernel is released. And, v6.1.y has announced to be an LTS[1]. Though the announcement was there for a while, some people might not noticed that so far. Also, some users could depend on it and have problems at movng to the alternative (DAMON sysfs interface). For such cases, note DAMON debugfs interface as deprecated, and contacts to ask helps on the document. [1] https://git.kernel.org/pub/scm/docs/kernel/website.git/commit/?id=332e9121320bc7461b2d3a79665caf153e51732c Signed-off-by: SeongJae Park --- Documentation/admin-guide/mm/damon/usage.rst | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst index 9237d6a25897..9b823fec974d 100644 --- a/Documentation/admin-guide/mm/damon/usage.rst +++ b/Documentation/admin-guide/mm/damon/usage.rst @@ -25,10 +25,12 @@ DAMON provides below interfaces for different users. interface provides only simple :ref:`statistics ` for the monitoring results. For detailed monitoring results, DAMON provides a :ref:`tracepoint `. -- *debugfs interface.* +- *debugfs interface. (DEPRECATED!)* :ref:`This ` is almost identical to :ref:`sysfs interface - `. This will be removed after next LTS kernel is released, - so users should move to the :ref:`sysfs interface `. + `. This is deprecated, so users should move to the + :ref:`sysfs interface `. If you depend on this and cannot + move, please report your usecase to damon@lists.linux.dev and + linux-mm@kvack.org. - *Kernel Space Programming Interface.* :doc:`This ` is for kernel space programmers. Using this, users can utilize every feature of DAMON most flexibly and efficiently by @@ -487,13 +489,17 @@ the files as above. Above is only for an example. .. _debugfs_interface: -debugfs Interface -================= +debugfs Interface (DEPRECATED!) +=============================== .. note:: - DAMON debugfs interface will be removed after next LTS kernel is released, so - users should move to the :ref:`sysfs interface `. + THIS IS DEPRECATED! + + DAMON debugfs interface is deprecated, so users should move to the + :ref:`sysfs interface `. If you depend on this and cannot + move, please report your usecase to damon@lists.linux.dev and + linux-mm@kvack.org. DAMON exports eight files, ``attrs``, ``target_ids``, ``init_regions``, ``schemes``, ``monitor_on``, ``kdamond_pid``, ``mk_contexts`` and -- 2.25.1