RTLA has many options that have a default value that is used when the option is not set associated with them. Those are not covered in the documentation for the options, which creates confusion among users.
Document the default behavior for all relevant options: -H, -P, -C, --trace-buffer-size. Some of these are covered in general descriptions, only missing from the option documentation. Also, fix a few typos and incorrect naming of tracers. ----------------------- The patchset contains two parts: fixes (first five commits), and new additions for default options, which were previously undocumented or poorly documented (the rest). The patchset assumes [1] is applied, renaming included files to *.txt from *.rst, to prevent build error on "make htmldocs". Note: I am aware that there are more issues with the documentation, just not everything can (and should) be fixed in one patchset. [1] https://lore.kernel.org/linux-trace-kernel/[email protected]/ Tomas Glozar (9): Documentation/rtla: Fix typo in common_options.txt Documentation/rtla: Fix typo in common_timerlat_options.txt Documentation/rtla: Fix typo in rtla-timerlat-top.rst Documentation/rtla: Fix typo in common_timerlat_options.txt Documentation/rtla: Correct tracer name for common options Documentation/rtla: Mention default priority Documentation/rtla: Mention default cgroup state Documentation/trace: Specify exact priority for timerlat Documentation/rtla: Include defaults for tracer options Documentation/tools/rtla/common_options.txt | 16 +++++++++++++--- .../tools/rtla/common_timerlat_options.txt | 4 ++-- Documentation/tools/rtla/rtla-timerlat-top.rst | 2 +- Documentation/trace/timerlat-tracer.rst | 12 ++++++------ 4 files changed, 22 insertions(+), 12 deletions(-) -- 2.51.0
