sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget$/translations/zh_CN/doc-guide/sphinxmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/zh_TW/doc-guide/sphinxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/it_IT/doc-guide/sphinxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/ja_JP/doc-guide/sphinxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/ko_KR/doc-guide/sphinxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/pt_BR/doc-guide/sphinxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget$/translations/sp_SP/doc-guide/sphinxmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhtarget)}(h.. _sphinxdoc:h]h}(h]h ]h"]h$]h&]refid sphinxdocuh1hhKhhhhh>/var/lib/git/docbuild/linux/Documentation/doc-guide/sphinx.rstubhsection)}(hhh](htitle)}(h%Using Sphinx for kernel documentationh]h%Using Sphinx for kernel documentation}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hXThe Linux kernel uses `Sphinx`_ to generate pretty documentation from `reStructuredText`_ files under ``Documentation``. To build the documentation in HTML or PDF formats, use ``make htmldocs`` or ``make pdfdocs``. The generated documentation is placed in ``Documentation/output``.h](hThe Linux kernel uses }(hhhhhNhNubh reference)}(h `Sphinx`_h]hSphinx}(hhhhhNhNubah}(h]h ]h"]h$]h&]nameSphinxrefurihttp://www.sphinx-doc.org/uh1hhhیresolvedKubh' to generate pretty documentation from }(hhhhhNhNubh)}(h`reStructuredText`_h]hreStructuredText}(hhhhhNhNubah}(h]h ]h"]h$]h&]namereStructuredTexth(http://docutils.sourceforge.net/rst.htmluh1hhhhKubh files under }(hhhhhNhNubhliteral)}(h``Documentation``h]h Documentation}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhubh9. To build the documentation in HTML or PDF formats, use }(hhhhhNhNubj)}(h``make htmldocs``h]h make htmldocs}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhubh or }(hhhhhNhNubj)}(h``make pdfdocs``h]h make pdfdocs}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhubh+. The generated documentation is placed in }(hhhhhNhNubj)}(h``Documentation/output``h]hDocumentation/output}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhubh.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(h&.. _Sphinx: http://www.sphinx-doc.org/h]h}(h]sphinxah ]h"]sphinxah$]h&]hhuh1hhK hhhhhhÌ referencedKubh)}(h>.. _reStructuredText: http://docutils.sourceforge.net/rst.htmlh]h}(h]restructuredtextah ]h"]restructuredtextah$]h&]hj uh1hhK hhhhhhjmKubh)}(hX\The reStructuredText files may contain directives to include structured documentation comments, or kernel-doc comments, from source files. Usually these are used to describe the functions and types and design of the code. The kernel-doc comments have some special structure and formatting, but beyond that they are also treated as reStructuredText.h]hX\The reStructuredText files may contain directives to include structured documentation comments, or kernel-doc comments, from source files. Usually these are used to describe the functions and types and design of the code. The kernel-doc comments have some special structure and formatting, but beyond that they are also treated as reStructuredText.}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hFinally, there are thousands of plain text documentation files scattered around ``Documentation``. Some of these will likely be converted to reStructuredText over time, but the bulk of them will remain in plain text.h](hPFinally, there are thousands of plain text documentation files scattered around }(hjhhhNhNubj)}(h``Documentation``h]h Documentation}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhw. Some of these will likely be converted to reStructuredText over time, but the bulk of them will remain in plain text.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(h.. _sphinx_install:h]h}(h]h ]h"]h$]h&]hsphinx-installuh1hhKhhhhhhubh)}(hhh](h)}(hSphinx Installh]hSphinx Install}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hzThe ReST markups currently used by the Documentation/ files are meant to be built with ``Sphinx`` version 3.4.3 or higher.h](hWThe ReST markups currently used by the Documentation/ files are meant to be built with }(hjhhhNhNubj)}(h ``Sphinx``h]hSphinx}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh version 3.4.3 or higher.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hsThere's a script that checks for the Sphinx requirements. Please see :ref:`sphinx-pre-install` for further details.h](hGThere’s a script that checks for the Sphinx requirements. Please see }(hjhhhNhNubh)}(h:ref:`sphinx-pre-install`h]hinline)}(hjh]hsphinx-pre-install}(hjhhhNhNubah}(h]h ](xrefstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocdoc-guide/sphinx refdomainjreftyperef refexplicitrefwarn reftargetsphinx-pre-installuh1hhhhK!hjubh for further details.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK!hjhhubh)}(hMost distributions are shipped with Sphinx, but its toolchain is fragile, and it is not uncommon that upgrading it or some other Python packages on your machine would cause the documentation build to break.h]hMost distributions are shipped with Sphinx, but its toolchain is fragile, and it is not uncommon that upgrading it or some other Python packages on your machine would cause the documentation build to break.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK$hjhhubh)}(hXA way to avoid that is to use a different version than the one shipped with your distributions. In order to do so, it is recommended to install Sphinx inside a virtual environment, using ``virtualenv-3`` or ``virtualenv``, depending on how your distribution packaged Python 3.h](hA way to avoid that is to use a different version than the one shipped with your distributions. In order to do so, it is recommended to install Sphinx inside a virtual environment, using }(hj)hhhNhNubj)}(h``virtualenv-3``h]h virtualenv-3}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubh or }(hj)hhhNhNubj)}(h``virtualenv``h]h virtualenv}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubh7, depending on how your distribution packaged Python 3.}(hj)hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK(hjhhubh)}(hPIn summary, if you want to install the latest version of Sphinx, you should do::h]hOIn summary, if you want to install the latest version of Sphinx, you should do:}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK-hjhhubh literal_block)}(h$ virtualenv sphinx_latest $ . sphinx_latest/bin/activate (sphinx_latest) $ pip install -r Documentation/sphinx/requirements.txth]h$ virtualenv sphinx_latest $ . sphinx_latest/bin/activate (sphinx_latest) $ pip install -r Documentation/sphinx/requirements.txt}hjksbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jihhhK0hjhhubh)}(hXAfter running ``. sphinx_latest/bin/activate``, the prompt will change, in order to indicate that you're using the new environment. If you open a new shell, you need to rerun this command to enter again at the virtual environment before building the documentation.h](hAfter running }(hj{hhhNhNubj)}(h ``. sphinx_latest/bin/activate``h]h. sphinx_latest/bin/activate}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{ubh, the prompt will change, in order to indicate that you’re using the new environment. If you open a new shell, you need to rerun this command to enter again at the virtual environment before building the documentation.}(hj{hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK4hjhhubh)}(hhh](h)}(h Image outputh]h Image output}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK:ubh)}(hThe kernel documentation build system contains an extension that handles images in both GraphViz and SVG formats (see :ref:`sphinx_kfigure`).h](hvThe kernel documentation build system contains an extension that handles images in both GraphViz and SVG formats (see }(hjhhhNhNubh)}(h:ref:`sphinx_kfigure`h]j)}(hjh]hsphinx_kfigure}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj  refdomainjreftyperef refexplicitrefwarnjsphinx_kfigureuh1hhhhKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]!installing-sphinx-minimal-versionah ]h"]!installing sphinx minimal versionah$]h&]uh1hhjhhhhhKubeh}(h](jid1eh ]h"](sphinx installsphinx_installeh$]h&]uh1hhhhhhhhKj}jZjsj}jjsubh)}(hhh](h)}(h Sphinx Buildh]h Sphinx Build}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_hhhhhKubh)}(hXThe usual way to generate the documentation is to run ``make htmldocs`` or ``make pdfdocs``. There are also other formats available: see the documentation section of ``make help``. The generated documentation is placed in format-specific subdirectories under ``Documentation/output``.h](h6The usual way to generate the documentation is to run }(hjphhhNhNubj)}(h``make htmldocs``h]h make htmldocs}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubh or }(hjphhhNhNubj)}(h``make pdfdocs``h]h make pdfdocs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubhK. There are also other formats available: see the documentation section of }(hjphhhNhNubj)}(h ``make help``h]h make help}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubhP. The generated documentation is placed in format-specific subdirectories under }(hjphhhNhNubj)}(h``Documentation/output``h]hDocumentation/output}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubh.}(hjphhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj_hhubh)}(hX To generate documentation, Sphinx (``sphinx-build``) must obviously be installed. For PDF output you'll also need ``XeLaTeX`` and ``convert(1)`` from ImageMagick (https://www.imagemagick.org).\ [#ink]_ All of these are widely available and packaged in distributions.h](h#To generate documentation, Sphinx (}(hjhhhNhNubj)}(h``sphinx-build``h]h sphinx-build}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhB) must obviously be installed. For PDF output you’ll also need }(hjhhhNhNubj)}(h ``XeLaTeX``h]hXeLaTeX}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h``convert(1)``h]h convert(1)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh from ImageMagick (}(hjhhhNhNubh)}(hhttps://www.imagemagick.orgh]hhttps://www.imagemagick.org}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1hhjubh). }(hjhhhNhNubhfootnote_reference)}(h[#ink]_h]h1}(hjhhhNhNubah}(h]id2ah ]h"]h$]h&]autoKhinkdocnamej uh1jhjhKubhA All of these are widely available and packaged in distributions.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj_hhubh)}(hTo pass extra options to Sphinx, you can use the ``SPHINXOPTS`` make variable. For example, use ``make SPHINXOPTS=-v htmldocs`` to get more verbose output.h](h1To pass extra options to Sphinx, you can use the }(hj5hhhNhNubj)}(h``SPHINXOPTS``h]h SPHINXOPTS}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubh! make variable. For example, use }(hj5hhhNhNubj)}(h``make SPHINXOPTS=-v htmldocs``h]hmake SPHINXOPTS=-v htmldocs}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubh to get more verbose output.}(hj5hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj_hhubh)}(hIt is also possible to pass an extra DOCS_CSS overlay file, in order to customize the html layout, by using the ``DOCS_CSS`` make variable.h](hpIt is also possible to pass an extra DOCS_CSS overlay file, in order to customize the html layout, by using the }(hjghhhNhNubj)}(h ``DOCS_CSS``h]hDOCS_CSS}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubh make variable.}(hjghhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj_hhubh)}(hBy default, the "Alabaster" theme is used to build the HTML documentation; this theme is bundled with Sphinx and need not be installed separately. The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable.h](hBy default, the “Alabaster” theme is used to build the HTML documentation; this theme is bundled with Sphinx and need not be installed separately. The Sphinx theme can be overridden by using the }(hjhhhNhNubj)}(h``DOCS_THEME``h]h DOCS_THEME}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh make variable.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj_hhubhnote)}(hSome people might prefer to use the RTD theme for html output. Depending on the Sphinx version, it should be installed separately, with ``pip install sphinx_rtd_theme``.h]h)}(hSome people might prefer to use the RTD theme for html output. Depending on the Sphinx version, it should be installed separately, with ``pip install sphinx_rtd_theme``.h](hSome people might prefer to use the RTD theme for html output. Depending on the Sphinx version, it should be installed separately, with }(hjhhhNhNubj)}(h ``pip install sphinx_rtd_theme``h]hpip install sphinx_rtd_theme}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhj_hhhhhNubh)}(hXLThere is another make variable ``SPHINXDIRS``, which is useful when test building a subset of documentation. For example, you can build documents under ``Documentation/doc-guide`` by running ``make SPHINXDIRS=doc-guide htmldocs``. The documentation section of ``make help`` will show you the list of subdirectories you can specify.h](hThere is another make variable }(hjhhhNhNubj)}(h``SPHINXDIRS``h]h SPHINXDIRS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhl, which is useful when test building a subset of documentation. For example, you can build documents under }(hjhhhNhNubj)}(h``Documentation/doc-guide``h]hDocumentation/doc-guide}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh by running }(hjhhhNhNubj)}(h&``make SPHINXDIRS=doc-guide htmldocs``h]h"make SPHINXDIRS=doc-guide htmldocs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. The documentation section of }(hjhhhNhNubj)}(h ``make help``h]h make help}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh: will show you the list of subdirectories you can specify.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj_hhubh)}(h>To remove the generated documentation, run ``make cleandocs``.h](h+To remove the generated documentation, run }(hj)hhhNhNubj)}(h``make cleandocs``h]hmake cleandocs}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubh.}(hj)hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj_hhubhfootnote)}(hHaving ``inkscape(1)`` from Inkscape (https://inkscape.org) as well would improve the quality of images embedded in PDF documents, especially for kernel releases 5.18 and later. h](hlabel)}(hhh]h1}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhjKhhhNhNubh)}(hHaving ``inkscape(1)`` from Inkscape (https://inkscape.org) as well would improve the quality of images embedded in PDF documents, especially for kernel releases 5.18 and later.h](hHaving }(hj^hhhNhNubj)}(h``inkscape(1)``h]h inkscape(1)}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubh from Inkscape (}(hj^hhhNhNubh)}(hhttps://inkscape.orgh]hhttps://inkscape.org}(hjxhhhNhNubah}(h]h ]h"]h$]h&]refurijzuh1hhj^ubhw) as well would improve the quality of images embedded in PDF documents, especially for kernel releases 5.18 and later.}(hj^hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjKubeh}(h]j)ah ]h"]inkah$]h&]j#aj(Kj*j uh1jIhhhKhj_hhubh)}(hhh](h)}(hChoice of Math Rendererh]hChoice of Math Renderer}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(h`Since kernel release 6.1, mathjax works as a fallback math renderer for html output.\ [#sph1_8]_h](hVSince kernel release 6.1, mathjax works as a fallback math renderer for html output. }(hjhhhNhNubj)}(h [#sph1_8]_h]h2}(hjhhhNhNubah}(h]id3ah ]h"]h$]h&]j(Khsph1-8j*j uh1jhjhKubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hGMath renderer is chosen depending on available commands as shown below:h]hGMath renderer is chosen depending on available commands as shown below:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubhtable)}(hhh](h)}(hMath Renderer Choices for HTMLh]hMath Renderer Choices for HTML}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubhtgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1jhjubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]h)}(h Math rendererh]h Math renderer}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hRequired commandsh]hRequired commands}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj0ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h Image formath]h Image format}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjGubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1j hjubhtbody)}(hhh](j)}(hhh](j)}(hhh]h)}(himgmathh]himgmath}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjrubah}(h]h ]h"]h$]h&]uh1jhjoubj)}(hhh]h)}(h latex, dvipngh]h latex, dvipng}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjoubj)}(hhh]h)}(h PNG (raster)h]h PNG (raster)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjoubeh}(h]h ]h"]h$]h&]uh1jhjlubj)}(hhh](j)}(hhh]h)}(hmathjaxh]hmathjax}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjlubeh}(h]h ]h"]h$]h&]uh1jjhjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubeh}(h]id4ah ]h"]h$]h&]uh1jhjhhhhhNubh)}(hbThe choice can be overridden by setting an environment variable ``SPHINX_IMGMATH`` as shown below:h](h@The choice can be overridden by setting an environment variable }(hj hhhNhNubj)}(h``SPHINX_IMGMATH``h]hSPHINX_IMGMATH}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh as shown below:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubj)}(hhh](h)}(h$Effect of Setting ``SPHINX_IMGMATH``h](hEffect of Setting }(hj& hhhNhNubj)}(h``SPHINX_IMGMATH``h]hSPHINX_IMGMATH}(hj. hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj& ubeh}(h]h ]h"]h$]h&]uh1hhhhKhj# ubj)}(hhh](j)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjB ubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjB ubj)}(hhh]j)}(hhh](j)}(hhh]h)}(hSettingh]hSetting}(hjb hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj_ ubah}(h]h ]h"]h$]h&]uh1jhj\ ubj)}(hhh]h)}(hRendererh]hRenderer}(hjy hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjv ubah}(h]h ]h"]h$]h&]uh1jhj\ ubeh}(h]h ]h"]h$]h&]uh1jhjY ubah}(h]h ]h"]h$]h&]uh1j hjB ubjk)}(hhh](j)}(hhh](j)}(hhh]h)}(h``SPHINX_IMGMATH=yes``h]j)}(hj h]hSPHINX_IMGMATH=yes}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]h)}(himgmathh]himgmath}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh](j)}(hhh]h)}(h``SPHINX_IMGMATH=no``h]j)}(hj h]hSPHINX_IMGMATH=no}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hhh]h)}(hmathjaxh]hmathjax}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jjhjB ubeh}(h]h ]h"]h$]h&]colsKuh1jhj# ubeh}(h]id5ah ]h"]h$]h&]uh1jhjhhhhhNubjJ)}(h2Fallback of math renderer requires Sphinx >=1.8. h](jP)}(hhh]h2}(hj4 hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhj0 hhhNhNubh)}(h0Fallback of math renderer requires Sphinx >=1.8.h]h0Fallback of math renderer requires Sphinx >=1.8.}(hjA hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj0 ubeh}(h]jah ]h"]sph1_8ah$]h&]jaj(Kj*j uh1jIhhhKhjhhubeh}(h]jah ]h"]choice of math rendererah$]h&]uh1hhj_hhhhhKjmKubeh}(h] sphinx-buildah ]h"] sphinx buildah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hWriting Documentationh]hWriting Documentation}(hjh hhhNhNubah}(h]h ]h"]h$]h&]uh1hhje hhhhhKubh)}(h-Adding new documentation can be as simple as:h]h-Adding new documentation can be as simple as:}(hjv hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhje hhubhenumerated_list)}(hhh](h list_item)}(h:Add a new ``.rst`` file somewhere under ``Documentation``.h]h)}(hj h](h Add a new }(hj hhhNhNubj)}(h``.rst``h]h.rst}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh file somewhere under }(hj hhhNhNubj)}(h``Documentation``h]h Documentation}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j hj hhhhhNubj )}(hMRefer to it from the Sphinx main `TOC tree`_ in ``Documentation/index.rst``. h]h)}(hLRefer to it from the Sphinx main `TOC tree`_ in ``Documentation/index.rst``.h](h!Refer to it from the Sphinx main }(hj hhhNhNubh)}(h `TOC tree`_h]hTOC tree}(hj hhhNhNubah}(h]h ]h"]h$]h&]nameTOC treeh7http://www.sphinx-doc.org/en/stable/markup/toctree.htmluh1hhj hKubh in }(hj hhhNhNubj)}(h``Documentation/index.rst``h]hDocumentation/index.rst}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1j hj hhhhhNubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1j hje hhhhhKubh)}(hE.. _TOC tree: http://www.sphinx-doc.org/en/stable/markup/toctree.htmlh]h}(h]toc-treeah ]h"]toc treeah$]h&]hj uh1hhKhje hhhhjmKubh)}(hXThis is usually good enough for simple documentation (like the one you're reading right now), but for larger documents it may be advisable to create a subdirectory (or use an existing one). For example, the graphics subsystem documentation is under ``Documentation/gpu``, split to several ``.rst`` files, and has a separate ``index.rst`` (with a ``toctree`` of its own) referenced from the main index.h](hThis is usually good enough for simple documentation (like the one you’re reading right now), but for larger documents it may be advisable to create a subdirectory (or use an existing one). For example, the graphics subsystem documentation is under }(hj hhhNhNubj)}(h``Documentation/gpu``h]hDocumentation/gpu}(hj$ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh, split to several }(hj hhhNhNubj)}(h``.rst``h]h.rst}(hj6 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh files, and has a separate }(hj hhhNhNubj)}(h ``index.rst``h]h index.rst}(hjH hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh (with a }(hj hhhNhNubj)}(h ``toctree``h]htoctree}(hjZ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh, of its own) referenced from the main index.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhje hhubh)}(hSee the documentation for `Sphinx`_ and `reStructuredText`_ on what you can do with them. In particular, the Sphinx `reStructuredText Primer`_ is a good place to get started with reStructuredText. There are also some `Sphinx specific markup constructs`_.h](hSee the documentation for }(hjr hhhNhNubh)}(h `Sphinx`_h]hSphinx}(hjz hhhNhNubah}(h]h ]h"]h$]h&]nameSphinxhhuh1hhjr hKubh and }(hjr hhhNhNubh)}(h`reStructuredText`_h]hreStructuredText}(hj hhhNhNubah}(h]h ]h"]h$]h&]namereStructuredTexthj uh1hhjr hKubh9 on what you can do with them. In particular, the Sphinx }(hjr hhhNhNubh)}(h`reStructuredText Primer`_h]hreStructuredText Primer}(hj hhhNhNubah}(h]h ]h"]h$]h&]namereStructuredText Primerh-http://www.sphinx-doc.org/en/stable/rest.htmluh1hhjr hKubhK is a good place to get started with reStructuredText. There are also some }(hjr hhhNhNubh)}(h$`Sphinx specific markup constructs`_h]h!Sphinx specific markup constructs}(hj hhhNhNubah}(h]h ]h"]h$]h&]name!Sphinx specific markup constructsh5http://www.sphinx-doc.org/en/stable/markup/index.htmluh1hhjr hKubh.}(hjr hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhje hhubh)}(hJ.. _reStructuredText Primer: http://www.sphinx-doc.org/en/stable/rest.htmlh]h}(h]restructuredtext-primerah ]h"]restructuredtext primerah$]h&]hj uh1hhKhje hhhhjmKubh)}(h\.. _Sphinx specific markup constructs: http://www.sphinx-doc.org/en/stable/markup/index.htmlh]h}(h]!sphinx-specific-markup-constructsah ]h"]!sphinx specific markup constructsah$]h&]hj uh1hhMhje hhhhjmKubh)}(hhh](h)}(h0Specific guidelines for the kernel documentationh]h0Specific guidelines for the kernel documentation}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubh)}(h?Here are some specific guidelines for the kernel documentation:h]h?Here are some specific guidelines for the kernel documentation:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh bullet_list)}(hhh](j )}(hPlease don't go overboard with reStructuredText markup. Keep it simple. For the most part the documentation should be plain text with just enough consistency in formatting that it can be converted to other formats. h]h)}(hPlease don't go overboard with reStructuredText markup. Keep it simple. For the most part the documentation should be plain text with just enough consistency in formatting that it can be converted to other formats.h]hPlease don’t go overboard with reStructuredText markup. Keep it simple. For the most part the documentation should be plain text with just enough consistency in formatting that it can be converted to other formats.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j hj hhhhhNubj )}(hgPlease keep the formatting changes minimal when converting existing documentation to reStructuredText. h]h)}(hfPlease keep the formatting changes minimal when converting existing documentation to reStructuredText.h]hfPlease keep the formatting changes minimal when converting existing documentation to reStructuredText.}(hj* hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj& ubah}(h]h ]h"]h$]h&]uh1j hj hhhhhNubj )}(hQAlso update the content, not just the formatting, when converting documentation. h]h)}(hPAlso update the content, not just the formatting, when converting documentation.h]hPAlso update the content, not just the formatting, when converting documentation.}(hjB hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj> ubah}(h]h ]h"]h$]h&]uh1j hj hhhhhNubj )}(hXPPlease stick to this order of heading adornments: 1. ``=`` with overline for document title:: ============== Document title ============== 2. ``=`` for chapters:: Chapters ======== 3. ``-`` for sections:: Section ------- 4. ``~`` for subsections:: Subsection ~~~~~~~~~~ Although RST doesn't mandate a specific order ("Rather than imposing a fixed number and order of section title adornment styles, the order enforced will be the order as encountered."), having the higher levels the same overall makes it easier to follow the documents. h](h)}(h1Please stick to this order of heading adornments:h]h1Please stick to this order of heading adornments:}(hjZ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjV ubj )}(hhh](j )}(h]``=`` with overline for document title:: ============== Document title ============== h](h)}(h(``=`` with overline for document title::h](j)}(h``=``h]h=}(hjs hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjo ubh" with overline for document title:}(hjo hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjk ubjj)}(h,============== Document title ==============h]h,============== Document title ==============}hj sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhjk ubeh}(h]h ]h"]h$]h&]uh1j hjh ubj )}(h,``=`` for chapters:: Chapters ======== h](h)}(h``=`` for chapters::h](j)}(h``=``h]h=}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh for chapters:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubjj)}(hChapters ========h]hChapters ========}hj sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhj ubeh}(h]h ]h"]h$]h&]uh1j hjh ubj )}(h*``-`` for sections:: Section ------- h](h)}(h``-`` for sections::h](j)}(h``-``h]h-}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh for sections:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubjj)}(hSection -------h]hSection -------}hj sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhM!hj ubeh}(h]h ]h"]h$]h&]uh1j hjh ubj )}(h3``~`` for subsections:: Subsection ~~~~~~~~~~ h](h)}(h``~`` for subsections::h](j)}(h``~``h]h~}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh for subsections:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM$hj ubjj)}(hSubsection ~~~~~~~~~~h]hSubsection ~~~~~~~~~~}hj' sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhM&hj ubeh}(h]h ]h"]h$]h&]uh1j hjh ubeh}(h]h ]h"]h$]h&]j j j hj j uh1j hjV ubh)}(hX Although RST doesn't mandate a specific order ("Rather than imposing a fixed number and order of section title adornment styles, the order enforced will be the order as encountered."), having the higher levels the same overall makes it easier to follow the documents.h]hXAlthough RST doesn’t mandate a specific order (“Rather than imposing a fixed number and order of section title adornment styles, the order enforced will be the order as encountered.”), having the higher levels the same overall makes it easier to follow the documents.}(hjA hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM)hjV ubeh}(h]h ]h"]h$]h&]uh1j hj hhhhhNubj )}(hXTFor inserting fixed width text blocks (for code examples, use case examples, etc.), use ``::`` for anything that doesn't really benefit from syntax highlighting, especially short snippets. Use ``.. code-block:: `` for longer code blocks that benefit from highlighting. For a short snippet of code embedded in the text, use \`\`. h]h)}(hXRFor inserting fixed width text blocks (for code examples, use case examples, etc.), use ``::`` for anything that doesn't really benefit from syntax highlighting, especially short snippets. Use ``.. code-block:: `` for longer code blocks that benefit from highlighting. For a short snippet of code embedded in the text, use \`\`.h](hXFor inserting fixed width text blocks (for code examples, use case examples, etc.), use }(hjY hhhNhNubj)}(h``::``h]h::}(hja hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjY ubhe for anything that doesn’t really benefit from syntax highlighting, especially short snippets. Use }(hjY hhhNhNubj)}(h``.. code-block:: ``h]h.. code-block:: }(hjs hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjY ubhs for longer code blocks that benefit from highlighting. For a short snippet of code embedded in the text, use ``.}(hjY hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM.hjU ubah}(h]h ]h"]h$]h&]uh1j hj hhhhhNubeh}(h]h ]h"]h$]h&]bullet*uh1j hhhMhj hhubeh}(h]0specific-guidelines-for-the-kernel-documentationah ]h"]0specific guidelines for the kernel documentationah$]h&]uh1hhje hhhhhMubh)}(hhh](h)}(h The C domainh]h The C domain}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhM6ubh)}(haThe **Sphinx C Domain** (name c) is suited for documentation of C API. E.g. a function prototype:h](hThe }(hj hhhNhNubhstrong)}(h**Sphinx C Domain**h]hSphinx C Domain}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubhJ (name c) is suited for documentation of C API. E.g. a function prototype:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM8hj hhubjj)}(h0.. c:function:: int ioctl( int fd, int request )h]h0.. c:function:: int ioctl( int fd, int request )}hj sbah}(h]h ]h"]h$]h&]jyjzforcelanguagersthighlight_args}uh1jihhhM;hj hhubh)}(hThe C domain of the kernel-doc has some additional features. E.g. you can *rename* the reference name of a function with a common name like ``open`` or ``ioctl``:h](hJThe C domain of the kernel-doc has some additional features. E.g. you can }(hj hhhNhNubhemphasis)}(h*rename*h]hrename}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh: the reference name of a function with a common name like }(hj hhhNhNubj)}(h``open``h]hopen}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh or }(hj hhhNhNubj)}(h ``ioctl``h]hioctl}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM?hj hhubjj)}(hL.. c:function:: int ioctl( int fd, int request ) :name: VIDIOC_LOG_STATUSh]hL.. c:function:: int ioctl( int fd, int request ) :name: VIDIOC_LOG_STATUS}hj-sbah}(h]h ]h"]h$]h&]jyjzj j rstj }uh1jihhhMChj hhubh)}(hThe func-name (e.g. ioctl) remains in the output but the ref-name changed from ``ioctl`` to ``VIDIOC_LOG_STATUS``. The index entry for this function is also changed to ``VIDIOC_LOG_STATUS``.h](hOThe func-name (e.g. ioctl) remains in the output but the ref-name changed from }(hj=hhhNhNubj)}(h ``ioctl``h]hioctl}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh to }(hj=hhhNhNubj)}(h``VIDIOC_LOG_STATUS``h]hVIDIOC_LOG_STATUS}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh7. The index entry for this function is also changed to }(hj=hhhNhNubj)}(h``VIDIOC_LOG_STATUS``h]hVIDIOC_LOG_STATUS}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh.}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMHhj hhubh)}(hXPlease note that there is no need to use ``c:func:`` to generate cross references to function documentation. Due to some Sphinx extension magic, the documentation build system will automatically turn a reference to ``function()`` into a cross reference if an index entry for the given function name exists. If you see ``c:func:`` use in a kernel document, please feel free to remove it.h](h)Please note that there is no need to use }(hjhhhNhNubj)}(h ``c:func:``h]hc:func:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh to generate cross references to function documentation. Due to some Sphinx extension magic, the documentation build system will automatically turn a reference to }(hjhhhNhNubj)}(h``function()``h]h function()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhZ into a cross reference if an index entry for the given function name exists. If you see }(hjhhhNhNubj)}(h ``c:func:``h]hc:func:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh9 use in a kernel document, please feel free to remove it.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMLhj hhubeh}(h] the-c-domainah ]h"] the c domainah$]h&]uh1hhje hhhhhM6ubh)}(hhh](h)}(hTablesh]hTables}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMTubh)}(hReStructuredText provides several options for table syntax. Kernel style for tables is to prefer *simple table* syntax or *grid table* syntax. See the `reStructuredText user reference for table syntax`_ for more details.h](haReStructuredText provides several options for table syntax. Kernel style for tables is to prefer }(hjhhhNhNubj )}(h*simple table*h]h simple table}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh syntax or }(hjhhhNhNubj )}(h *grid table*h]h grid table}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh syntax. See the }(hjhhhNhNubh)}(h3`reStructuredText user reference for table syntax`_h]h0reStructuredText user reference for table syntax}(hj hhhNhNubah}(h]h ]h"]h$]h&]name0reStructuredText user reference for table syntaxhBhttps://docutils.sourceforge.io/docs/user/rst/quickref.html#tablesuh1hhjhKubh for more details.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMVhjhhubh)}(h{.. _reStructuredText user reference for table syntax: https://docutils.sourceforge.io/docs/user/rst/quickref.html#tablesh]h}(h]0restructuredtext-user-reference-for-table-syntaxah ]h"]0restructuredtext user reference for table syntaxah$]h&]hjuh1hhMZhjhhhhjmKubh)}(hhh](h)}(h list tablesh]h list tables}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1hhhhhM^ubh)}(hX%The list-table formats can be useful for tables that are not easily laid out in the usual Sphinx ASCII-art formats. These formats are nearly impossible for readers of the plain-text documents to understand, though, and should be avoided in the absence of a strong justification for their use.h]hX%The list-table formats can be useful for tables that are not easily laid out in the usual Sphinx ASCII-art formats. These formats are nearly impossible for readers of the plain-text documents to understand, though, and should be avoided in the absence of a strong justification for their use.}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM`hj1hhubh)}(hfThe ``flat-table`` is a double-stage list similar to the ``list-table`` with some additional features:h](hThe }(hjPhhhNhNubj)}(h``flat-table``h]h flat-table}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPubh' is a double-stage list similar to the }(hjPhhhNhNubj)}(h``list-table``h]h list-table}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjPubh with some additional features:}(hjPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMfhj1hhubj )}(hhh](j )}(hWcolumn-span: with the role ``cspan`` a cell can be extended through additional columns h]h)}(hVcolumn-span: with the role ``cspan`` a cell can be extended through additional columnsh](hcolumn-span: with the role }(hjhhhNhNubj)}(h ``cspan``h]hcspan}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh2 a cell can be extended through additional columns}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMihjubah}(h]h ]h"]h$]h&]uh1j hjhhhhhNubj )}(hQrow-span: with the role ``rspan`` a cell can be extended through additional rows h]h)}(hProw-span: with the role ``rspan`` a cell can be extended through additional rowsh](hrow-span: with the role }(hjhhhNhNubj)}(h ``rspan``h]hrspan}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh/ a cell can be extended through additional rows}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMlhjubah}(h]h ]h"]h$]h&]uh1j hjhhhhhNubj )}(hX auto span rightmost cell of a table row over the missing cells on the right side of that table-row. With Option ``:fill-cells:`` this behavior can changed from *auto span* to *auto fill*, which automatically inserts (empty) cells instead of spanning the last cell. h]h)}(hX auto span rightmost cell of a table row over the missing cells on the right side of that table-row. With Option ``:fill-cells:`` this behavior can changed from *auto span* to *auto fill*, which automatically inserts (empty) cells instead of spanning the last cell.h](hqauto span rightmost cell of a table row over the missing cells on the right side of that table-row. With Option }(hjhhhNhNubj)}(h``:fill-cells:``h]h :fill-cells:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh this behavior can changed from }(hjhhhNhNubj )}(h *auto span*h]h auto span}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh to }(hjhhhNhNubj )}(h *auto fill*h]h auto fill}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubhN, which automatically inserts (empty) cells instead of spanning the last cell.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMohjubah}(h]h ]h"]h$]h&]uh1j hjhhhhhNubeh}(h]h ]h"]h$]h&]j j uh1j hhhMihj1hhubh)}(hoptions:h]hoptions:}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMthj1hhubj )}(hhh](j )}(h.``:header-rows:`` [int] count of header rowsh]h)}(hj@h](j)}(h``:header-rows:``h]h :header-rows:}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubh [int] count of header rows}(hjBhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMvhj>ubah}(h]h ]h"]h$]h&]uh1j hj;hhhhhNubj )}(h/``:stub-columns:`` [int] count of stub columnsh]h)}(hjeh](j)}(h``:stub-columns:``h]h:stub-columns:}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjgubh [int] count of stub columns}(hjghhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMwhjcubah}(h]h ]h"]h$]h&]uh1j hj;hhhhhNubj )}(h8``:widths:`` [[int] [int] ... ] widths of columnsh]h)}(hjh](j)}(h ``:widths:``h]h:widths:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, [[int] [int] ... ] widths of columns}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMxhjubah}(h]h ]h"]h$]h&]uh1j hj;hhhhhNubj )}(hQ``:fill-cells:`` instead of auto-spanning missing cells, insert missing cells h]h)}(hP``:fill-cells:`` instead of auto-spanning missing cells, insert missing cellsh](j)}(h``:fill-cells:``h]h :fill-cells:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh@ instead of auto-spanning missing cells, insert missing cells}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMyhjubah}(h]h ]h"]h$]h&]uh1j hj;hhhhhNubeh}(h]h ]h"]h$]h&]j j uh1j hhhMvhj1hhubh)}(hroles:h]hroles:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM{hj1hhubj )}(hhh](j )}(h1``:cspan:`` [int] additional columns (*morecols*)h]h)}(hjh](j)}(h ``:cspan:``h]h:cspan:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh [int] additional columns (}(hjhhhNhNubj )}(h *morecols*h]hmorecols}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM}hjubah}(h]h ]h"]h$]h&]uh1j hjhhhhhNubj )}(h/``:rspan:`` [int] additional rows (*morerows*) h]h)}(h.``:rspan:`` [int] additional rows (*morerows*)h](j)}(h ``:rspan:``h]h:rspan:}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj%ubh [int] additional rows (}(hj%hhhNhNubj )}(h *morerows*h]hmorerows}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj%ubh)}(hj%hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM~hj!ubah}(h]h ]h"]h$]h&]uh1j hjhhhhhNubeh}(h]h ]h"]h$]h&]j j uh1j hhhM}hj1hhubh)}(hXGThe example below shows how to use this markup. The first level of the staged list is the *table-row*. In the *table-row* there is only one markup allowed, the list of the cells in this *table-row*. Exceptions are *comments* ( ``..`` ) and *targets* (e.g. a ref to ``:ref:`last row ``` / :ref:`last row `).h](h[The example below shows how to use this markup. The first level of the staged list is the }(hj_hhhNhNubj )}(h *table-row*h]h table-row}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1j hj_ubh . In the }(hj_hhhNhNubj )}(h *table-row*h]h table-row}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj_ubhA there is only one markup allowed, the list of the cells in this }(hj_hhhNhNubj )}(h *table-row*h]h table-row}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj_ubh. Exceptions are }(hj_hhhNhNubj )}(h *comments*h]hcomments}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj_ubh ( }(hj_hhhNhNubj)}(h``..``h]h..}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubh ) and }(hj_hhhNhNubj )}(h *targets*h]htargets}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hj_ubh (e.g. a ref to }(hj_hhhNhNubj)}(h``:ref:`last row ```h]h:ref:`last row `}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubh / }(hj_hhhNhNubh)}(h:ref:`last row `h]j)}(hjh]hlast row}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj  refdomainjreftyperef refexplicitrefwarnjlast rowuh1hhhhMhj_ubh).}(hj_hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj1hhubjj)}(hX&.. flat-table:: table title :widths: 2 1 1 3 * - head col 1 - head col 2 - head col 3 - head col 4 * - row 1 - field 1.1 - field 1.2 with autospan * - row 2 - field 2.1 - :rspan:`1` :cspan:`1` field 2.2 - 3.3 * .. _`last row`: - row 3h]hX&.. flat-table:: table title :widths: 2 1 1 3 * - head col 1 - head col 2 - head col 3 - head col 4 * - row 1 - field 1.1 - field 1.2 with autospan * - row 2 - field 2.1 - :rspan:`1` :cspan:`1` field 2.2 - 3.3 * .. _`last row`: - row 39g}hjsbah}(h]h ]h"]h$]h&]jyjzj j rstj }uh1jihhhMhj1hhubh)}(h Rendered as:h]h Rendered as:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj1hhubj%)}(hX'.. flat-table:: table title :widths: 2 1 1 3 * - head col 1 - head col 2 - head col 3 - head col 4 * - row 1 - field 1.1 - field 1.2 with autospan * - row 2 - field 2.1 - :rspan:`1` :cspan:`1` field 2.2 - 3.3 * .. _`last row`: - row 3 h]j)}(hhh](h)}(h table titleh]h table title}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj1ubj)}(hhh](j)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjBubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjBubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjBubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjBubjk)}(hhh](j)}(hhh](j)}(hhh]h)}(h head col 1h]h head col 1}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjsubah}(h]h ]h"]h$]h&]uh1jhjpubj)}(hhh]h)}(h head col 2h]h head col 2}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjpubj)}(hhh]h)}(h head col 3h]h head col 3}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjpubj)}(hhh]h)}(h head col 4h]h head col 4}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjpubeh}(h]h ]h"]h$]h&]uh1jhjmubj)}(hhh](j)}(hhh]h)}(hrow 1h]hrow 1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(h field 1.1h]h field 1.1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]h)}(hfield 1.2 with autospanh]hfield 1.2 with autospan}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]morecolsKuh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjmubj)}(hhh](j)}(hhh]h)}(hrow 2h]hrow 2}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'ubah}(h]h ]h"]h$]h&]uh1jhj$ubj)}(hhh]h)}(h field 2.1h]h field 2.1}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj>ubah}(h]h ]h"]h$]h&]uh1jhj$ubj)}(hhh]h)}(h%:rspan:`1` :cspan:`1` field 2.2 - 3.3h](h }(hjXhhhNhNubh field 2.2 - 3.3}(hjXhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjUubah}(h]h ]h"]h$]h&]morerowsKmorecolsKuh1jhj$ubeh}(h]h ]h"]h$]h&]uh1jhjmubj)}(hhh](j)}(hhh](h)}(h.. _`last row`:h]h}(h]h ]h"]h$]h&]hlast-rowuh1hhMhj{ubh)}(hrow 3h]hrow 3}(hjhhhNhNubah}(h]jah ]h"]last rowah$]h&]uh1hhhhMhj{j}jj~sj}jj~subeh}(h]h ]h"]h$]h&]uh1jhjxubj)}(hhh]h}(h]h ]h"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]uh1jhjmubeh}(h]h ]h"]h$]h&]uh1jjhjBubeh}(h]h ]h"]h$]h&]colsKuh1jhj1ubeh}(h]id6ah ]h"]h$]h&]uh1jhj-ubah}(h]h ]h"]h$]h&]uh1j$hhhMhj1hhubeh}(h] list-tablesah ]h"] list tablesah$]h&]uh1hhjhhhhhM^ubeh}(h]tablesah ]h"]tablesah$]h&]uh1hhje hhhhhMTubh)}(hhh](h)}(hCross-referencingh]hCross-referencing}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hXCross-referencing from one documentation page to another can be done simply by writing the path to the document file, no special syntax required. The path can be either absolute or relative. For absolute paths, start it with "Documentation/". For example, to cross-reference to this page, all the following are valid options, depending on the current document's directory (note that the ``.rst`` extension is required)::h](hXCross-referencing from one documentation page to another can be done simply by writing the path to the document file, no special syntax required. The path can be either absolute or relative. For absolute paths, start it with “Documentation/”. For example, to cross-reference to this page, all the following are valid options, depending on the current document’s directory (note that the }(hjhhhNhNubj)}(h``.rst``h]h.rst}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh extension is required):}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjj)}(hSee Documentation/doc-guide/sphinx.rst. This always works. Take a look at sphinx.rst, which is at this same directory. Read ../sphinx.rst, which is one directory above.h]hSee Documentation/doc-guide/sphinx.rst. This always works. Take a look at sphinx.rst, which is at this same directory. Read ../sphinx.rst, which is one directory above.}hj sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhjhhubh)}(hIf you want the link to have a different rendered text other than the document's title, you need to use Sphinx's ``doc`` role. For example::h](huIf you want the link to have a different rendered text other than the document’s title, you need to use Sphinx’s }(hjhhhNhNubj)}(h``doc``h]hdoc}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh role. For example:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjj)}(h`.h]h`.}hj8sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhjhhubh)}(hFor most use cases, the former is preferred, as it is cleaner and more suited for people reading the source files. If you come across a ``:doc:`` usage that isn't adding any value, please feel free to convert it to just the document path.h](hFor most use cases, the former is preferred, as it is cleaner and more suited for people reading the source files. If you come across a }(hjFhhhNhNubj)}(h ``:doc:``h]h:doc:}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubh_ usage that isn’t adding any value, please feel free to convert it to just the document path.}(hjFhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hrFor information on cross-referencing to kernel-doc functions or types, see Documentation/doc-guide/kernel-doc.rst.h]hrFor information on cross-referencing to kernel-doc functions or types, see Documentation/doc-guide/kernel-doc.rst.}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hhh](h)}(hReferencing commitsh]hReferencing commits}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjthhhhhMubh)}(hmReferences to git commits are automatically hyperlinked given that they are written in one of these formats::h]hlReferences to git commits are automatically hyperlinked given that they are written in one of these formats:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjthhubjj)}(hYcommit 72bf4f1767f0 commit 72bf4f1767f0 ("net: do not leave an empty skb in write queue")h]hYcommit 72bf4f1767f0 commit 72bf4f1767f0 ("net: do not leave an empty skb in write queue")}hjsbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhjthhubh)}(h.. _sphinx_kfigure:h]h}(h]h ]h"]h$]h&]hsphinx-kfigureuh1hhMhjthhhhubeh}(h]referencing-commitsah ]h"]referencing commitsah$]h&]uh1hhjhhhhhMubeh}(h]cross-referencingah ]h"]cross-referencingah$]h&]uh1hhje hhhhhMubeh}(h]writing-documentationah ]h"]writing documentationah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hFigures & Imagesh]hFigures & Images}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hIf you want to add an image, you should use the ``kernel-figure`` and ``kernel-image`` directives. E.g. to insert a figure with a scalable image format, use SVG (:ref:`svg_image_example`)::h](h0If you want to add an image, you should use the }(hjhhhNhNubj)}(h``kernel-figure``h]h kernel-figure}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh and }(hjhhhNhNubj)}(h``kernel-image``h]h kernel-image}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhL directives. E.g. to insert a figure with a scalable image format, use SVG (}(hjhhhNhNubh)}(h:ref:`svg_image_example`h]j)}(hjh]hsvg_image_example}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj  refdomainjreftyperef refexplicitrefwarnjsvg_image_exampleuh1hhhhMhjubh):}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjj)}(hT.. kernel-figure:: svg_image.svg :alt: simple SVG image SVG image exampleh]hT.. kernel-figure:: svg_image.svg :alt: simple SVG image SVG image example}hj+sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhjhhubh)}(h.. _svg_image_example:h]h}(h]h ]h"]h$]h&]hsvg-image-exampleuh1hhMhjhhhhubkfigure kernel_figure)}(hhh]hfigure)}(hhh](himage)}(hU.. kernel-figure:: svg_image.svg :alt: simple SVG image SVG image example h]h}(h]h ]h"]h$]h&]altsimple SVG imageuridoc-guide/svg_image.svg candidates}j j^suh1jOhjLhhhKubhcaption)}(hSVG image exampleh]hSVG image example}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jahhhMhjLubeh}(h]id7ah ]h"]h$]h&]uh1jJhjGubah}(h]jCah ]h"]svg_image_exampleah$]h&]uh1jEhjhhhhhNj}j|j9sj}jCj9subh)}(hMThe kernel figure (and image) directive supports **DOT** formatted files, seeh](h1The kernel figure (and image) directive supports }(hjhhhNhNubj )}(h**DOT**h]hDOT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh formatted files, see}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj )}(hhh](j )}(h)DOT: http://graphviz.org/pdf/dotguide.pdfh]h)}(hjh](hDOT: }(hjhhhNhNubh)}(h$http://graphviz.org/pdf/dotguide.pdfh]h$http://graphviz.org/pdf/dotguide.pdf}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1hhjubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjhhhhhNubj )}(h7Graphviz: http://www.graphviz.org/content/dot-language h]h)}(h6Graphviz: http://www.graphviz.org/content/dot-languageh](h Graphviz: }(hjhhhNhNubh)}(h,http://www.graphviz.org/content/dot-languageh]h,http://www.graphviz.org/content/dot-language}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1hhjubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjhhhhhNubeh}(h]h ]h"]h$]h&]j j uh1j hhhMhjhhubh)}(h*A simple example (:ref:`hello_dot_file`)::h](hA simple example (}(hjhhhNhNubh)}(h:ref:`hello_dot_file`h]j)}(hjh]hhello_dot_file}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj  refdomainj reftyperef refexplicitrefwarnjhello_dot_fileuh1hhhhMhjubh):}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjj)}(hS.. kernel-figure:: hello.dot :alt: hello world DOT's hello world exampleh]hS.. kernel-figure:: hello.dot :alt: hello world DOT's hello world example}hj)sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhjhhubh)}(h.. _hello_dot_file:h]h}(h]h ]h"]h$]h&]hhello-dot-fileuh1hhMhjhhhhubjF)}(hhh]jK)}(hhh](jP)}(hT.. kernel-figure:: hello.dot :alt: hello world DOT's hello world example h]h}(h]h ]h"]h$]h&]alt hello worlduridoc-guide/hello.dotj_}j jUsuh1jOhjEhhhKubjb)}(hDOT's hello world exampleh]hDOT’s hello world example}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jahhhMhjEubeh}(h]id8ah ]h"]h$]h&]uh1jJhjBubah}(h]jAah ]h"]hello_dot_fileah$]h&]uh1jEhjhhhhhNj}jpj7sj}jAj7subh)}(htEmbedded *render* markups (or languages) like Graphviz's **DOT** are provided by the ``kernel-render`` directives.::h](h Embedded }(hjuhhhNhNubj )}(h*render*h]hrender}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjuubh* markups (or languages) like Graphviz’s }(hjuhhhNhNubj )}(h**DOT**h]hDOT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjuubh are provided by the }(hjuhhhNhNubj)}(h``kernel-render``h]h kernel-render}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjuubh directives.:}(hjuhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjj)}(h.. kernel-render:: DOT :alt: foobar digraph :caption: Embedded **DOT** (Graphviz) code digraph foo { "bar" -> "baz"; }h]h.. kernel-render:: DOT :alt: foobar digraph :caption: Embedded **DOT** (Graphviz) code digraph foo { "bar" -> "baz"; }}hjsbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhjhhubh)}(hHow this will be rendered depends on the installed tools. If Graphviz is installed, you will see a vector image. If not, the raw markup is inserted as *literal-block* (:ref:`hello_dot_render`).h](hHow this will be rendered depends on the installed tools. If Graphviz is installed, you will see a vector image. If not, the raw markup is inserted as }(hjhhhNhNubj )}(h*literal-block*h]h literal-block}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh (}(hjhhhNhNubh)}(h:ref:`hello_dot_render`h]j)}(hjh]hhello_dot_render}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj  refdomainjreftyperef refexplicitrefwarnjhello_dot_renderuh1hhhhM hjubh).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hjhhubh)}(h.. _hello_dot_render:h]h}(h]h ]h"]h$]h&]hhello-dot-renderuh1hhM hjhhhhubjK)}(hhh](jD kernel_render)}(hhh]jj)}(h"digraph foo { "bar" -> "baz"; }h]h"digraph foo { "bar" -> "baz"; }}hjsbah}(h]h ]h"]h$]h&]jyjzuh1jihjhhubah}(h]h ]h"]h$]h&]altfoobar digraphsrclangDOTuh1jhjubjb)}(h Embedded **DOT** (Graphviz) codeh](h Embedded }(hj6hhhNhNubj )}(h**DOT**h]hDOT}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj6ubh (Graphviz) code}(hj6hhhNhNubeh}(h]h ]h"]h$]h&]uh1jahhhKhjubeh}(h](id9jeh ]h"]hello_dot_renderah$]h&]altj3captionj8uh1jJhjhhhhhNj}j[j sj}jj subh)}(hXThe *render* directive has all the options known from the *figure* directive, plus option ``caption``. If ``caption`` has a value, a *figure* node is inserted. If not, an *image* node is inserted. A ``caption`` is also needed, if you want to refer to it (:ref:`hello_svg_render`).h](hThe }(hjbhhhNhNubj )}(h*render*h]hrender}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjbubh. directive has all the options known from the }(hjbhhhNhNubj )}(h*figure*h]hfigure}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1j hjbubh directive, plus option }(hjbhhhNhNubj)}(h ``caption``h]hcaption}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh. If }(hjbhhhNhNubj)}(h ``caption``h]hcaption}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh has a value, a }(hjbhhhNhNubj )}(h*figure*h]hfigure}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjbubh node is inserted. If not, an }(hjbhhhNhNubj )}(h*image*h]himage}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjbubh node is inserted. A }(hjbhhhNhNubj)}(h ``caption``h]hcaption}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubh- is also needed, if you want to refer to it (}(hjbhhhNhNubh)}(h:ref:`hello_svg_render`h]j)}(hjh]hhello_svg_render}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj  refdomainjreftyperef refexplicitrefwarnjhello_svg_renderuh1hhhhMhjbubh).}(hjbhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hEmbedded **SVG**::h](h Embedded }(hjhhhNhNubj )}(h**SVG**h]hSVG}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjj)}(h.. kernel-render:: SVG :caption: Embedded **SVG** markup :alt: so-nw-arrow ... h]h.. kernel-render:: SVG :caption: Embedded **SVG** markup :alt: so-nw-arrow ... }hj2sbah}(h]h ]h"]h$]h&]jyjzuh1jihhhMhjhhubh)}(h.. _hello_svg_render:h]h}(h]h ]h"]h$]h&]hhello-svg-renderuh1hhM'hjhhhhubjK)}(hhh](j)}(hhh]jj)}(hX? h]hX? }hjQsbah}(h]h ]h"]h$]h&]jyjzuh1jihjNhhubah}(h]h ]h"]h$]h&]j2 so-nw-arrowj4SVGuh1jhjKubjb)}(hEmbedded **SVG** markuph](h Embedded }(hjghhhNhNubj )}(h**SVG**h]hSVG}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1j hjgubh markup}(hjghhhNhNubeh}(h]h ]h"]h$]h&]uh1jahhhKhjKubeh}(h](id10jJeh ]h"]hello_svg_renderah$]h&]captionjialtjeuh1jJhjhhhhhNj}jj@sj}jJj@subeh}(h](figures-imagesjeh ]h"](figures & imagessphinx_kfigureeh$]h&]uh1hhhhhhhhMj}jjsj}jjsubeh}(h](%using-sphinx-for-kernel-documentationheh ]h"](%using sphinx for kernel documentation sphinxdoceh$]h&]uh1hhhhhhhhKj}jhsj}hhsubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksjfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehÌ _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}(sphinx](hjz erestructuredtext](hj eimgmath]jamathjax]jachoice of math renderer]jaink]jasph1_8]jatoc tree]j arestructuredtext primer]j a!sphinx specific markup constructs]j a0restructuredtext user reference for table syntax]j aurefids}(h]haj]jaj]jaj]j~aj]jajC]j9ajA]j7aj]j ajJ]j@aj)]jaj]jaunameids}(jhjjjjjgjwjtjZjjYjVjjjjjgjjjjjjjjjjjQjNjb j_ jj)jZ jjS jjjj j j j j j j j jjjjj.j+jjjjjjjjjjjjj|jCjpjAj[jjjJu nametypes}(jjjjjwjZjYjjjjjjjjjQjb jjZ jS jj j j j jjj.jjjjjjj|jpj[juh}(hhjhjgjajtjnjjjVjjjjgjjjmjjjjjjjjjNjj_ j_j#jj)jKjjjjjj0 jje j j j j j j j j jj jjj+j%jj1jjjjjjtjjjjjCjGjAjBjjjJjKjjj+ j# jj1jsjLjgjEjXjjjKu footnote_refs}(j]jaj]jau citation_refs} autofootnotes](jKj0 eautofootnote_refs](jjesymbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}jK sRparse_messages]transform_messages](hsystem_message)}(hhh]h)}(hhh]h/Hyperlink target "sphinxdoc" is not referenced.}hjWsbah}(h]h ]h"]h$]h&]uh1hhjTubah}(h]h ]h"]h$]h&]levelKtypeINFOsourcehÌlineKuh1jRubjS)}(hhh]h)}(hhh]h4Hyperlink target "sphinx-install" is not referenced.}hjrsbah}(h]h ]h"]h$]h&]uh1hhjoubah}(h]h ]h"]h$]h&]levelKtypejlsourcehÌlineKuh1jRubjS)}(hhh]h)}(hhh]h8Hyperlink target "sphinx-pre-install" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejlsourcehÌlineKduh1jRubjS)}(hhh]h)}(hhh]h.Hyperlink target "last-row" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejllineMsourcehuh1jRubjS)}(hhh]h)}(hhh]h4Hyperlink target "sphinx-kfigure" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejlsourcehÌlineMuh1jRubjS)}(hhh]h)}(hhh]h7Hyperlink target "svg-image-example" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejlsourcehÌlineMuh1jRubjS)}(hhh]h)}(hhh]h4Hyperlink target "hello-dot-file" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypejlsourcehÌlineMuh1jRubjS)}(hhh]h)}(hhh]h6Hyperlink target "hello-dot-render" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]levelKtypejlsourcehÌlineM uh1jRubjS)}(hhh]h)}(hhh]h6Hyperlink target "hello-svg-render" is not referenced.}hj(sbah}(h]h ]h"]h$]h&]uh1hhj%ubah}(h]h ]h"]h$]h&]levelKtypejlsourcehÌlineM'uh1jRube transformerN include_log] decorationNhhub.