diff mbox series

trace2: correct trace2 field name documentation

Message ID 3f950d9fd772897edc02e9258267759d4244c1f8.1562713651.git.steadmon@google.com (mailing list archive)
State New, archived
Headers show
Series trace2: correct trace2 field name documentation | expand

Commit Message

Josh Steadmon July 9, 2019, 11:09 p.m. UTC
Correct the api-trace2 documentation, which lists "signal" as an
expected field for the signal event type, but which actually outputs
"signo" as the field name.

Signed-off-by: Josh Steadmon <steadmon@google.com>
---
This patch has been split off from the "Add a JSON Schema for trace2
events" series. The documentation discrepancy was discovered in the
process of testing the schema validation in that series.

 Documentation/technical/api-trace2.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt
index 23c3cc7a37..fd1e628944 100644
--- a/Documentation/technical/api-trace2.txt
+++ b/Documentation/technical/api-trace2.txt
@@ -668,7 +668,7 @@  completed.)
 	"event":"signal",
 	...
 	"t_abs":0.001227,  # elapsed time in seconds
-	"signal":13        # SIGTERM, SIGINT, etc.
+	"signo":13         # SIGTERM, SIGINT, etc.
 }
 ------------