Skip to contentSkip to conversation

docs: trace: fix event state structure name

PATCH In review Artem Bityutskiy 4 participants 5 messages Nov 4, 2020 – Dec 8, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: trace: fix event state structure name

From: Artem Bityutskiy <[email protected]>

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

---
 Documentation/trace/events.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/trace/events.rst +5 -5
index f792b1959a33..bdba7b0e19ef 100644
@@ -787,13 +787,13 @@ To trace a synthetic using the piecewise method described above, the
 synth_event_trace_start() function is used to 'open' the synthetic
 event trace::
 
-       struct synth_trace_state trace_state;
+       struct synth_event_trace_state trace_state;
 
        ret = synth_event_trace_start(schedtest_event_file, &trace_state);
 
 It's passed the trace_event_file representing the synthetic event
 using the same methods as described above, along with a pointer to a
-struct synth_trace_state object, which will be zeroed before use and
+struct synth_event_trace_state object, which will be zeroed before use and
 used to maintain state between this and following calls.
 
 Once the event has been opened, which means space for it has been
@@ -805,7 +805,7 @@ lookup per field.
 
 To assign the values one after the other without lookups,
 synth_event_add_next_val() should be used.  Each call is passed the
-same synth_trace_state object used in the synth_event_trace_start(),
+same synth_event_trace_state object used in the synth_event_trace_start(),
 along with the value to set the next field in the event.  After each
 field is set, the 'cursor' points to the next field, which will be set
 by the subsequent call, continuing until all the fields have been set
@@ -834,7 +834,7 @@ this method would be (without error-handling code)::
        ret = synth_event_add_next_val(395, &trace_state);
 
 To assign the values in any order, synth_event_add_val() should be
-used.  Each call is passed the same synth_trace_state object used in
+used.  Each call is passed the same synth_event_trace_state object used in
 the synth_event_trace_start(), along with the field name of the field
 to set and the value to set it to.  The same sequence of calls as in
 the above examples using this method would be (without error-handling
@@ -856,7 +856,7 @@ can be used but not both at the same time.
 
 Finally, the event won't be actually traced until it's 'closed',
 which is done using synth_event_trace_end(), which takes only the
-struct synth_trace_state object used in the previous calls::
+struct synth_event_trace_state object used in the previous calls::
 
        ret = synth_event_trace_end(&trace_state);
 
Signature · 1 line
2.26.2
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 8 lines · On Wed, 4 Nov 2020 14:21:13 +0200 Artem Bityutskiy <[email protected]> wrote:

From: Artem Bityutskiy <[email protected]>

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

-- Steve

Quoted 52 lines
---
 Documentation/trace/events.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/trace/events.rst +5 -5
index f792b1959a33..bdba7b0e19ef 100644
@@ -787,13 +787,13 @@ To trace a synthetic using the piecewise method described above, the
 synth_event_trace_start() function is used to 'open' the synthetic
 event trace::
 
-       struct synth_trace_state trace_state;
+       struct synth_event_trace_state trace_state;
 
        ret = synth_event_trace_start(schedtest_event_file, &trace_state);
 
 It's passed the trace_event_file representing the synthetic event
 using the same methods as described above, along with a pointer to a
-struct synth_trace_state object, which will be zeroed before use and
+struct synth_event_trace_state object, which will be zeroed before use and
 used to maintain state between this and following calls.
 
 Once the event has been opened, which means space for it has been
@@ -805,7 +805,7 @@ lookup per field.
 
 To assign the values one after the other without lookups,
 synth_event_add_next_val() should be used.  Each call is passed the
-same synth_trace_state object used in the synth_event_trace_start(),
+same synth_event_trace_state object used in the synth_event_trace_start(),
 along with the value to set the next field in the event.  After each
 field is set, the 'cursor' points to the next field, which will be set
 by the subsequent call, continuing until all the fields have been set
@@ -834,7 +834,7 @@ this method would be (without error-handling code)::
        ret = synth_event_add_next_val(395, &trace_state);
 
 To assign the values in any order, synth_event_add_val() should be
-used.  Each call is passed the same synth_trace_state object used in
+used.  Each call is passed the same synth_event_trace_state object used in
 the synth_event_trace_start(), along with the field name of the field
 to set and the value to set it to.  The same sequence of calls as in
 the above examples using this method would be (without error-handling
@@ -856,7 +856,7 @@ can be used but not both at the same time.
 
 Finally, the event won't be actually traced until it's 'closed',
 which is done using synth_event_trace_end(), which takes only the
-struct synth_trace_state object used in the previous calls::
+struct synth_event_trace_state object used in the previous calls::
 
        ret = synth_event_trace_end(&trace_state);
 
Reviewed-by on v1 1/1
#2 lore raw
In reply to Artem Bityutskiy

Hi Artem,

Quoted 9 lines · Artem Bityutskiy

From: Artem Bityutskiy <[email protected]>

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

Thanks for fixing this!

Quoted 62 lines
---
 Documentation/trace/events.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/trace/events.rst +0 -0
index f792b1959a33..bdba7b0e19ef 100644
@@ -787,13 +787,13 @@ To trace a synthetic using the piecewise method

described above, the
synth_event_trace_start() function is used to 'open' the synthetic event trace::

Documentation/trace/events.rst +1 -1
-       struct synth_trace_state trace_state;
+       struct synth_event_trace_state trace_state;
 
        ret = synth_event_trace_start(schedtest_event_file,

&trace_state);

It's passed the trace_event_file representing the synthetic event using the same methods as described above, along with a pointer to a

Documentation/trace/events.rst +1 -1
-struct synth_trace_state object, which will be zeroed before use and
+struct synth_event_trace_state object, which will be zeroed before

use and
used to maintain state between this and following calls.

Once the event has been opened, which means space for it has been

Documentation/trace/events.rst +1 -1
@@ -805,7 +805,7 @@ lookup per field.
 
 To assign the values one after the other without lookups,
 synth_event_add_next_val() should be used.  Each call is passed the
-same synth_trace_state object used in the synth_event_trace_start(),
+same synth_event_trace_state object used in the
 synth_event_trace_start(),
 along with the value to set the next field in the event.  After each
 field is set, the 'cursor' points to the next field, which will be

set
by the subsequent call, continuing until all the fields have been
set

Documentation/trace/events.rst +0 -0
@@ -834,7 +834,7 @@ this method would be (without error-handling

code)::

        ret = synth_event_add_next_val(395, &trace_state);

To assign the values in any order, synth_event_add_val() should be

Documentation/trace/events.rst +1 -1
-used.  Each call is passed the same synth_trace_state object used in
+used.  Each call is passed the same synth_event_trace_state object

used in
the synth_event_trace_start(), along with the field name of the
field
to set and the value to set it to. The same sequence of calls as in the above examples using this method would be (without error-
handling

Documentation/trace/events.rst +1 -1
@@ -856,7 +856,7 @@ can be used but not both at the same time.
 
 Finally, the event won't be actually traced until it's 'closed',
 which is done using synth_event_trace_end(), which takes only the
-struct synth_trace_state object used in the previous calls::
+struct synth_event_trace_state object used in the previous calls::
 
        ret = synth_event_trace_end(&trace_state);
 
maintainer Acked-by
#3 lore raw
Quoted 8 lines · On Fri, 06 Nov 2020 14:47:46 -0600 Tom Zanussi <[email protected]> wrote:

Hi Artem,

Quoted 5 lines · Artem Bityutskiy

From: Artem Bityutskiy <[email protected]>

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

Quoted 9 lines
Quoted 4 lines

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

Thanks for fixing this!

Jon,

Can you take this patch?

-- Steve

Quoted 63 lines
Quoted 63 lines
---
 Documentation/trace/events.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/trace/events.rst +0 -0
index f792b1959a33..bdba7b0e19ef 100644
@@ -787,13 +787,13 @@ To trace a synthetic using the piecewise method

described above, the
synth_event_trace_start() function is used to 'open' the synthetic event trace::

Documentation/trace/events.rst +1 -1
-       struct synth_trace_state trace_state;
+       struct synth_event_trace_state trace_state;
 
        ret = synth_event_trace_start(schedtest_event_file,

&trace_state);

It's passed the trace_event_file representing the synthetic event using the same methods as described above, along with a pointer to a

Documentation/trace/events.rst +1 -1
-struct synth_trace_state object, which will be zeroed before use and
+struct synth_event_trace_state object, which will be zeroed before

use and
used to maintain state between this and following calls.

Once the event has been opened, which means space for it has been

Documentation/trace/events.rst +1 -1
@@ -805,7 +805,7 @@ lookup per field.
 
 To assign the values one after the other without lookups,
 synth_event_add_next_val() should be used.  Each call is passed the
-same synth_trace_state object used in the synth_event_trace_start(),
+same synth_event_trace_state object used in the
 synth_event_trace_start(),
 along with the value to set the next field in the event.  After each
 field is set, the 'cursor' points to the next field, which will be

set
by the subsequent call, continuing until all the fields have been
set

Documentation/trace/events.rst +0 -0
@@ -834,7 +834,7 @@ this method would be (without error-handling

code)::

        ret = synth_event_add_next_val(395, &trace_state);

To assign the values in any order, synth_event_add_val() should be

Documentation/trace/events.rst +1 -1
-used.  Each call is passed the same synth_trace_state object used in
+used.  Each call is passed the same synth_event_trace_state object

used in
the synth_event_trace_start(), along with the field name of the
field
to set and the value to set it to. The same sequence of calls as in the above examples using this method would be (without error-
handling

Documentation/trace/events.rst +1 -1
@@ -856,7 +856,7 @@ can be used but not both at the same time.
 
 Finally, the event won't be actually traced until it's 'closed',
 which is done using synth_event_trace_end(), which takes only the
-struct synth_trace_state object used in the previous calls::
+struct synth_event_trace_state object used in the previous calls::
 
        ret = synth_event_trace_end(&trace_state);
 
maintainer
#4 lore raw
Quoted 18 lines · On Mon, 7 Dec 2020 18:19:14 -0500 Steven Rostedt <[email protected]> wrote:
Quoted 15 lines · On Fri, 06 Nov 2020 14:47:46 -0600 Tom Zanussi <[email protected]> wrote:

Hi Artem,

Quoted 9 lines · Artem Bityutskiy

From: Artem Bityutskiy <[email protected]>

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

Thanks for fixing this!

Quoted 8 lines
Quoted 2 lines

Jon,

Can you take this patch?

This wasn't sent to me, of course, so I was about to go digging into the archive...until I realized I could just feed this email to b4 and everything just happens by magic. How did we ever get by before b4?

Anyway...applied :)

Thanks,

jon