public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Cheng-Han Wu <hank20010209@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, Shuah Khan <skhan@linuxfoundation.org>
Cc: Randy Dunlap <rdunlap@infradead.org>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Cheng-Han Wu <hank20010209@gmail.com>
Subject: [PATCH 4/4] docs: admin-guide: add IGNORE_DIRS example for cscope
Date: Sun,  3 May 2026 18:14:29 +0800	[thread overview]
Message-ID: <20260503101429.254394-5-hank20010209@gmail.com> (raw)
In-Reply-To: <20260503101429.254394-1-hank20010209@gmail.com>

The workload tracing guide shows how to build a cscope database by
running cscope command directly. The kernel build system also provides
a cscope target, which supports IGNORE_DIRS for excluding directories
from the generated database.

Mention make cscope and show how to exclude Documentation/ as an example.

Signed-off-by: Cheng-Han Wu <hank20010209@gmail.com>
---
 Documentation/admin-guide/workload-tracing.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/Documentation/admin-guide/workload-tracing.rst b/Documentation/admin-guide/workload-tracing.rst
index c49c2a00a8b8..314e5f03474e 100644
--- a/Documentation/admin-guide/workload-tracing.rst
+++ b/Documentation/admin-guide/workload-tracing.rst
@@ -202,6 +202,15 @@ database. To get out of this mode press ctrl+d. -p option is used to
 specify the number of file path components to display. -p10 is optimal
 for browsing kernel sources.
 
+Alternatively, the kernel build system can generate the cscope database::
+
+  make cscope
+
+To exclude directories from the generated database, pass IGNORE_DIRS to
+the cscope target. For example, to exclude Documentation/, run::
+
+  make IGNORE_DIRS="Documentation" cscope
+
 What is perf and how do we use it?
 ==================================
 
-- 
2.52.0


  parent reply	other threads:[~2026-05-03 10:16 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-03 10:14 [PATCH 0/4] docs: admin-guide: improve workload tracing guide Cheng-Han Wu
2026-05-03 10:14 ` [PATCH 1/4] docs: admin-guide: fix typos in " Cheng-Han Wu
2026-05-05 18:26   ` Shuah Khan
2026-05-03 10:14 ` [PATCH 2/4] docs: admin-guide: fix stress-ng command examples Cheng-Han Wu
2026-05-05 18:27   ` Shuah Khan
2026-05-03 10:14 ` [PATCH 3/4] docs: admin-guide: clarify perf bench all behavior Cheng-Han Wu
2026-05-05 18:27   ` Shuah Khan
2026-05-03 10:14 ` Cheng-Han Wu [this message]
2026-05-05 18:24   ` [PATCH 4/4] docs: admin-guide: add IGNORE_DIRS example for cscope Shuah Khan

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=20260503101429.254394-5-hank20010209@gmail.com \
    --to=hank20010209@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.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