tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: trace: fix event state structure name

The documentation refers to a non-existent 'struct synth_trace_state'
structure. The correct name is 'struct synth_event_trace_state'.

In other words, this patch is a mechanical substitution:
s/synth_trace_state/synth_event_trace_state/g

Signed-off-by: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>
Reviewed-by: Tom Zanussi <zanussi@kernel.org>
Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Link: https://lore.kernel.org/r/20201104122113.322452-1-dedekind1@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Artem Bityutskiy and committed by
Jonathan Corbet 301de546 4aaf08dc

+5 -5
+5 -5
Documentation/trace/events.rst
··· 798 798 synth_event_trace_start() function is used to 'open' the synthetic 799 799 event trace:: 800 800 801 - struct synth_trace_state trace_state; 801 + struct synth_event_trace_state trace_state; 802 802 803 803 ret = synth_event_trace_start(schedtest_event_file, &trace_state); 804 804 805 805 It's passed the trace_event_file representing the synthetic event 806 806 using the same methods as described above, along with a pointer to a 807 - struct synth_trace_state object, which will be zeroed before use and 807 + struct synth_event_trace_state object, which will be zeroed before use and 808 808 used to maintain state between this and following calls. 809 809 810 810 Once the event has been opened, which means space for it has been ··· 816 816 817 817 To assign the values one after the other without lookups, 818 818 synth_event_add_next_val() should be used. Each call is passed the 819 - same synth_trace_state object used in the synth_event_trace_start(), 819 + same synth_event_trace_state object used in the synth_event_trace_start(), 820 820 along with the value to set the next field in the event. After each 821 821 field is set, the 'cursor' points to the next field, which will be set 822 822 by the subsequent call, continuing until all the fields have been set ··· 845 845 ret = synth_event_add_next_val(395, &trace_state); 846 846 847 847 To assign the values in any order, synth_event_add_val() should be 848 - used. Each call is passed the same synth_trace_state object used in 848 + used. Each call is passed the same synth_event_trace_state object used in 849 849 the synth_event_trace_start(), along with the field name of the field 850 850 to set and the value to set it to. The same sequence of calls as in 851 851 the above examples using this method would be (without error-handling ··· 867 867 868 868 Finally, the event won't be actually traced until it's 'closed', 869 869 which is done using synth_event_trace_end(), which takes only the 870 - struct synth_trace_state object used in the previous calls:: 870 + struct synth_event_trace_state object used in the previous calls:: 871 871 872 872 ret = synth_event_trace_end(&trace_state); 873 873