From patchwork Fri Feb 10 04:48:36 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 55213 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:eb09:0:0:0:0:0 with SMTP id s9csp755485wrn; Thu, 9 Feb 2023 20:51:27 -0800 (PST) X-Google-Smtp-Source: AK7set86sw2BwnEWTMYVYnjZaecg7hl7OiVMOdK9Rf6ZIxx0hGIl8tq6nQz4KnmY7qdR+jt/Fh9w X-Received: by 2002:a17:906:36d9:b0:878:7921:9a94 with SMTP id b25-20020a17090636d900b0087879219a94mr13233942ejc.16.1676004687529; Thu, 09 Feb 2023 20:51:27 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1676004687; cv=none; d=google.com; s=arc-20160816; b=wgckRlFhZQiWHNP3s1YyoQdPD40VcfZOqSpbRegXU3S4CCZNWRgMvmRAA34bb3kxbd CGt6yMJbfh0SISu/8OBFgJTGs+UBaKoGaVlGoW7LYoTEabmpXpOqgByS4VTVwcT8Dqrq +bbfu71tGHNdPpk7MPipZKirnEbQQyoG3wm2mGkS6+kf6C0gq65E9O1RjASdC80rnm8L K7wpuENKlW3Ph58/VXI3AEqtDMSRPA9UItpLRStAODQG7Bw4cpCKA/0ToT6pfG3tVy+f 74zrPC6fn+gERFVC8V1+JbAyBGF88b0KeWuTYh8Ys42JLq0gIcwT2FVzcYtef8jD0hxh 7Aaw== 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=hdPlpMe9XNcFgH3Hh+UydniNQR36DmHOz80a7rLEOZZUjsSfPfUlsIHkRIetoJuMfA QQzgd3eeiwbytBzU+ivjYNhN9c1X6YLaYKYljPyVfyvwm9FC1/cCdnh3apkNCZcI/z5x oP7PDlTu/BSwuojVucMODHT30aSmkrXmoSkWYp2lsF9qbaCg4GlRrJ6c+4BoXT6LgwkP VR/K4AY7v94b7pyftAO8UFmJO4HlVBmwEtsZ3Kd8otfl/ryUeAkACFCGdPsUidOBIPWr xhKrGhShOk41CvwkMqFLSojyIlMoOSvvMX210rK4jpdcFFSkzK5ugdilHeZJdXZZ2/qA 7Gfg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=FMLebj8I; 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 zy21-20020a17090734d500b0088e0c76c466si4330586ejb.356.2023.02.09.20.51.04; Thu, 09 Feb 2023 20:51:27 -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=FMLebj8I; 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 S230286AbjBJEs6 (ORCPT + 99 others); Thu, 9 Feb 2023 23:48:58 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38606 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230325AbjBJEst (ORCPT ); Thu, 9 Feb 2023 23:48:49 -0500 Received: from ams.source.kernel.org (ams.source.kernel.org [145.40.68.75]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4F06A5B74E; Thu, 9 Feb 2023 20:48:48 -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 ams.source.kernel.org (Postfix) with ESMTPS id D5B00B82396; 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 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?1757418291205166281?= X-GMAIL-MSGID: =?utf-8?q?1757418291205166281?= 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