From patchwork Thu Feb 9 19:20:07 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 13134994 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 D5EA3C61DA4 for ; Thu, 9 Feb 2023 19:20:19 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 34F5A6B0072; Thu, 9 Feb 2023 14:20:19 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 2FEE96B0078; Thu, 9 Feb 2023 14:20:19 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 1EDE86B007B; Thu, 9 Feb 2023 14:20:19 -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 0E5C06B0072 for ; Thu, 9 Feb 2023 14:20:19 -0500 (EST) Received: from smtpin19.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id DEFF780B9E for ; Thu, 9 Feb 2023 19:20:18 +0000 (UTC) X-FDA: 80448719316.19.90EFC44 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf22.hostedemail.com (Postfix) with ESMTP id 36090C0022 for ; Thu, 9 Feb 2023 19:20:16 +0000 (UTC) Authentication-Results: imf22.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=GzFX5MPf; spf=pass (imf22.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=1675970417; 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=vhEVlpGlFpBV3o6nTyNG+Mj+dtFqu04nem16eRLfw33vH9Uu2F/sqKACq4Tis5I3WFebgQ Q8EXoQjN9lIKcGjs8ARAG5JiwLz+OIDfp5a7qcjIO6js15Fm7cUXmcCZKXVl+Ajj3xHYob 63d4Jh2ibW9S810s6jIH8eb1rVTbMDw= ARC-Authentication-Results: i=1; imf22.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=GzFX5MPf; spf=pass (imf22.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-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1675970417; a=rsa-sha256; cv=none; b=1dhUb0kfAXYTAopGBPbrh0YbtWlYWoJuirVB/W+Pizc1ccTVtwp2si1QzpMt+VscyoRT6x QxBcbZdqnHOMnZD4BmAjdb4vDmKv2Drk546lifp5fh3N+WJOGUTUjZ10HWJe/HLnJIE1av satAcqKBPboosZacAkljdRerhR0XIm0= 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 dfw.source.kernel.org (Postfix) with ESMTPS id 4B25161BAF; Thu, 9 Feb 2023 19:20:16 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 27BDCC4339C; Thu, 9 Feb 2023 19:20:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1675970415; bh=x39PRc/T046lvvssIPKrbvAhJnKd48hEXRslXo6G51Q=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=GzFX5MPfuSPK29Lom5JhsbHaaPcgjVVf1YkoJfatDQvxT5JmnDvRrVYrsiJRGiXTK L2Pe4kmbM4k/370TpVO1iWj1l5UpsBTyojfgcZice2Ge5QrYw5xcSt9xvsFixlggAT 01IJkraGTY4i3MaiKeoiBoklVgJwQqvr8lALW54YozE9TnHdqgC77AbXHHlGtEUH5k ig1KK8mmIgy5hjL/Rpehj3X6amPuwwYe2gV1NClvixj/EL1PV6LanqN4qivaSBtGmy kUJp6CL33PK925drX8e4s92T8z+AfPtOpzjgRBJhQgT1lwJzPyb+0i9jP/jaKTJysf dSNNcCw/cXYbQ== 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 1/3] Docs/admin-guide/mm/damon/usage: add DAMON debugfs interface deprecation notice Date: Thu, 9 Feb 2023 19:20:07 +0000 Message-Id: <20230209192009.7885-2-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230209192009.7885-1-sj@kernel.org> References: <20230209192009.7885-1-sj@kernel.org> MIME-Version: 1.0 X-Rspamd-Queue-Id: 36090C0022 X-Stat-Signature: ww9mq681jxg856w5y58ijm9fafx8nkwo X-Rspam-User: X-Rspamd-Server: rspam08 X-HE-Tag: 1675970416-737478 X-HE-Meta: U2FsdGVkX1+AYHoI0vHiZBCZ4FaCGbH/Nu514syAa1y+zNbgdPr7Fbj27ajGNir5R8/39kr8WOazY/2GueOISJslk3P4+zjXyOKDlNUIkfte9mQIoll410osMXYoFFucQrZB5jiMz7VsmQ5WvlXdNqOB/6FpD+C8ZdftKN3zlEhDOcg9QJBmf1GxMne4Ub52Z58w02eHIl8O+Sue2xOyg7Abe5RoqAVcn0hg/Ad1uHuf4d98Mcc4GFi2H/OMzwZ3RGwgGAVHVX2OpRtMNFYRtZII0mAIJwzjtqjHiB4vxdLVklKkW2f3Z6iDq4p5ekUBNR5i/8riA5Sx7b4VcgTsHINXheIAnJXBTzM78iA+hPmQMbc8U5+qignbHFAz+ms7o42WtwfvgRCvYHXDui6H91+owD8HXZG0pKrOkQnOrb/tMO5+5xACHj56wxcUmop+EDePVA76yuOj3r2ngWkcosCKqeBuX5jjhQkfsLM4/DXlxzFjDZd80lYOFlIaqvdKulI0hT5v6wy/YtR3q3qixD65XschxrQIrTkfrEc96UE4nDOdUK8nmcSuXLV9VPqXQzRqQz+O9DXQGWS6fP8Lwbme+mmi0/kw+o5zOnaDxGbUAjmAQrGVX1NM1Nrhl41Pwo7OsP1Pf4bHEugsfsSBAtXakJ6ZFz3ZBy0u22MuvVfLbM64K5WjNDcI+JMI+VloKZYAuPzvwwhkTVbbRDRJCkg60MZ9qfOZ6TBKxh+t5P2XkIYMxv1CkgWRzkf6jiPSWz6FHpsFShkwDRkuFgCEjDu+3NOKQagzYV246tU4zUZogc2Uw+tGafcMrXMKVvrHq8YztXy3QQeoxeJc81ZHcg6Bn8aqb/VJIY2oS5auifnTsOfQz8o9/GQ9amKzFgntnP8+CpeBbTVwuT4Lwm/wOoqcMCE+uTHQth6FlXeDHc94L7ccFNx9e14fOPs3Dgt1B3toY3z3pkr6kGGjrhP K4HewYl+ X+W+IPuI7WhUMMjl39BvM/n/OzuEnrXaQBJ2jS7Z9hM2g1aCNK5B3UWk1FdGfaechY/8UsfMb5dkIRxFaH79YP7nn2rH55lDRoPkVnQZszHaRF+jitOLSUTH41HdaKSJtj420RsQPXpb6aHZTr5+A3E8kSElxm6CvibTnr4foRF1mVPjUhp/R6/e6byin7RE+RQzpqGaig5TChLYAe/DY4L+9xWtHx5JyB62ZRwcUWEZfB3cu67WInULvwo/FETgqQntBpPn1kc8xP/EFA1/GeIN4TxXOEirkbMTFcgtSdjunbYDTMmJKQ0z9x+ZWCwBbQvqwqmZrCNXF7MH/TYLmljGl7PbfjodUSrg/OucIntAzhTLEbJyUTbpkj2o5aV7wL8gSNfMPZrOp1nbhrlRAAUnAZYjsF/K/5KQR 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