]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
docs: admin-guide: add IGNORE_DIRS example for cscope
authorCheng-Han Wu <hank20010209@gmail.com>
Sun, 3 May 2026 10:14:29 +0000 (18:14 +0800)
committerJonathan Corbet <corbet@lwn.net>
Fri, 15 May 2026 14:48:28 +0000 (08:48 -0600)
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>
Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260503101429.254394-5-hank20010209@gmail.com>

Documentation/admin-guide/workload-tracing.rst

index c49c2a00a8b80c73ef83e31d02244c93a847a46e..314e5f03474e6f880e678b01d72f4ea1c29fcc8c 100644 (file)
@@ -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?
 ==================================