Linux Perf Users
 help / color / mirror / Atom feed
From: Kohei Enju <kohei@enjuk.jp>
To: linux-perf-users@vger.kernel.org
Cc: Peter Zijlstra <peterz@infradead.org>,
	Ingo Molnar <mingo@redhat.com>,
	Arnaldo Carvalho de Melo <acme@kernel.org>,
	Namhyung Kim <namhyung@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Alexander Shishkin <alexander.shishkin@linux.intel.com>,
	Jiri Olsa <jolsa@kernel.org>, Ian Rogers <irogers@google.com>,
	Adrian Hunter <adrian.hunter@intel.com>,
	James Clark <james.clark@linaro.org>, Kohei Enju <kohei@enjuk.jp>
Subject: [PATCH v1 1/2] perf config: Fix annotate.hide_src_code documentation
Date: Tue, 18 Aug 2026 14:40:12 +0000	[thread overview]
Message-ID: <20260818144149.101248-2-kohei@enjuk.jp> (raw)
In-Reply-To: <20260818144149.101248-1-kohei@enjuk.jp>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=y, Size: 1909 bytes --]

annotate.hide_src_code defaults to true since commit e201757f7a0a ("perf
annotate: Fix source code annotate with objdump"), but the perf config
documentation still describes the default as false in a few places.

Update the documented default and the example.

Signed-off-by: Kohei Enju <kohei@enjuk.jp>
---
 tools/perf/Documentation/perf-config.txt    | 6 +++---
 tools/perf/Documentation/perfconfig.example | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
index 9b223f892829..589bc7f36012 100644
--- a/tools/perf/Documentation/perf-config.txt
+++ b/tools/perf/Documentation/perf-config.txt
@@ -96,7 +96,7 @@ Given a $HOME/.perfconfig like this:
 
 	[annotate]
 		# Defaults
-		hide_src_code = false
+		hide_src_code = true
 		use_offset = true
 		jump_arrows = true
 		show_nr_jumps = false
@@ -126,7 +126,7 @@ Given a $HOME/.perfconfig like this:
 		skip-empty = true
 
 
-You can hide source code of annotate feature setting the config to false with
+You can hide source code of annotate feature setting the config to true with
 
 	% perf config annotate.hide_src_code=true
 
@@ -291,7 +291,7 @@ annotate.*::
 		│        mov    (%rdi),%rdx
 
 		But if this option is 'false', source code of the part
-		can be also printed as below. Default is 'false'.
+		can be also printed as below. Default is 'true'.
 
 		│      struct rb_node *rb_next(const struct rb_node *node)
 		│      {
diff --git a/tools/perf/Documentation/perfconfig.example b/tools/perf/Documentation/perfconfig.example
index 2b477c1d1efe..f9c202a25fa0 100644
--- a/tools/perf/Documentation/perfconfig.example
+++ b/tools/perf/Documentation/perfconfig.example
@@ -23,7 +23,7 @@
 [annotate]
 
 	# Defaults
-	hide_src_code = false
+	hide_src_code = true
 	use_offset = true
 	jump_arrows = true
 	show_nr_jumps = false
-- 
2.53.0


  reply	other threads:[~2026-08-18 16:03 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-18 14:40 [PATCH v1 0/2] perf annotate: Fix source option behavior and Kohei Enju
2026-08-18 14:40 ` Kohei Enju [this message]
2026-08-18 16:05   ` [PATCH v1 1/2] perf config: Fix annotate.hide_src_code documentation sashiko-bot
2026-08-18 14:40 ` [PATCH v1 2/2] perf annotate: Honor explicit --source option Kohei Enju
2026-08-18 16:10   ` sashiko-bot

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260818144149.101248-2-kohei@enjuk.jp \
    --to=kohei@enjuk.jp \
    --cc=acme@kernel.org \
    --cc=adrian.hunter@intel.com \
    --cc=alexander.shishkin@linux.intel.com \
    --cc=irogers@google.com \
    --cc=james.clark@linaro.org \
    --cc=jolsa@kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=mingo@redhat.com \
    --cc=namhyung@kernel.org \
    --cc=peterz@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox