Merge "tp: clarfiy documentation around thread_state and sched_slice"
diff --git a/src/trace_processor/tables/metadata_tables.py b/src/trace_processor/tables/metadata_tables.py
index 0219aa9..5d800d7 100644
--- a/src/trace_processor/tables/metadata_tables.py
+++ b/src/trace_processor/tables/metadata_tables.py
@@ -177,7 +177,7 @@
table only exists for debugging purposes and should not be relied on
in production usecases (i.e. metrics, standard library etc).
''',
- group='Misc',
+ group='Events',
columns={
'arg_set_id':
ColumnDoc(
@@ -204,12 +204,12 @@
columns=[],
tabledoc=TableDoc(
doc='''
- Contains all the ftrace events in the trace. This table exists only for
- debugging purposes and should not be relied on in production usecases
- (i.e. metrics, standard library etc). Note also that this table might
- be empty if raw ftrace parsing has been disabled.
- ''',
- group='Misc',
+ Contains all the ftrace events in the trace. This table exists only
+ for debugging purposes and should not be relied on in production
+ usecases (i.e. metrics, standard library etc). Note also that this
+ table might be empty if raw ftrace parsing has been disabled.
+ ''',
+ group='Events',
columns={}))
ARG_TABLE = Table(
diff --git a/src/trace_processor/tables/slice_tables.py b/src/trace_processor/tables/slice_tables.py
index 2f4e6fb..8d85411 100644
--- a/src/trace_processor/tables/slice_tables.py
+++ b/src/trace_processor/tables/slice_tables.py
@@ -137,6 +137,9 @@
This table holds slices with kernel thread scheduling information.
These slices are collected when the Linux "ftrace" data source is
used with the "sched/switch" and "sched/wakeup*" events enabled.
+
+ The rows in this table will always have a matching row in the
+ |thread_state| table with |thread_state.state| = 'Running'
''',
group='Events',
columns={
@@ -180,9 +183,10 @@
tabledoc=TableDoc(
doc='''
This table contains the scheduling state of every thread on the
- system during the trace. It is a subset of the |sched_slice| (sched)
- table which only contains the times where threads were actually
- scheduled.
+ system during the trace.
+
+ The rows in this table which have |state| = 'Running', will have a
+ corresponding row in the |sched_slice| table.
''',
group='Events',
columns={
@@ -342,7 +346,7 @@
An experimental table which "flattens" stacks of slices to contain
only the "deepest" slice at any point in time on each track.
''',
- group='Misc',
+ group='Events',
columns={
'ts':
'''The timestamp at the start of the slice (in nanoseconds).''',
