All of lore.kernel.org
 help / color / mirror / Atom feed
* [trace:for-next 5/12] htmldocs: Documentation/trace/histogram-design.rst:219: (SEVERE/4) Unexpected section title.
@ 2020-06-02  7:03 ` kbuild test robot
  0 siblings, 0 replies; 2+ messages in thread
From: kbuild test robot @ 2020-06-02  7:03 UTC (permalink / raw)
  To: Tom, Zanussi,; +Cc: kbuild-all, Steven Rostedt (VMware), linux-doc

[-- Attachment #1: Type: text/plain, Size: 10081 bytes --]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux-trace.git for-next
head:   c200784a08d4ea82f82a30678955b7f2c7550af4
commit: 16b585fe71924b3aebaef5548a291021efaf7c7f [5/12] tracing: Add histogram-design document
reproduce: make htmldocs

If you fix the issue, kindly add following tag as appropriate
Reported-by: kbuild test robot <lkp@intel.com>

All errors (new ones prefixed by >>, old ones prefixed by <<):

reST markup error:
>> Documentation/trace/histogram-design.rst:219: (SEVERE/4) Unexpected section title.

vim +219 Documentation/trace/histogram-design.rst

   111	
   112	  +------------------+
   113	  | hist_data        |
   114	  +------------------+     +----------------+
   115	    | .fields[]      |---->| val = hitcount |----------------------------+
   116	    +----------------+     +----------------+                            |
   117	    | .map           |       | .size        |                            |
   118	    +----------------+       +--------------+                            |
   119	                             | .offset      |                            |
   120	                             +--------------+                            |
   121	                             | .fn()        |                            |
   122	                             +--------------+                            |
   123	                                   .                                     |
   124	                                   .                                     |
   125	                                   .                                     |
   126	                           +----------------+ <--- n_vals                |
   127	                           | key = pid      |----------------------------|--+
   128	                           +----------------+                            |  |
   129	                             | .size        |                            |  |
   130	                             +--------------+                            |  |
   131	                             | .offset      |                            |  |
   132	                             +--------------+                            |  |
   133	                             | .fn()        |                            |  |
   134	                           +----------------+ <--- n_fields              |  |
   135	                           | unused         |                            |  |
   136	                           +----------------+                            |  |
   137	                             |              |                            |  |
   138	                             +--------------+                            |  |
   139	                             |              |                            |  |
   140	                             +--------------+                            |  |
   141	                             |              |                            |  |
   142	                             +--------------+                            |  |
   143	                                            n_keys = n_fields - n_vals   |  |
   144			                                                         |  |
   145	The hist_data n_vals and n_fields delineate the extent of the fields[]   |  |
   146	array and separate keys from values for the rest of the code.            |  |
   147			                                                         |  |
   148	Below is a run-time representation of the tracing_map part of the        |  |
   149	histogram, with pointers from various parts of the fields[] array        |  |
   150	to corresponding parts of the tracing_map.                               |  |
   151			                                                         |  |
   152	The tracing_map consists of an array of tracing_map_entrys and a set     |  |
   153	of preallocated tracing_map_elts (abbreviated below as map_entry and     |  |
   154	map_elt).  The total number of map_entrys in the hist_data.map array =   |  |
   155	map->max_elts (actually map->map_size but only max_elts of those are     |  |
   156	used.  This is a property required by the map_insert() algorithm).       |  |
   157			                                                         |  |
   158	If a map_entry is unused, meaning no key has yet hashed into it, its     |  |
   159	.key value is 0 and its .val pointer is NULL.  Once a map_entry has      |  |
   160	been claimed, the .key value contains the key's hash value and the       |  |
   161	.val member points to a map_elt containing the full key and an entry     |  |
   162	for each key or value in the map_elt.fields[] array.  There is an        |  |
   163	entry in the map_elt.fields[] array corresponding to each hist_field     |  |
   164	in the histogram, and this is where the continually aggregated sums      |  |
   165	corresponding to each histogram value are kept.                          |  |
   166			                                                         |  |
   167	The diagram attempts to show the relationship between the                |  |
   168	hist_data.fields[] and the map_elt.fields[] with the links drawn         |  |
   169	between diagrams::                                                       |  |
   170			                                                         |  |
   171	  +-----------+		                                                 |  |
   172	  | hist_data |		                                                 |  |
   173	  +-----------+		                                                 |  |
   174	    | .fields |		                                                 |  |
   175	    +---------+     +-----------+		                         |  |
   176	    | .map    |---->| map_entry |		                         |  |
   177	    +---------+     +-----------+		                         |  |
   178	                      | .key    |---> 0		                         |  |
   179	                      +---------+		                         |  |
   180	                      | .val    |---> NULL		                 |  |
   181	                    +-----------+                                        |  |
   182	                    | map_entry |                                        |  |
   183	                    +-----------+                                        |  |
   184	                      | .key    |---> pid = 999                          |  |
   185	                      +---------+    +-----------+                       |  |
   186	                      | .val    |--->| map_elt   |                       |  |
   187	                      +---------+    +-----------+                       |  |
   188	                           .           | .key    |---> full key *        |  |
   189	                           .           +---------+    +---------------+  |  |
   190				   .           | .fields |--->| .sum (val)    |<-+  |
   191	                    +-----------+      +---------+    | 2345          |  |  |
   192	                    | map_entry |                     +---------------+  |  |
   193	                    +-----------+                     | .offset (key) |<----+
   194	                      | .key    |---> 0               | 0             |  |  |
   195	                      +---------+                     +---------------+  |  |
   196	                      | .val    |---> NULL                    .          |  |
   197	                    +-----------+                             .          |  |
   198	                    | map_entry |                             .          |  |
   199	                    +-----------+                     +---------------+  |  |
   200	                      | .key    |                     | .sum (val) or |  |  |
   201	                      +---------+    +---------+      | .offset (key) |  |  |
   202	                      | .val    |--->| map_elt |      +---------------+  |  |
   203	                    +-----------+    +---------+      | .sum (val) or |  |  |
   204	                    | map_entry |                     | .offset (key) |  |  |
   205	                    +-----------+                     +---------------+  |  |
   206	                      | .key    |---> pid = 4444                         |  |
   207	                      +---------+    +-----------+                       |  |
   208	                      | .val    |    | map_elt   |                       |  |
   209	                      +---------+    +-----------+                       |  |
   210	                                       | .key    |---> full key *        |  |
   211	                                       +---------+    +---------------+  |  |
   212				               | .fields |--->| .sum (val)    |<-+  |
   213	                                       +---------+    | 65523         |     |
   214	                                                      +---------------+     |
   215	                                                      | .offset (key) |<----+
   216	                                                      | 0             |
   217	                                                      +---------------+
   218	                                                              .
 > 219	                                                              .
   220	                                                              .
   221	                                                      +---------------+
   222	                                                      | .sum (val) or |
   223	                                                      | .offset (key) |
   224	                                                      +---------------+
   225	                                                      | .sum (val) or |
   226	                                                      | .offset (key) |
   227	                                                      +---------------+
   228	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org

[-- Attachment #2: .config.gz --]
[-- Type: application/gzip, Size: 7366 bytes --]

^ permalink raw reply	[flat|nested] 2+ messages in thread

* [trace:for-next 5/12] htmldocs: Documentation/trace/histogram-design.rst:219: (SEVERE/4) Unexpected section title.
@ 2020-06-02  7:03 ` kbuild test robot
  0 siblings, 0 replies; 2+ messages in thread
From: kbuild test robot @ 2020-06-02  7:03 UTC (permalink / raw)
  To: kbuild-all

[-- Attachment #1: Type: text/plain, Size: 10220 bytes --]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux-trace.git for-next
head:   c200784a08d4ea82f82a30678955b7f2c7550af4
commit: 16b585fe71924b3aebaef5548a291021efaf7c7f [5/12] tracing: Add histogram-design document
reproduce: make htmldocs

If you fix the issue, kindly add following tag as appropriate
Reported-by: kbuild test robot <lkp@intel.com>

All errors (new ones prefixed by >>, old ones prefixed by <<):

reST markup error:
>> Documentation/trace/histogram-design.rst:219: (SEVERE/4) Unexpected section title.

vim +219 Documentation/trace/histogram-design.rst

   111	
   112	  +------------------+
   113	  | hist_data        |
   114	  +------------------+     +----------------+
   115	    | .fields[]      |---->| val = hitcount |----------------------------+
   116	    +----------------+     +----------------+                            |
   117	    | .map           |       | .size        |                            |
   118	    +----------------+       +--------------+                            |
   119	                             | .offset      |                            |
   120	                             +--------------+                            |
   121	                             | .fn()        |                            |
   122	                             +--------------+                            |
   123	                                   .                                     |
   124	                                   .                                     |
   125	                                   .                                     |
   126	                           +----------------+ <--- n_vals                |
   127	                           | key = pid      |----------------------------|--+
   128	                           +----------------+                            |  |
   129	                             | .size        |                            |  |
   130	                             +--------------+                            |  |
   131	                             | .offset      |                            |  |
   132	                             +--------------+                            |  |
   133	                             | .fn()        |                            |  |
   134	                           +----------------+ <--- n_fields              |  |
   135	                           | unused         |                            |  |
   136	                           +----------------+                            |  |
   137	                             |              |                            |  |
   138	                             +--------------+                            |  |
   139	                             |              |                            |  |
   140	                             +--------------+                            |  |
   141	                             |              |                            |  |
   142	                             +--------------+                            |  |
   143	                                            n_keys = n_fields - n_vals   |  |
   144			                                                         |  |
   145	The hist_data n_vals and n_fields delineate the extent of the fields[]   |  |
   146	array and separate keys from values for the rest of the code.            |  |
   147			                                                         |  |
   148	Below is a run-time representation of the tracing_map part of the        |  |
   149	histogram, with pointers from various parts of the fields[] array        |  |
   150	to corresponding parts of the tracing_map.                               |  |
   151			                                                         |  |
   152	The tracing_map consists of an array of tracing_map_entrys and a set     |  |
   153	of preallocated tracing_map_elts (abbreviated below as map_entry and     |  |
   154	map_elt).  The total number of map_entrys in the hist_data.map array =   |  |
   155	map->max_elts (actually map->map_size but only max_elts of those are     |  |
   156	used.  This is a property required by the map_insert() algorithm).       |  |
   157			                                                         |  |
   158	If a map_entry is unused, meaning no key has yet hashed into it, its     |  |
   159	.key value is 0 and its .val pointer is NULL.  Once a map_entry has      |  |
   160	been claimed, the .key value contains the key's hash value and the       |  |
   161	.val member points to a map_elt containing the full key and an entry     |  |
   162	for each key or value in the map_elt.fields[] array.  There is an        |  |
   163	entry in the map_elt.fields[] array corresponding to each hist_field     |  |
   164	in the histogram, and this is where the continually aggregated sums      |  |
   165	corresponding to each histogram value are kept.                          |  |
   166			                                                         |  |
   167	The diagram attempts to show the relationship between the                |  |
   168	hist_data.fields[] and the map_elt.fields[] with the links drawn         |  |
   169	between diagrams::                                                       |  |
   170			                                                         |  |
   171	  +-----------+		                                                 |  |
   172	  | hist_data |		                                                 |  |
   173	  +-----------+		                                                 |  |
   174	    | .fields |		                                                 |  |
   175	    +---------+     +-----------+		                         |  |
   176	    | .map    |---->| map_entry |		                         |  |
   177	    +---------+     +-----------+		                         |  |
   178	                      | .key    |---> 0		                         |  |
   179	                      +---------+		                         |  |
   180	                      | .val    |---> NULL		                 |  |
   181	                    +-----------+                                        |  |
   182	                    | map_entry |                                        |  |
   183	                    +-----------+                                        |  |
   184	                      | .key    |---> pid = 999                          |  |
   185	                      +---------+    +-----------+                       |  |
   186	                      | .val    |--->| map_elt   |                       |  |
   187	                      +---------+    +-----------+                       |  |
   188	                           .           | .key    |---> full key *        |  |
   189	                           .           +---------+    +---------------+  |  |
   190				   .           | .fields |--->| .sum (val)    |<-+  |
   191	                    +-----------+      +---------+    | 2345          |  |  |
   192	                    | map_entry |                     +---------------+  |  |
   193	                    +-----------+                     | .offset (key) |<----+
   194	                      | .key    |---> 0               | 0             |  |  |
   195	                      +---------+                     +---------------+  |  |
   196	                      | .val    |---> NULL                    .          |  |
   197	                    +-----------+                             .          |  |
   198	                    | map_entry |                             .          |  |
   199	                    +-----------+                     +---------------+  |  |
   200	                      | .key    |                     | .sum (val) or |  |  |
   201	                      +---------+    +---------+      | .offset (key) |  |  |
   202	                      | .val    |--->| map_elt |      +---------------+  |  |
   203	                    +-----------+    +---------+      | .sum (val) or |  |  |
   204	                    | map_entry |                     | .offset (key) |  |  |
   205	                    +-----------+                     +---------------+  |  |
   206	                      | .key    |---> pid = 4444                         |  |
   207	                      +---------+    +-----------+                       |  |
   208	                      | .val    |    | map_elt   |                       |  |
   209	                      +---------+    +-----------+                       |  |
   210	                                       | .key    |---> full key *        |  |
   211	                                       +---------+    +---------------+  |  |
   212				               | .fields |--->| .sum (val)    |<-+  |
   213	                                       +---------+    | 65523         |     |
   214	                                                      +---------------+     |
   215	                                                      | .offset (key) |<----+
   216	                                                      | 0             |
   217	                                                      +---------------+
   218	                                                              .
 > 219	                                                              .
   220	                                                              .
   221	                                                      +---------------+
   222	                                                      | .sum (val) or |
   223	                                                      | .offset (key) |
   224	                                                      +---------------+
   225	                                                      | .sum (val) or |
   226	                                                      | .offset (key) |
   227	                                                      +---------------+
   228	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org

[-- Attachment #2: config.gz --]
[-- Type: application/gzip, Size: 7366 bytes --]

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2020-06-02  7:04 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-06-02  7:03 [trace:for-next 5/12] htmldocs: Documentation/trace/histogram-design.rst:219: (SEVERE/4) Unexpected section title kbuild test robot
2020-06-02  7:03 ` kbuild test robot

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.