From: kbuild test robot <lkp@intel.com>
To: Tom Zanussi <zanussi@kernel.org>
Cc: kbuild-all@lists.01.org, linux-doc@vger.kernel.org
Subject: [zanussi-trace:ftrace/separate-synth-v2 2/5] htmldocs: Documentation/trace/histogram-design.rst:219: (SEVERE/4) Unexpected section title.
Date: Fri, 29 May 2020 11:31:12 +0800 [thread overview]
Message-ID: <202005291111.dyJMyjDF%lkp@intel.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 10096 bytes --]
tree: https://git.kernel.org/pub/scm/linux/kernel/git/zanussi/linux-trace.git ftrace/separate-synth-v2
head: af36c539006ef2768114b4ed38e6b054f7c7a3bd
commit: 256b29c3274bb89a10157c4a8d1a8bce7e74849e [2/5] 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: 7365 bytes --]
reply other threads:[~2020-05-29 3:31 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=202005291111.dyJMyjDF%lkp@intel.com \
--to=lkp@intel.com \
--cc=kbuild-all@lists.01.org \
--cc=linux-doc@vger.kernel.org \
--cc=zanussi@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).