Browse Source

docs: ftrace: fix a few formatting issues

Make sure that literal * characters are not interpreted as emphasis
markers.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jonathan Corbet 7 years ago
parent
commit
6234c7bd8c
2 changed files with 9 additions and 9 deletions
  1. 5 5
      Documentation/trace/events.rst
  2. 4 4
      Documentation/trace/ftrace.rst

+ 5 - 5
Documentation/trace/events.rst

@@ -42,7 +42,7 @@ To disable all events, echo an empty line to the set_event file::
 
 
 	# echo > /sys/kernel/debug/tracing/set_event
 	# echo > /sys/kernel/debug/tracing/set_event
 
 
-To enable all events, echo '*:*' or '*:' to the set_event file::
+To enable all events, echo ``*:*`` or ``*:`` to the set_event file::
 
 
 	# echo *:* > /sys/kernel/debug/tracing/set_event
 	# echo *:* > /sys/kernel/debug/tracing/set_event
 
 
@@ -50,7 +50,7 @@ The events are organized into subsystems, such as ext4, irq, sched,
 etc., and a full event name looks like this: <subsystem>:<event>.  The
 etc., and a full event name looks like this: <subsystem>:<event>.  The
 subsystem name is optional, but it is displayed in the available_events
 subsystem name is optional, but it is displayed in the available_events
 file.  All of the events in a subsystem can be specified via the syntax
 file.  All of the events in a subsystem can be specified via the syntax
-"<subsystem>:*"; for example, to enable all irq events, you can use the
+``<subsystem>:*``; for example, to enable all irq events, you can use the
 command::
 command::
 
 
 	# echo 'irq:*' > /sys/kernel/debug/tracing/set_event
 	# echo 'irq:*' > /sys/kernel/debug/tracing/set_event
@@ -111,8 +111,8 @@ It also displays the format string that will be used to print the
 event in text mode, along with the event name and ID used for
 event in text mode, along with the event name and ID used for
 profiling.
 profiling.
 
 
-Every event has a set of 'common' fields associated with it; these are
-the fields prefixed with 'common_'.  The other fields vary between
+Every event has a set of ``common`` fields associated with it; these are
+the fields prefixed with ``common_``.  The other fields vary between
 events and correspond to the fields defined in the TRACE_EVENT
 events and correspond to the fields defined in the TRACE_EVENT
 definition for that event.
 definition for that event.
 
 
@@ -190,7 +190,7 @@ And for string fields they are:
 
 
 ==, !=, ~
 ==, !=, ~
 
 
-The glob (~) accepts a wild card character (*,?) and character classes
+The glob (~) accepts a wild card character (\*,?) and character classes
 ([). For example::
 ([). For example::
 
 
   prev_comm ~ "*sh"
   prev_comm ~ "*sh"

+ 4 - 4
Documentation/trace/ftrace.rst

@@ -2615,13 +2615,13 @@ To see which functions are being traced, you can cat the file:
 
 
 Perhaps this is not enough. The filters also allow glob(7) matching.
 Perhaps this is not enough. The filters also allow glob(7) matching.
 
 
-  <match>*
+  ``<match>*``
 	will match functions that begin with <match>
 	will match functions that begin with <match>
-  *<match>
+  ``*<match>``
 	will match functions that end with <match>
 	will match functions that end with <match>
-  *<match>*
+  ``*<match>*``
 	will match functions that have <match> in it
 	will match functions that have <match> in it
-  <match1>*<match2>
+  ``<match1>*<match2>``
 	will match functions that begin with <match1> and end with <match2>
 	will match functions that begin with <match1> and end with <match2>
 
 
 .. note::
 .. note::