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: 55072 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:eb09:0:0:0:0:0 with SMTP id s9csp527654wrn; Thu, 9 Feb 2023 11:25:42 -0800 (PST) X-Google-Smtp-Source: AK7set8zJnX3LGjy+Gp2csEFYCrLyd0kDCfwDVstURojoxVSxC2CodWrB0xWi8JbDw1nZ9QRn71K X-Received: by 2002:a50:d4c8:0:b0:4a1:8579:d6ee with SMTP id e8-20020a50d4c8000000b004a18579d6eemr13038686edj.42.1675970741998; Thu, 09 Feb 2023 11:25:41 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1675970741; cv=none; d=google.com; s=arc-20160816; b=shswX/+2MNT4q+ga9QESP4jdjLDznZ6y4VDQuLmTgPWfZldORUgQx/oPhotBP2H+MQ nSFAtnfagcu3oRaYwPovfMKht25o+i3i4rhc7ZTIEM0ApW/r9ZkrJMpNn/08aFV6/yu0 BuKqYmOQIFmYuN8P44PAW+BaR6t7VLimtpr2ewZwWI1J9SZSXUlt2u81CIawItrqBmKC 4PaLw8nOb7g2YPB8ncMyQyYlffwV+ktr3Ht43SocPSE9Cy7xN68y4tntSXxQIycjcDyk V32odiSTFotDUu7eT586uqADcaVwaZFMApxNK/jCEQtCHp+x+2UwqXIwnQmAg9qicErc N7Cg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=mkZoK0/aAqvT+1zrAd5/4wcBd4tA7+DHKtF9ign+pSA=; b=uKej+TsqOAxnjfv1mVx86LqTNzsH4mgd/ab14uAbx8DavsemELFXlPMOn+fzKYo6w2 Vcc2C1QxdU+m0d41toTbL331w/61A6YBBNRC7Fq2LFxyZD5fzz0TB/Z/NRm3bozTGder 3M1Jkww8IxrUTP4kox0+DAeiuTy9bgmviZrUwxqLY+pGU5ppPzan+HpobovjyKpBTPku BFLO7p2oNhuoOQ0glfmSm9f2j/tLCvU2gQF9ix00XfXQK5XcXg+NPy/TABC0i64QjKKD Ug+AdHmlVFeriMTHrGR5myj/cxN01NnoZ2V05Hcn4wRRUj53sIB6pedQ8oGH6g0d5mL7 L5Nw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=GzFX5MPf; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id ba17-20020a0564021ad100b0049ff06fc978si1503907edb.534.2023.02.09.11.25.18; Thu, 09 Feb 2023 11:25:41 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=GzFX5MPf; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230102AbjBITUZ (ORCPT + 99 others); Thu, 9 Feb 2023 14:20:25 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49530 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229772AbjBITUS (ORCPT ); Thu, 9 Feb 2023 14:20:18 -0500 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AC3AB458A1; Thu, 9 Feb 2023 11:20:16 -0800 (PST) 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 476CD61BA0; 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-Spam-Status: No, score=-7.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI, SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1757382696675407554?= X-GMAIL-MSGID: =?utf-8?q?1757382696675407554?= 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