2 # Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
9 # * Redistributions of source code must retain the above copyright
10 # notice, this list of conditions and the following disclaimer.
11 # * Redistributions in binary form must reproduce the above copyright
12 # notice, this list of conditions and the following disclaimer in
13 # the documentation and/or other materials provided with the
15 # * Neither the name of Intel Corporation nor the names of its
16 # contributors may be used to endorse or promote products derived
17 # from this software without specific prior written permission.
19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 from __future__ import print_function
33 from docutils import nodes
34 from distutils.version import LooseVersion
35 from sphinx import __version__ as sphinx_version
36 from sphinx.highlighting import PygmentsBridge
37 from pygments.formatters.latex import LatexFormatter
38 from os import listdir
39 from os.path import basename
40 from os.path import dirname
41 from os.path import join as path_join
45 import ConfigParser as configparser
51 project = 'Data Plane Development Kit'
53 if LooseVersion(sphinx_version) >= LooseVersion('1.3.1'):
54 html_theme = "sphinx_rtd_theme"
55 html_logo = '../logo/DPDK_logo_vertical_rev_small.png'
56 latex_logo = '../logo/DPDK_logo_horizontal_tag.png'
57 html_add_permalinks = ""
58 html_show_copyright = False
59 highlight_language = 'none'
61 version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion'])
62 version = version.decode('utf-8').rstrip()
67 # Figures, tables and code-blocks automatically numbered if they have caption
78 # Latex directives to be included directly in the latex/pdf docs.
80 \usepackage[utf8]{inputenc}
81 \usepackage[T1]{fontenc}
83 \renewcommand{\familydefault}{\sfdefault}
84 \RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}
87 # Configuration for the latex/pdf docs.
89 'papersize': 'a4paper',
92 'classoptions': ',openany,oneside',
93 'babel': '\\usepackage[english]{babel}',
94 # customize Latex formatting
95 'preamble': latex_preamble
99 # Override the default Latex formatter in order to modify the
100 # code/verbatim blocks.
101 class CustomLatexFormatter(LatexFormatter):
102 def __init__(self, **options):
103 super(CustomLatexFormatter, self).__init__(**options)
104 # Use the second smallest font size for code/verbatim blocks.
105 self.verboptions = r'formatcom=\footnotesize'
107 # Replace the default latex formatter.
108 PygmentsBridge.latex_formatter = CustomLatexFormatter
110 # Configuration for man pages
111 man_pages = [("testpmd_app_ug/run_app", "testpmd",
112 "tests for dpdk pmds", "", 1),
113 ("tools/pdump", "dpdk-pdump",
114 "enable packet capture on dpdk ports", "", 1),
115 ("tools/proc_info", "dpdk-procinfo",
116 "access dpdk port stats and memory info", "", 1),
117 ("tools/pmdinfo", "dpdk-pmdinfo",
118 "dump a PMDs hardware support info", "", 1),
119 ("tools/devbind", "dpdk-devbind",
120 "check device status and bind/unbind them from drivers", "", 8)]
123 # ####### :numref: fallback ########
124 # The following hook functions add some simple handling for the :numref:
125 # directive for Sphinx versions prior to 1.3.1. The functions replace the
126 # :numref: reference with a link to the target (for all Sphinx doc types).
127 # It doesn't try to label figures/tables.
128 def numref_role(reftype, rawtext, text, lineno, inliner):
130 Add a Sphinx role to handle numref references. Note, we can't convert
131 the link here because the doctree isn't build and the target information
134 # Add an identifier to distinguish numref from other references.
135 newnode = nodes.reference('',
137 refuri='_local_numref_#%s' % text,
142 def process_numref(app, doctree, from_docname):
144 Process the numref nodes once the doctree has been built and prior to
145 writing the files. The processing involves replacing the numref with a
146 link plus text to indicate if it is a Figure or Table link.
149 # Iterate over the reference nodes in the doctree.
150 for node in doctree.traverse(nodes.reference):
151 target = node.get('refuri', '')
153 # Look for numref nodes.
154 if target.startswith('_local_numref_#'):
155 target = target.replace('_local_numref_#', '')
157 # Get the target label and link information from the Sphinx env.
158 data = app.builder.env.domains['std'].data
159 docname, label, _ = data['labels'].get(target, ('', '', ''))
160 relative_url = app.builder.get_relative_uri(from_docname, docname)
162 # Add a text label to the link.
163 if target.startswith('figure'):
165 elif target.startswith('table'):
170 # New reference node with the updated link information.
171 newnode = nodes.reference('',
173 refuri='%s#%s' % (relative_url, label),
175 node.replace_self(newnode)
178 def generate_nic_overview_table(output_filename):
180 Function to generate the NIC Overview Table from the ini files that define
181 the features for each NIC.
183 The default features for the table and their order is defined by the
187 # Default worning string.
188 warning = 'Warning generate_nic_overview_table()'
190 # Get the default features and order from the 'default.ini' file.
191 ini_path = path_join(dirname(output_filename), 'features')
192 config = configparser.ConfigParser()
193 config.optionxform = str
194 config.read(path_join(ini_path, 'default.ini'))
195 default_section = 'Features'
196 default_features = config.items(default_section)
198 # Create a dict of the valid features to validate the other ini files.
200 max_feature_length = 0
201 for feature in default_features:
203 valid_features[key] = ' '
204 max_feature_length = max(max_feature_length, len(key))
206 # Get a list of NIC ini files, excluding 'default.ini'.
207 ini_files = [basename(file) for file in listdir(ini_path)
208 if file.endswith('.ini') and file != 'default.ini']
211 # Build up a list of the table header names from the ini filenames.
213 for ini_filename in ini_files:
214 name = ini_filename[:-4]
215 name = name.replace('_vf', 'vf')
217 # Pad the table header names to match the existing format.
219 pmd, vec = name.split('_')
220 name = '{0:{fill}{align}7}vec'.format(pmd, fill='.', align='<')
222 name = '{0:{fill}{align}10}'.format(name, fill=' ', align='<')
224 header_names.append(name)
226 # Create a dict of the defined features for each NIC from the ini files.
228 for ini_filename in ini_files:
229 config = configparser.ConfigParser()
230 config.optionxform = str
231 config.read(path_join(ini_path, ini_filename))
233 # Initialize the dict with the default.ini value.
234 ini_data[ini_filename] = valid_features.copy()
236 # Check for a valid ini section.
237 if not config.has_section(default_section):
238 print("{}: File '{}' has no [{}] secton".format(warning,
243 # Check for valid features names.
244 for name, value in config.items(default_section):
245 if name not in valid_features:
246 print("{}: Unknown feature '{}' in '{}'".format(warning,
252 # Get the first letter only.
253 ini_data[ini_filename][name] = value[0]
255 # Print out the RST NIC Overview table from the ini file data.
256 outfile = open(output_filename, 'w')
257 num_cols = len(header_names)
259 print('.. table:: Features availability in networking drivers\n',
262 print_table_header(outfile, num_cols, header_names)
263 print_table_body(outfile, num_cols, ini_files, ini_data, default_features)
266 def print_table_header(outfile, num_cols, header_names):
267 """ Print the RST table header. The header names are vertical. """
268 print_table_divider(outfile, num_cols)
271 for name in header_names:
272 line += ' ' + name[0]
274 print_table_row(outfile, 'Feature', line)
276 for i in range(1, 10):
278 for name in header_names:
279 line += ' ' + name[i]
281 print_table_row(outfile, '', line)
283 print_table_divider(outfile, num_cols)
286 def print_table_body(outfile, num_cols, ini_files, ini_data, default_features):
287 """ Print out the body of the table. Each row is a NIC feature. """
289 for feature, _ in default_features:
292 for ini_filename in ini_files:
293 line += ' ' + ini_data[ini_filename][feature]
295 print_table_row(outfile, feature, line)
297 print_table_divider(outfile, num_cols)
300 def print_table_row(outfile, feature, line):
301 """ Print a single row of the table with fixed formatting. """
303 print(' {:<20}{}'.format(feature, line), file=outfile)
306 def print_table_divider(outfile, num_cols):
307 """ Print the table divider line. """
309 column_dividers = ['='] * num_cols
310 line += ' '.join(column_dividers)
314 print_table_row(outfile, feature, line)
318 table_file = dirname(__file__) + '/nics/overview_table.txt'
319 generate_nic_overview_table(table_file)
321 if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):
322 print('Upgrade sphinx to version >= 1.3.1 for '
323 'improved Figure/Table number handling.')
324 # Add a role to handle :numref: references.
325 app.add_role('numref', numref_role)
326 # Process the numref references once the doctree has been created.
327 app.connect('doctree-resolved', process_numref)