ftrace: improve documentation
authorwalimis <walimisdev@gmail.com>
Fri, 28 Nov 2008 04:21:19 +0000 (12:21 +0800)
committerIngo Molnar <mingo@elte.hu>
Fri, 28 Nov 2008 12:15:14 +0000 (13:15 +0100)
commitc072c24975ec4f0ccfcb6f5c8a8040b6eb75ef8f
tree39d5e69fa5a7c98b71c103d7f4e0f7318215ddae
parent50cdaf08a8ec1d7f43987705da7aff7cf949708f
ftrace: improve documentation

Impact: extend documentation with notice of using wild cards correctly

We know that we can use wild cards to set set_ftrace_filter, but there's
problem when using them naively such as:

   echo h* > /debug/tracing/set_ftrace_filter

If there are files named with "h" prefix in current directory,
echo "h*" will echo these filenames to set_ftrace_filter, not the
intended "h*".

For example:

  $ cat /debug/tracing/available_filter_functions |grep ^hr |wc -l
  23
  $ ls
  $ touch hraa hrdd
  $ ls
  hraa  hrdd
  $ echo hr* > /debug/tracing/set_ftrace_filter
  $ cat /debug/tracing/set_ftrace_filter

No output in /debug/tracing/set_ftrace_filter!

If we use '' to escape wild cards, it works:

  $ ls
  hraa  hrdd
  $ echo "hr*" > /debug/tracing/set_ftrace_filter
  $ cat /debug/tracing/set_ftrace_filter |wc -l
  23

This problem can lead to unexpected result if current directory has a
lot of files.

Signed-off-by: walimis <walimisdev@gmail.com>
Acked-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Documentation/ftrace.txt