[for-next][PATCH 2/3] tracing: Fix formatting of trace README file
From: "Steven Rostedt (Red Hat)" Fix the formatting of the README file in the trace debugfs to fit in an 80 character window. Also add a comment about the event trigger counter with regards to traceon and traceoff. Signed-off-by: Steven Rostedt --- kernel/trace/trace.c | 116 --- 1 file changed, 64 insertions(+), 52 deletions(-) diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c index 2ced5e5..7857ea9 100644 --- a/kernel/trace/trace.c +++ b/kernel/trace/trace.c @@ -3519,91 +3519,103 @@ static const char readme_msg[] = " instances\t\t- Make sub-buffers with: mkdir instances/foo\n" "\t\t\t Remove sub-buffer with rmdir\n" " trace_options\t\t- Set format or modify how tracing happens\n" - "\t\t\t Disable an option by adding a suffix 'no' to the option name\n" + "\t\t\t Disable an option by adding a suffix 'no' to the\n" + "\t\t\t option name\n" #ifdef CONFIG_DYNAMIC_FTRACE "\n available_filter_functions - list of functions that can be filtered on\n" - " set_ftrace_filter\t- echo function name in here to only trace these functions\n" - " accepts: func_full_name, *func_end, func_begin*, *func_middle*\n" - " modules: Can select a group via module\n" - " Format: :mod:\n" - " example: echo :mod:ext3 > set_ftrace_filter\n" - "triggers: a command to perform when function is hit\n" - " Format: :[:count]\n" - " trigger: traceon, traceoff\n" - " enable_event::\n" - " disable_event::\n" + " set_ftrace_filter\t- echo function name in here to only trace these\n" + "\t\t\t functions\n" + "\t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n" + "\t modules: Can select a group via module\n" + "\t Format: :mod:\n" + "\t example: echo :mod:ext3 > set_ftrace_filter\n" + "\ttriggers: a command to perform when function is hit\n" + "\t Format: :[:count]\n" + "\t trigger: traceon, traceoff\n" + "\t\t enable_event::\n" + "\t\t disable_event::\n" #ifdef CONFIG_STACKTRACE - " stacktrace\n" + "\t\t stacktrace\n" #endif #ifdef CONFIG_TRACER_SNAPSHOT - " snapshot\n" + "\t\t snapshot\n" #endif - " example: echo do_fault:traceoff > set_ftrace_filter\n" - " echo do_trap:traceoff:3 > set_ftrace_filter\n" - " The first one will disable tracing every time do_fault is hit\n" - " The second will disable tracing at most 3 times when do_trap is hit\n" - " The first time do trap is hit and it disables tracing, the counter\n" - " will decrement to 2. If tracing is already disabled, the counter\n" - " will not decrement. It only decrements when the trigger did work\n" - " To remove trigger without count:\n" - " echo '!: > set_ftrace_filter\n" - " To remove trigger with a count:\n" - " echo '!::0 > set_ftrace_filter\n" + "\t example: echo do_fault:traceoff > set_ftrace_filter\n" + "\t echo do_trap:traceoff:3 > set_ftrace_filter\n" + "\t The first one will disable tracing every time do_fault is hit\n" + "\t The second will disable tracing at most 3 times when do_trap is hit\n" + "\t The first time do trap is hit and it disables tracing, the\n" + "\t counter will decrement to 2. If tracing is already disabled,\n" + "\t the counter will not decrement. It only decrements when the\n" + "\t trigger did work\n" + "\t To remove trigger without count:\n" + "\t echo '!: > set_ftrace_filter\n" + "\t To remove trigger with a count:\n" + "\t echo '!::0 > set_ftrace_filter\n" " set_ftrace_notrace\t- echo function name in here to never trace.\n" - "accepts: func_full_name, *func_end, func_begin*, *func_middle*\n" - "modules: Can select a group via module command :mod:\n" - "Does not accept triggers\n" + "\taccepts: func_full_name, *func_end, func_begin*, *func_middle*\n" + "\tmodules: Can select a group via module command :mod:\n" + "\tDoes not accept triggers\n" #endif /* CONFIG_DYNAMIC_FTRACE */ #ifdef CONFIG_FUNCTION_TRACER - " set_ftrace_pid\t- Write pid(s) to only function trace those pids (function)\n" + " set_ftrace_pid\t- Write pid(s) to only function trace those pids\n" + "\t\t(function)\n" #endif #ifdef CONFIG_FUNCTION_GRAPH_TRACER " set_graph_function\t- Trace
[for-next][PATCH 2/3] tracing: Fix formatting of trace README file
From: Steven Rostedt (Red Hat) rost...@goodmis.org Fix the formatting of the README file in the trace debugfs to fit in an 80 character window. Also add a comment about the event trigger counter with regards to traceon and traceoff. Signed-off-by: Steven Rostedt rost...@goodmis.org --- kernel/trace/trace.c | 116 --- 1 file changed, 64 insertions(+), 52 deletions(-) diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c index 2ced5e5..7857ea9 100644 --- a/kernel/trace/trace.c +++ b/kernel/trace/trace.c @@ -3519,91 +3519,103 @@ static const char readme_msg[] = instances\t\t- Make sub-buffers with: mkdir instances/foo\n \t\t\t Remove sub-buffer with rmdir\n trace_options\t\t- Set format or modify how tracing happens\n - \t\t\t Disable an option by adding a suffix 'no' to the option name\n + \t\t\t Disable an option by adding a suffix 'no' to the\n + \t\t\t option name\n #ifdef CONFIG_DYNAMIC_FTRACE \n available_filter_functions - list of functions that can be filtered on\n - set_ftrace_filter\t- echo function name in here to only trace these functions\n -accepts: func_full_name, *func_end, func_begin*, *func_middle*\n -modules: Can select a group via module\n - Format: :mod:module-name\n -example: echo :mod:ext3 set_ftrace_filter\n - triggers: a command to perform when function is hit\n - Format: function:trigger[:count]\n -trigger: traceon, traceoff\n - enable_event:system:event\n - disable_event:system:event\n + set_ftrace_filter\t- echo function name in here to only trace these\n + \t\t\t functions\n + \t accepts: func_full_name, *func_end, func_begin*, *func_middle*\n + \t modules: Can select a group via module\n + \t Format: :mod:module-name\n + \t example: echo :mod:ext3 set_ftrace_filter\n + \ttriggers: a command to perform when function is hit\n + \t Format: function:trigger[:count]\n + \t trigger: traceon, traceoff\n + \t\t enable_event:system:event\n + \t\t disable_event:system:event\n #ifdef CONFIG_STACKTRACE - stacktrace\n + \t\t stacktrace\n #endif #ifdef CONFIG_TRACER_SNAPSHOT - snapshot\n + \t\t snapshot\n #endif -example: echo do_fault:traceoff set_ftrace_filter\n - echo do_trap:traceoff:3 set_ftrace_filter\n -The first one will disable tracing every time do_fault is hit\n -The second will disable tracing at most 3 times when do_trap is hit\n - The first time do trap is hit and it disables tracing, the counter\n - will decrement to 2. If tracing is already disabled, the counter\n - will not decrement. It only decrements when the trigger did work\n -To remove trigger without count:\n - echo '!function:trigger set_ftrace_filter\n -To remove trigger with a count:\n - echo '!function:trigger:0 set_ftrace_filter\n + \t example: echo do_fault:traceoff set_ftrace_filter\n + \t echo do_trap:traceoff:3 set_ftrace_filter\n + \t The first one will disable tracing every time do_fault is hit\n + \t The second will disable tracing at most 3 times when do_trap is hit\n + \t The first time do trap is hit and it disables tracing, the\n + \t counter will decrement to 2. If tracing is already disabled,\n + \t the counter will not decrement. It only decrements when the\n + \t trigger did work\n + \t To remove trigger without count:\n + \t echo '!function:trigger set_ftrace_filter\n + \t To remove trigger with a count:\n + \t echo '!function:trigger:0 set_ftrace_filter\n set_ftrace_notrace\t- echo function name in here to never trace.\n - accepts: func_full_name, *func_end, func_begin*, *func_middle*\n - modules: Can select a group via module command :mod:\n - Does not accept triggers\n + \taccepts: func_full_name, *func_end, func_begin*, *func_middle*\n + \tmodules: Can select a group via module command :mod:\n + \tDoes not accept triggers\n #endif /* CONFIG_DYNAMIC_FTRACE */ #ifdef CONFIG_FUNCTION_TRACER - set_ftrace_pid\t- Write pid(s) to only function trace those pids (function)\n + set_ftrace_pid\t- Write pid(s) to only function trace those pids\n + \t\t(function)\n #endif #ifdef
