From patchwork Mon Sep 25 10:02:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Christian Loehle X-Patchwork-Id: 13397620 Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net [23.128.96.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 668C61426C for ; Mon, 25 Sep 2023 10:02:09 +0000 (UTC) Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id D76DC2697; Mon, 25 Sep 2023 03:02:07 -0700 (PDT) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id C943ADA7; Mon, 25 Sep 2023 03:02:45 -0700 (PDT) Received: from [10.57.36.242] (unknown [10.57.36.242]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id C39193F59C; Mon, 25 Sep 2023 03:02:06 -0700 (PDT) Message-ID: Date: Mon, 25 Sep 2023 11:02:11 +0100 Precedence: bulk X-Mailing-List: linux-trace-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.15.1 Content-Language: en-US To: rostedt@goodmis.org, mhiramat@kernel.org, linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org, zhengyejian1@huawei.com From: Christian Loehle Subject: [PATCH] tracing: document buffer_size_kb more precisely X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net buffer_size_kb no longer shows the requested amount, but the one that is actually used internally for the ring buffer. commit 6d98a0f2ac3c ("tracing: Set actual size after ring buffer resize") changed the sysfs behavior such that value read will always show the actual size, while previously it showed the size that was requested through the sysfs interface, even if it was rounded up to fulfill the request. So the documentation can state that more precisely now. Signed-off-by: Christian Loehle --- Documentation/trace/ftrace.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst index 23572f6697c0..2e066b3b6edc 100644 --- a/Documentation/trace/ftrace.rst +++ b/Documentation/trace/ftrace.rst @@ -191,7 +191,7 @@ of ftrace. Here is a list of some of the key files: A few extra pages may be allocated to accommodate buffer management meta-data. If the last page allocated has room for more bytes than requested, the rest of the page will be used, - making the actual allocation bigger than requested or shown. + making the actual allocation bigger than requested. ( Note, the size may not be a multiple of the page size due to buffer management meta-data. )