-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathdocu.html
279 lines (257 loc) · 15.6 KB
/
docu.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>GEOPM Documentation Guidelines — GEOPM documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Publications" href="publications.html" />
<link rel="prev" title="Developer Guide" href="devel.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
GEOPM
<img src="https://geopm.github.io/images/geopm-logo-clear.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guides.html">User Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">Contributor Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="devel.html">Developer Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="devel.html#developer-build-process">Developer Build Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="devel.html#configuring-the-build">Configuring the Build</a></li>
<li class="toctree-l2"><a class="reference internal" href="devel.html#coverage-instructions">Coverage Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="devel.html#coding-style">Coding Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="devel.html#pre-commit-checks">Pre-Commit Checks</a></li>
<li class="toctree-l2"><a class="reference internal" href="devel.html#license-headers">License Headers</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="devel.html#creating-manuals">Creating Manuals</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">GEOPM Documentation Guidelines</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#whitespace">Whitespace</a></li>
<li class="toctree-l4"><a class="reference internal" href="#columns-in-a-line">Columns in a Line</a></li>
<li class="toctree-l4"><a class="reference internal" href="#sections">Sections</a></li>
<li class="toctree-l4"><a class="reference internal" href="#section-ordering">Section Ordering</a></li>
<li class="toctree-l4"><a class="reference internal" href="#signals-controls-low-level">Signals/Controls (low level)</a></li>
<li class="toctree-l4"><a class="reference internal" href="#aliases">Aliases</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">GEOPM</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="devel.html">Developer Guide</a></li>
<li class="breadcrumb-item active">GEOPM Documentation Guidelines</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/docu.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="geopm-documentation-guidelines">
<h1>GEOPM Documentation Guidelines<a class="headerlink" href="#geopm-documentation-guidelines" title="Link to this heading"></a></h1>
<p>This guide outlines the style specifications for writing or amending
reStructuredText (rst) source files for the GEOPM project. Please refer to the
<a class="reference internal" href="devel.html#creating-manuals"><span class="std std-ref">Creating Manuals</span></a> section in the <a class="reference internal" href="devel.html"><span class="doc">Guide for GEOPM Developers</span></a> for detailed instructions on properly adding new files to the build.</p>
<p>Certain rules such as <a class="reference internal" href="#section-ordering"><span class="std std-ref">section ordering</span></a> and the
property list mentioned in <a class="reference internal" href="#signals-controls-low-level"><span class="std std-ref">low-level signals/controls</span></a>, can be verified using the <code class="docutils literal notranslate"><span class="pre">geopmlint</span></code>
Sphinx builder. Execute <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs_geopmlint</span></code> command to perform these checks.
If it’s necessary to alter these checks, modify
<code class="docutils literal notranslate"><span class="pre">service/docs/source/_ext/geopmlint.py</span></code>.</p>
<section id="whitespace">
<h2>Whitespace<a class="headerlink" href="#whitespace" title="Link to this heading"></a></h2>
<p>Strive to minimize the usage of whitespace (carriage returns, spaces, and
indentation) in the source file. Use only the necessary amount of whitespace
as required for readability or by the reStructuredText compiler for your goal.</p>
</section>
<section id="columns-in-a-line">
<h2>Columns in a Line<a class="headerlink" href="#columns-in-a-line" title="Link to this heading"></a></h2>
<p>The number of columns in a source file should not exceed 70 or 80 before
wrapping the line. Exceptions are allowed when it is required for compilation
or similar. In general, follow the style in the file you are modifying.</p>
</section>
<section id="sections">
<h2>Sections<a class="headerlink" href="#sections" title="Link to this heading"></a></h2>
<p>Adhere to the <cite>Sphinx Documentation for Sections
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections></cite>,
explicitly:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">=</span></code> for page titles</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-</span></code> for sections within a page</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">^</span></code> for subsections</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"</span></code> for sub-subsections</p></li>
</ul>
</div></blockquote>
</section>
<section id="section-ordering">
<h2>Section Ordering<a class="headerlink" href="#section-ordering" title="Link to this heading"></a></h2>
<p>For Chapter 7 man pages related to IOGroups, follow the following sequence:</p>
<ol class="arabic simple">
<li><p>Description</p></li>
<li><p>Requirements</p></li>
<li><p>Signals</p></li>
<li><p>Controls</p></li>
<li><p>Aliases</p>
<ol class="loweralpha simple">
<li><p>Signal Aliases</p></li>
<li><p>Control Aliases</p></li>
</ol>
</li>
<li><p>See Also</p></li>
</ol>
</section>
<section id="signals-controls-low-level">
<h2>Signals/Controls (low level)<a class="headerlink" href="#signals-controls-low-level" title="Link to this heading"></a></h2>
<p>Use the following code as an illustration:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="s">``PROFILE::TIME_HINT_UNKNOWN``</span>
The aggregate time that a CPU was monitored while working with this
specific hint value on the designated Linux logical CPU.
<span class="m">*</span> <span class="gs">**Aggregation**</span>: average
<span class="m">*</span> <span class="gs">**Domain**</span>: cpu
<span class="m">*</span> <span class="gs">**Format**</span>: double
<span class="m">*</span> <span class="gs">**Unit**</span>: seconds
</pre></div>
</div>
<p>This will appear as:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">PROFILE::TIME_HINT_UNKNOWN</span></code></dt><dd><p>The aggregate time that a CPU was monitored while working with this
specific hint value on the designated Linux logical CPU.</p>
<ul class="simple">
<li><p><strong>Aggregation</strong>: average</p></li>
<li><p><strong>Domain</strong>: cpu</p></li>
<li><p><strong>Format</strong>: double</p></li>
<li><p><strong>Unit</strong>: seconds</p></li>
</ul>
</dd>
</dl>
<section id="msr-signals-and-controls">
<h3>MSR Signals and controls<a class="headerlink" href="#msr-signals-and-controls" title="Link to this heading"></a></h3>
<p>MSRs should be documented in their related <code class="docutils literal notranslate"><span class="pre">msr_data_*.json</span></code> file. Apply the
<code class="docutils literal notranslate"><span class="pre">geopm-msr-json</span></code> directive to extract the formatted documentation from a JSON
definition into a <code class="docutils literal notranslate"><span class="pre">rst</span></code> file. See the examples below:</p>
<div class="literal-block-wrapper docutils container" id="id1">
<div class="code-block-caption"><span class="caption-text">All MSRs in a json file</span><a class="headerlink" href="#id1" title="Link to this code"></a></div>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">geopm-msr-json</span><span class="p">::</span> ../json_data/msr_data_arch.json
</pre></div>
</div>
</div>
<div class="literal-block-wrapper docutils container" id="id2">
<div class="code-block-caption"><span class="caption-text">Only signals from a json file</span><a class="headerlink" href="#id2" title="Link to this code"></a></div>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">geopm-msr-json</span><span class="p">::</span> ../json_data/msr_data_arch.json
<span class="nc">:no-controls:</span>
</pre></div>
</div>
</div>
<div class="literal-block-wrapper docutils container" id="id3">
<div class="code-block-caption"><span class="caption-text">Only controls from a json file</span><a class="headerlink" href="#id3" title="Link to this code"></a></div>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">geopm-msr-json</span><span class="p">::</span> ../json_data/msr_data_arch.json
<span class="nc">:no-signals:</span>
</pre></div>
</div>
</div>
<p>To change the output format of the <code class="docutils literal notranslate"><span class="pre">geopm-msr-json</span></code> directive,
revise the <code class="docutils literal notranslate"><span class="pre">GeopmMsrJson</span></code> class in the
<code class="docutils literal notranslate"><span class="pre">service/docs/source/_ext/geopm_rst_extensions.py</span></code> Sphinx extension.</p>
</section>
</section>
<section id="aliases">
<h2>Aliases<a class="headerlink" href="#aliases" title="Link to this heading"></a></h2>
<p>The Chapter 7 pages particular to an IOGroup should describe how the high-level
alias corresponds to the signals or controls provided by that IOGroup.
This is an example of a direct 1-to-1 mapping:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="s">``CPU_FREQUENCY_MAX_AVAIL``</span>
Corresponds to <span class="s">``MSR::TURBO_RATIO_LIMIT:MAX_RATIO_LIMIT_0``</span>
</pre></div>
</div>
<p>It will display as:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_MAX_AVAIL</span></code></dt><dd><p>Corresponds to <code class="docutils literal notranslate"><span class="pre">MSR::TURBO_RATIO_LIMIT:MAX_RATIO_LIMIT_0</span></code></p>
</dd>
</dl>
<p>If the alias does not have a straightforward mapping, then an expanded
explanation of how the alias is implemented should be provided in the IOGroup
specific page.</p>
<p>The <a class="reference internal" href="geopm_pio.7.html"><span class="doc">geopm_pio(7)</span></a> page should explain the high-level alias
in full sentence descriptions. Here’s an example:</p>
<div class="highlight-rst notranslate"><div class="highlight"><pre><span></span><span class="s">``CPU_FREQUENCY_MAX_AVAIL``</span>
Maximum available processor frequency.
</pre></div>
</div>
<p>It will render as:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">CPU_FREQUENCY_MAX_AVAIL</span></code></dt><dd><p>Maximum available processor frequency.</p>
</dd>
</dl>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<p>For style reference, consult the following pages:</p>
<p><a class="reference internal" href="geopm_pio_profile.7.html"><span class="doc">geopm_pio_profile(7)</span></a>,
<a class="reference internal" href="geopm_pio.3.html"><span class="doc">geopm_pio(3)</span></a>,
<a class="reference internal" href="geopm_pio_cnl.7.html"><span class="doc">geopm_pio_cnl(7)</span></a></p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="devel.html" class="btn btn-neutral float-left" title="Developer Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="publications.html" class="btn btn-neutral float-right" title="Publications" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015 - 2024 Intel Corporation. All rights reserved..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>