summaryrefslogtreecommitdiff
path: root/Documentation/admin-guide/workload-tracing.rst
AgeCommit message (Collapse)Author
2026-05-15docs: admin-guide: add IGNORE_DIRS example for cscopeCheng-Han Wu
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>
2026-05-15docs: admin-guide: clarify perf bench all behaviorCheng-Han Wu
The workload tracing guide lists a fixed set of benchmarks for "perf bench all". This list is stale and can become outdated when perf adds, removes, or renames benchmark collections or individual benchmarks. Describe "perf bench all" as running all available benchmarks in the perf bench framework instead. Also document how to list the collections and benchmarks available on a given system. 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-4-hank20010209@gmail.com>
2026-05-15docs: admin-guide: fix stress-ng command examplesCheng-Han Wu
The workload tracing guide includes stress-ng command examples with a stray "command." word at the end. This makes the examples invalid if they are copied and run directly. Remove the stray word from the stress-ng example. Also use "--" in the perf record example to clearly separate perf record options from the workload command being recorded. 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-3-hank20010209@gmail.com>
2026-05-15docs: admin-guide: fix typos in workload tracing guideCheng-Han Wu
Fix several typos in the workload tracing guide: - sys_opennat() -> sys_openat() - annotate the to view -> annotate the output to view - sys_getegid -> sys_getegid() 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-2-hank20010209@gmail.com>
2025-11-21Documentation/admin-guide: fix typo and comment in cscope exampleJiakai Xu
This patch updates the Linux documentation for cscope, fixing two issues: 1. Corrects the typo in the command line: c"scope -d -p10 -> cscope -d -p10 2. Fixes the related documentation comment for clarity and correctness: cscope by default cscope.out database. -> cscope by default uses the cscope.out database. Signed-off-by: Jiakai Xu <jiakaiPeanut@gmail.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251119065727.3500015-1-jiakaiPeanut@gmail.com>
2025-03-12docs: Correct installation instructionI Hsin Cheng
Ammend missing "install" operation keyword after "apt-get", and fix "build-essentials" to "build-essential". Signed-off-by: I Hsin Cheng <richard120310@gmail.com> Reviewed-by: Charlie Jenkins <charlie@rivosinc.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250306030708.8133-1-richard120310@gmail.com
2025-01-10perf tools: Remove dependency on libauditCharlie Jenkins
All architectures now support HAVE_SYSCALL_TABLE_SUPPORT, so the flag is no longer needed. With the removal of the flag, the related GENERIC_SYSCALL_TABLE can also be removed. libaudit was only used as a fallback for when HAVE_SYSCALL_TABLE_SUPPORT was not defined, so libaudit is also no longer needed for any architecture. Signed-off-by: Charlie Jenkins <charlie@rivosinc.com> Tested-by: Arnaldo Carvalho de Melo <acme@redhat.com> Cc: Adrian Hunter <adrian.hunter@intel.com> Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com> Cc: Arnd Bergmann <arnd@arndb.de> Cc: Christian Brauner <brauner@kernel.org> Cc: Guo Ren <guoren@kernel.org> Cc: Günther Noack <gnoack@google.com> Cc: Ian Rogers <irogers@google.com> Cc: Ingo Molnar <mingo@redhat.com> Cc: James Clark <james.clark@linaro.org> Cc: Jiri Olsa <jolsa@kernel.org> Cc: John Garry <john.g.garry@oracle.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Leo Yan <leo.yan@linux.dev> Cc: Mark Rutland <mark.rutland@arm.com> Cc: Mickaël Salaün <mic@digikod.net> Cc: Mike Leach <mike.leach@linaro.org> Cc: Namhyung Kim <namhyung@kernel.org> Cc: Palmer Dabbelt <palmer@dabbelt.com> Cc: Paul Walmsley <paul.walmsley@sifive.com> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Will Deacon <will@kernel.org> Link: https://lore.kernel.org/r/20250108-perf_syscalltbl-v6-16-7543b5293098@rivosinc.com Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2023-02-02docs: add workload-tracing document to admin-guideShuah Khan
Add a new section to the admin-guide with information of interest to application developers and system integrators doing analysis of the Linux kernel for safety critical applications. This section will contain documents supporting analysis of kernel interactions with applications, and key kernel subsystems expectations. Add a new workload-tracing document to this new section. Signed-off-by: Shefali Sharma <sshefali021@gmail.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org> Link: https://lore.kernel.org/r/20230131221105.39216-1-skhan@linuxfoundation.org [jc: tweaked the sphinx formatting a bit] Signed-off-by: Jonathan Corbet <corbet@lwn.net>