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/tools/kdoc_parsermodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget%/translations/zh_TW/tools/kdoc_parsermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget%/translations/it_IT/tools/kdoc_parsermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget%/translations/ja_JP/tools/kdoc_parsermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget%/translations/ko_KR/tools/kdoc_parsermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget%/translations/pt_BR/tools/kdoc_parsermodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget%/translations/sp_SP/tools/kdoc_parsermodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhh?/var/lib/git/docbuild/linux/Documentation/tools/kdoc_parser.rsthKubhsection)}(hhh](htitle)}(hKernel-doc parser stageh]hKernel-doc parser stage}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h&C replacement rules used by the parserh]h&C replacement rules used by the parser}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](pair$module; lib.python.kdoc.xforms_lists#module-lib.python.kdoc.xforms_listshNtauh1hhhhhhNhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](single3CTransforms (class in lib.python.kdoc.xforms_lists)(lib.python.kdoc.xforms_lists.CTransformshNtauh1hhhhhhNhNubhdesc)}(hhh](hdesc_signature)}(h CTransforms()h](hdesc_annotation)}(h2[<#text: 'class'>, >]h](hclass}(hjhhhNhNubhdesc_sig_space)}(h h]h }(hj%hhhNhNubah}(h]h ]wah"]h$]h&]uh1j#hjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_lists.CTransformshKubh desc_addname)}(hlib.python.kdoc.xforms_lists.h]hlib.python.kdoc.xforms_lists.}(hj=hhhNhNubah}(h]h ]( sig-prename descclassnameeh"]h$]h&]hhuh1j;hjhhhj:hKubh desc_name)}(h CTransformsh]h CTransforms}(hjOhhhNhNubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1jMhjhhhj:hKubeh}(h]j ah ](sig sig-objecteh"]h$]h&]modulelib.python.kdoc.xforms_listsclasshfullnamejQ _toc_partsjhjQ _toc_namejQuh1jhj:hKhjhhubh desc_content)}(hhh](h paragraph)}(hBases: :py:class:`object`h](hBases: }(hjuhhhNhNubh)}(h:py:class:`object`h]hliteral)}(hjh]hobject}(hjhhhNhNubah}(h]h ](xrefpypy-classeh"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&]refdoctools/kdoc_parser refdomainjreftypeclass refexplicitrefwarn py:modulejhpy:classjQ reftargetobjectuh1hh|/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_listshKhjuubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_lists.CTransformshKhjphhubjt)}(hData class containing a long set of transformations to turn structure member prefixes, and macro invocations and variables into something we can parse and generate kdoc for.h]hData class containing a long set of transformations to turn structure member prefixes, and macro invocations and variables into something we can parse and generate kdoc for.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_lists.CTransformshKhjphhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9apply() (lib.python.kdoc.xforms_lists.CTransforms method).lib.python.kdoc.xforms_lists.CTransforms.applyhNtauh1hhjphhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_lists.CTransforms.applyhNubj)}(hhh](j)}(h&CTransforms.apply(xforms_type, source)h](jN)}(happlyh]happly}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_lists.CTransforms.applyhKubhdesc_parameterlist)}(hxforms_type, sourceh](hdesc_parameter)}(h xforms_typeh]h desc_sig_name)}(h xforms_typeh]h xforms_type}(hjhhhNhNubah}(h]h ]nah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hsourceh]j)}(hsourceh]hsource}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.xforms_listsjijQjjCTransforms.applyjkj' CTransformsapplyjmCTransforms.apply()uh1jhjhKhjhhubjo)}(hhh](jt)}(h/Apply a set of transforms to a block of source.h]h/Apply a set of transforms to a block of source.}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhj-hhubjt)}(hIAs tokenizer is used here, this function also remove comments at the end.h]hIAs tokenizer is used here, this function also remove comments at the end.}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhj-hhubeh}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]domainjUobjtypejVdesctypejVnoindex noindexentrynocontentsentryuh1jhhhjphjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Dfunction_xforms (lib.python.kdoc.xforms_lists.CTransforms attribute)8lib.python.kdoc.xforms_lists.CTransforms.function_xformshNtauh1hhjphhhEdocstring of lib.python.kdoc.xforms_lists.CTransforms.function_xformshNubj)}(hhh](j)}(hCTransforms.function_xformsh](jN)}(hfunction_xformsh]hfunction_xforms}(hjvhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjrhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_lists.CTransforms.function_xformshKubj)}(hXj[(CMatch("^static\b"), ''), (CMatch("^extern\b"), ''), (CMatch("^asmlinkage\b"), ''), (CMatch("^inline\b"), ''), (CMatch("^__inline__\b"), ''), (CMatch("^__inline\b"), ''), (CMatch("^__always_inline\b"), ''), (CMatch("^noinline\b"), ''), (CMatch("^__FORTIFY_INLINE\b"), ''), (CMatch("^__init\b"), ''), (CMatch("^__init_or_module\b"), ''), (CMatch("^__exit\b"), ''), (CMatch("^__deprecated\b"), ''), (CMatch("^__flatten\b"), ''), (CMatch("^__meminit\b"), ''), (CMatch("^__must_check\b"), ''), (CMatch("^__weak\b"), ''), (CMatch("^__sched\b"), ''), (CMatch("^__always_unused\b"), ''), (CMatch("^__printf\b"), ''), (CMatch("^__(?:re)?alloc_size\b"), ''), (CMatch("^__diagnose_as\b"), ''), (CMatch("^DECL_BUCKET_PARAMS\b"), '\\1, \\2'), (CMatch("^__no_context_analysis\b"), ''), (CMatch("^__attribute_const__\b"), ''), (CMatch("^__attribute__\b"), ''), (KernRe("_noprof" ), '')]h](j$)}(h h]h }(hjhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjubhdesc_sig_punctuation)}(h=h]h=}(hjhhhNhNubah}(h]h ]pah"]h$]h&]uh1jhjubj$)}(h h]h }(hjhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjubhXj[(CMatch("^static\b"), ''), (CMatch("^extern\b"), ''), (CMatch("^asmlinkage\b"), ''), (CMatch("^inline\b"), ''), (CMatch("^__inline__\b"), ''), (CMatch("^__inline\b"), ''), (CMatch("^__always_inline\b"), ''), (CMatch("^noinline\b"), ''), (CMatch("^__FORTIFY_INLINE\b"), ''), (CMatch("^__init\b"), ''), (CMatch("^__init_or_module\b"), ''), (CMatch("^__exit\b"), ''), (CMatch("^__deprecated\b"), ''), (CMatch("^__flatten\b"), ''), (CMatch("^__meminit\b"), ''), (CMatch("^__must_check\b"), ''), (CMatch("^__weak\b"), ''), (CMatch("^__sched\b"), ''), (CMatch("^__always_unused\b"), ''), (CMatch("^__printf\b"), ''), (CMatch("^__(?:re)?alloc_size\b"), ''), (CMatch("^__diagnose_as\b"), ''), (CMatch("^DECL_BUCKET_PARAMS\b"), '\\1, \\2'), (CMatch("^__no_context_analysis\b"), ''), (CMatch("^__attribute_const__\b"), ''), (CMatch("^__attribute__\b"), ''), (KernRe("_noprof" ), '')]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhjrhhhjhKubeh}(h]jlah ](jbjceh"]h$]h&]jglib.python.kdoc.xforms_listsjijQjjCTransforms.function_xformsjkj CTransformsfunction_xformsjmjuh1jhjhKhjohhubjo)}(hhh]jt)}(h#Transforms for function prototypes.h]h#Transforms for function prototypes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjnhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjohhhjhKubeh}(h]h ](py attributeeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjphjnhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Bstruct_xforms (lib.python.kdoc.xforms_lists.CTransforms attribute)6lib.python.kdoc.xforms_lists.CTransforms.struct_xformshNtauh1hhjphhhCdocstring of lib.python.kdoc.xforms_lists.CTransforms.struct_xformshNubj)}(hhh](j)}(hCTransforms.struct_xformsh](jN)}(h struct_xformsh]h struct_xforms}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_lists.CTransforms.struct_xformshKubj)}(hX[(CMatch("^__attribute__\b"), ''), (CMatch("^__aligned\b"), ''), (CMatch("^__counted_by\b"), ''), (CMatch("^__counted_by_(le|be)\b"), ''), (CMatch("^__guarded_by\b"), ''), (CMatch("^__pt_guarded_by\b"), ''), (CMatch("^__packed\b"), ''), (CMatch("^CRYPTO_MINALIGN_ATTR\b"), ''), (CMatch("^__private\b"), ''), (CMatch("^__rcu\b"), ''), (CMatch("^____cacheline_aligned_in_smp\b"), ''), (CMatch("^____cacheline_aligned\b"), ''), (CMatch("^__cacheline_group_(?:begin|end)\b"), ''), (CMatch("^__ETHTOOL_DECLARE_LINK_MODE_MASK\b"), 'DECLARE_BITMAP(\\1, __ETHTOOL_LINK_MODE_MASK_NBITS)'), (CMatch("^DECLARE_PHY_INTERFACE_MASK\b"), 'DECLARE_BITMAP(\\1, PHY_INTERFACE_MODE_MAX)'), (CMatch("^DECLARE_BITMAP\b"), 'unsigned long \\1[BITS_TO_LONGS(\\2)]'), (CMatch("^DECLARE_HASHTABLE\b"), 'unsigned long \\1[1 << ((\\2) - 1)]'), (CMatch("^DECLARE_KFIFO\b"), '\\2 *\\1'), (CMatch("^DECLARE_KFIFO_PTR\b"), '\\2 *\\1'), (CMatch("^(?:__)?DECLARE_FLEX_ARRAY\b"), '\\1 \\2[]'), (CMatch("^DEFINE_DMA_UNMAP_ADDR\b"), 'dma_addr_t \\1'), (CMatch("^DEFINE_DMA_UNMAP_LEN\b"), '__u32 \\1'), (CMatch("^VIRTIO_DECLARE_FEATURES\b"), 'union { u64 \\1; u64 \\1_array[VIRTIO_FEATURES_U64S]; }'), (CMatch("^__cond_acquires\b"), ''), (CMatch("^__cond_releases\b"), ''), (CMatch("^__acquires\b"), ''), (CMatch("^__releases\b"), ''), (CMatch("^__must_hold\b"), ''), (CMatch("^__must_not_hold\b"), ''), (CMatch("^__must_hold_shared\b"), ''), (CMatch("^__cond_acquires_shared\b"), ''), (CMatch("^__acquires_shared\b"), ''), (CMatch("^__releases_shared\b"), ''), (CMatch("^__attribute__\b"), ''), (CMatch("^struct_group\b"), 'struct { \\2+ };'), (CMatch("^struct_group_attr\b"), 'struct { \\3+ };'), (CMatch("^struct_group_tagged\b"), 'struct { \\3+ };'), (CMatch("^__struct_group\b"), 'struct { \\4+ };')]h](j$)}(h h]h }(hjhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjubj)}(h=h]h=}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj$)}(h h]h }(hj/hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjubhX[(CMatch("^__attribute__\b"), ''), (CMatch("^__aligned\b"), ''), (CMatch("^__counted_by\b"), ''), (CMatch("^__counted_by_(le|be)\b"), ''), (CMatch("^__guarded_by\b"), ''), (CMatch("^__pt_guarded_by\b"), ''), (CMatch("^__packed\b"), ''), (CMatch("^CRYPTO_MINALIGN_ATTR\b"), ''), (CMatch("^__private\b"), ''), (CMatch("^__rcu\b"), ''), (CMatch("^____cacheline_aligned_in_smp\b"), ''), (CMatch("^____cacheline_aligned\b"), ''), (CMatch("^__cacheline_group_(?:begin|end)\b"), ''), (CMatch("^__ETHTOOL_DECLARE_LINK_MODE_MASK\b"), 'DECLARE_BITMAP(\\1, __ETHTOOL_LINK_MODE_MASK_NBITS)'), (CMatch("^DECLARE_PHY_INTERFACE_MASK\b"), 'DECLARE_BITMAP(\\1, PHY_INTERFACE_MODE_MAX)'), (CMatch("^DECLARE_BITMAP\b"), 'unsigned long \\1[BITS_TO_LONGS(\\2)]'), (CMatch("^DECLARE_HASHTABLE\b"), 'unsigned long \\1[1 << ((\\2) - 1)]'), (CMatch("^DECLARE_KFIFO\b"), '\\2 *\\1'), (CMatch("^DECLARE_KFIFO_PTR\b"), '\\2 *\\1'), (CMatch("^(?:__)?DECLARE_FLEX_ARRAY\b"), '\\1 \\2[]'), (CMatch("^DEFINE_DMA_UNMAP_ADDR\b"), 'dma_addr_t \\1'), (CMatch("^DEFINE_DMA_UNMAP_LEN\b"), '__u32 \\1'), (CMatch("^VIRTIO_DECLARE_FEATURES\b"), 'union { u64 \\1; u64 \\1_array[VIRTIO_FEATURES_U64S]; }'), (CMatch("^__cond_acquires\b"), ''), (CMatch("^__cond_releases\b"), ''), (CMatch("^__acquires\b"), ''), (CMatch("^__releases\b"), ''), (CMatch("^__must_hold\b"), ''), (CMatch("^__must_not_hold\b"), ''), (CMatch("^__must_hold_shared\b"), ''), (CMatch("^__cond_acquires_shared\b"), ''), (CMatch("^__acquires_shared\b"), ''), (CMatch("^__releases_shared\b"), ''), (CMatch("^__attribute__\b"), ''), (CMatch("^struct_group\b"), 'struct { \\2+ };'), (CMatch("^struct_group_attr\b"), 'struct { \\3+ };'), (CMatch("^struct_group_tagged\b"), 'struct { \\3+ };'), (CMatch("^__struct_group\b"), 'struct { \\4+ };')]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.xforms_listsjijQjjCTransforms.struct_xformsjkjM CTransforms struct_xformsjmjNuh1jhjhKhjhhubjo)}(hhh]jt)}(h"Transforms for structs and unions.h]h"Transforms for structs and unions.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjRhhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](py attributeeh"]h$]h&]jZjlj[jmj\jmj]j^j_uh1jhhhjphjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ?var_xforms (lib.python.kdoc.xforms_lists.CTransforms attribute)3lib.python.kdoc.xforms_lists.CTransforms.var_xformshNtauh1hhjphhh@docstring of lib.python.kdoc.xforms_lists.CTransforms.var_xformshNubj)}(hhh](j)}(hCTransforms.var_xformsh](jN)}(h var_xformsh]h var_xforms}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_lists.CTransforms.var_xformshKubj)}(hX [(CMatch("^__read_mostly\b"), ''), (CMatch("^__ro_after_init\b"), ''), (CMatch("^__guarded_by\b"), ''), (CMatch("^__pt_guarded_by\b"), ''), (CMatch("^LIST_HEAD\b"), 'struct list_head \\1'), (KernRe("(?://.*)$" ), ''), (KernRe("(?:/\*.*\*/)" ), ''), (KernRe(";$" ), '')]h](j$)}(h h]h }(hjhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjubj)}(h=h]h=}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj$)}(h h]h }(hjhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjubhX [(CMatch("^__read_mostly\b"), ''), (CMatch("^__ro_after_init\b"), ''), (CMatch("^__guarded_by\b"), ''), (CMatch("^__pt_guarded_by\b"), ''), (CMatch("^LIST_HEAD\b"), 'struct list_head \\1'), (KernRe("(?://.*)$" ), ''), (KernRe("(?:/\*.*\*/)" ), ''), (KernRe(";$" ), '')]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]j}ah ](jbjceh"]h$]h&]jglib.python.kdoc.xforms_listsjijQjjCTransforms.var_xformsjkj CTransforms var_xformsjmjuh1jhjhKhjhhubjo)}(hhh]jt)}(h#Transforms for variable prototypes.h]h#Transforms for variable prototypes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](py attributeeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjphjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ;xforms (lib.python.kdoc.xforms_lists.CTransforms attribute)/lib.python.kdoc.xforms_lists.CTransforms.xformshNtauh1hhjphhh, >]h](hclass}(hjhhhNhNubj$)}(h h]h }(hjhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.GlobSourceFileshKubj<)}(hlib.python.kdoc.kdoc_files.h]hlib.python.kdoc.kdoc_files.}(hjhhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hjhhhjhKubjN)}(hGlobSourceFilesh]hGlobSourceFiles}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhhjhKubj)}(h#srctree=None, valid_extensions=Noneh](j)}(h srctree=Noneh](j)}(hsrctreeh]hsrctree}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubhdesc_sig_operator)}(h=h]h=}(hj)hhhNhNubah}(h]h ]oah"]h$]h&]uh1j'hjubhinline)}(hNoneh]hNone}(hj:hhhNhNubah}(h]h ] default_valueah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hvalid_extensions=Noneh](j)}(hvalid_extensionsh]hvalid_extensions}(hjThhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjPubj()}(h=h]h=}(hjbhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjPubj9)}(hNoneh]hNone}(hjphhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjPubeh}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjihjjjjkjjjmjuh1jhjhKhjhhubjo)}(hhh](jt)}(hBases: :py:class:`object`h](hBases: }(hjhhhNhNubh)}(h:py:class:`object`h]j)}(hjh]hobject}(hjhhhNhNubah}(h]h ](jpypy-classeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypeclass refexplicitrefwarnjjjjjobjectuh1hhx/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_fileshKhjubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.GlobSourceFileshKhjhhubjt)}(hAParse C source code file names and directories via an Interactor.h]hAParse C source code file names and directories via an Interactor.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.GlobSourceFileshKhjhhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Aparse_files() (lib.python.kdoc.kdoc_files.GlobSourceFiles method)6lib.python.kdoc.kdoc_files.GlobSourceFiles.parse_fileshNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.GlobSourceFiles.parse_fileshNubj)}(hhh](j)}(h9GlobSourceFiles.parse_files(file_list, file_not_found_cb)h](jN)}(h parse_filesh]h parse_files}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.GlobSourceFiles.parse_fileshKubj)}(hfile_list, file_not_found_cbh](j)}(h file_listh]j)}(h file_listh]h file_list}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hfile_not_found_cbh]j)}(hfile_not_found_cbh]hfile_not_found_cb}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjijjjGlobSourceFiles.parse_filesjkj:GlobSourceFiles parse_filesjmGlobSourceFiles.parse_files()uh1jhjhKhjhhubjo)}(hhh]jt)}(hYDefine an iterator to parse all source files from file_list, handling directories if any.h]hYDefine an iterator to parse all source files from file_list, handling directories if any.}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhj@hhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZjZj[j[j\j[j]j^j_uh1jhhhjhjhNubeh}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pyclasseh"]h$]h&]jZjhj[jij\jij]j^j_uh1jhhhjhNhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 0KdocConfig (class in lib.python.kdoc.kdoc_files)%lib.python.kdoc.kdoc_files.KdocConfighNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KdocConfighNubj)}(hhh](j)}(hwKdocConfig(verbose=False, werror=False, wreturn=False, wshort_desc=False, wcontents_before_sections=False, logger=None)h](j)}(h2[<#text: 'class'>, >]h](hclass}(hjhhhNhNubj$)}(h h]h }(hjhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KdocConfighKubj<)}(hlib.python.kdoc.kdoc_files.h]hlib.python.kdoc.kdoc_files.}(hjhhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hjhhhjhKubjN)}(h KdocConfigh]h KdocConfig}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhhjhKubj)}(hkverbose=False, werror=False, wreturn=False, wshort_desc=False, wcontents_before_sections=False, logger=Noneh](j)}(h verbose=Falseh](j)}(hverboseh]hverbose}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hFalseh]hFalse}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h werror=Falseh](j)}(hwerrorh]hwerror}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hFalseh]hFalse}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h wreturn=Falseh](j)}(hwreturnh]hwreturn}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubj()}(h=h]h=}(hj<hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj*ubj9)}(hFalseh]hFalse}(hjJhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj*ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hwshort_desc=Falseh](j)}(h wshort_desch]h wshort_desc}(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_ubj()}(h=h]h=}(hjqhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj_ubj9)}(hFalseh]hFalse}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj_ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hwcontents_before_sections=Falseh](j)}(hwcontents_before_sectionsh]hwcontents_before_sections}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hFalseh]hFalse}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h logger=Noneh](j)}(hloggerh]hlogger}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hNoneh]hNone}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jyah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjihjjjjkj jjmjuh1jhjhKhj|hhubjo)}(hhh](jt)}(hBases: :py:class:`object`h](hBases: }(hjhhhNhNubh)}(h:py:class:`object`h]j)}(hjh]hobject}(hjhhhNhNubah}(h]h ](jpypy-classeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainj%reftypeclass refexplicitrefwarnjj jjjobjectuh1hhjhKhjubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KdocConfighKhj hhubjt)}(hKStores all configuration attributes that kdoc_parser and kdoc_output needs.h]hKStores all configuration attributes that kdoc_parser and kdoc_output needs.}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj{hKhj hhubeh}(h]h ]h"]h$]h&]uh1jnhj|hhhjhKubeh}(h]h ](pyclasseh"]h$]h&]jZjUj[jVj\jVj]j^j_uh1jhhhjhj{hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 1KernelFiles (class in lib.python.kdoc.kdoc_files)&lib.python.kdoc.kdoc_files.KernelFileshNtauh1hhjhhhNhNubj)}(hhh](j)}(hKernelFiles(verbose=False, out_style=None, xforms=None, werror=False, wreturn=False, wshort_desc=False, wcontents_before_sections=False, yaml_file=None, yaml_content=None, logger=None)h](j)}(h2[<#text: 'class'>, >]h](hclass}(hjohhhNhNubj$)}(h h]h }(hjwhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjoubeh}(h]h ]h"]h$]h&]hhuh1jhjkhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFileshKubj<)}(hlib.python.kdoc.kdoc_files.h]hlib.python.kdoc.kdoc_files.}(hjhhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hjkhhhjhKubjN)}(h KernelFilesh]h KernelFiles}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjkhhhjhKubj)}(hverbose=False, out_style=None, xforms=None, werror=False, wreturn=False, wshort_desc=False, wcontents_before_sections=False, yaml_file=None, yaml_content=None, logger=Noneh](j)}(h verbose=Falseh](j)}(hverboseh]hverbose}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hFalseh]hFalse}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hout_style=Noneh](j)}(h out_styleh]h out_style}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hNoneh]hNone}(hj hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h xforms=Noneh](j)}(hxformsh]hxforms}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj()}(h=h]h=}(hj( hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj ubj9)}(hNoneh]hNone}(hj6 hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h werror=Falseh](j)}(hwerrorh]hwerror}(hjO hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjK ubj()}(h=h]h=}(hj] hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjK ubj9)}(hFalseh]hFalse}(hjk hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjK ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h wreturn=Falseh](j)}(hwreturnh]hwreturn}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj()}(h=h]h=}(hj hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj ubj9)}(hFalseh]hFalse}(hj hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hwshort_desc=Falseh](j)}(h wshort_desch]h wshort_desc}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj()}(h=h]h=}(hj hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj ubj9)}(hFalseh]hFalse}(hj hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hwcontents_before_sections=Falseh](j)}(hwcontents_before_sectionsh]hwcontents_before_sections}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj()}(h=h]h=}(hj hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj ubj9)}(hFalseh]hFalse}(hj hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hyaml_file=Noneh](j)}(h yaml_fileh]h yaml_file}(hj# hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj()}(h=h]h=}(hj1 hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj ubj9)}(hNoneh]hNone}(hj? hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hyaml_content=Noneh](j)}(h yaml_contenth]h yaml_content}(hjX hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjT ubj()}(h=h]h=}(hjf hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjT ubj9)}(hNoneh]hNone}(hjt hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjT ubeh}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h logger=Noneh](j)}(hloggerh]hlogger}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj()}(h=h]h=}(hj hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj ubj9)}(hNoneh]hNone}(hj hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj ubeh}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjkhhhjhKubeh}(h]jfah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjihjjjjkj jjmjuh1jhjhKhjhhhubjo)}(hhh](jt)}(hBases: :py:class:`object`h](hBases: }(hj hhhNhNubh)}(h:py:class:`object`h]j)}(hj h]hobject}(hj hhhNhNubah}(h]h ](jpypy-classeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftypeclass refexplicitrefwarnjj jjjobjectuh1hhjhKhj ubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFileshKhj hhubjt)}(h6Parse kernel-doc tags on multiple kernel source files.h]h6Parse kernel-doc tags on multiple kernel source files.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFileshKhj hhubjt)}(hoThis is the main entry point to run kernel-doc. This class is initialized using a series of optional arguments:h]hoThis is the main entry point to run kernel-doc. This class is initialized using a series of optional arguments:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhj hhubhdefinition_list)}(hhh](hdefinition_list_item)}(hC``verbose`` If True, enables kernel-doc verbosity. Default: False. h](hterm)}(h ``verbose``h]j)}(hj* h]hverbose}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj( ubah}(h]h ]h"]h$]h&]uh1j& hj hKhj" ubh definition)}(hhh]jt)}(h6If True, enables kernel-doc verbosity. Default: False.h]h6If True, enables kernel-doc verbosity. Default: False.}(hjD hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhjA ubah}(h]h ]h"]h$]h&]uh1j? hj" ubeh}(h]h ]h"]h$]h&]uh1j hj hKhj ubj! )}(hX``out_style`` Class to be used to format output. If None (default), only report errors. h](j' )}(h ``out_style``h]j)}(hjd h]h out_style}(hjf hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjb ubah}(h]h ]h"]h$]h&]uh1j& hj hK hj^ ubj@ )}(hhh]jt)}(hIClass to be used to format output. If None (default), only report errors.h]hIClass to be used to format output. If None (default), only report errors.}(hj| hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hK hjy ubah}(h]h ]h"]h$]h&]uh1j? hj^ ubeh}(h]h ]h"]h$]h&]uh1j hj hK hj hhubj! )}(hy``xforms`` Transforms to be applied to C prototypes and data structs. If not specified, defaults to xforms = CFunction() h](j' )}(h ``xforms``h]j)}(hj h]hxforms}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j& hj hKhj ubj@ )}(hhh]jt)}(hmTransforms to be applied to C prototypes and data structs. If not specified, defaults to xforms = CFunction()h]hmTransforms to be applied to C prototypes and data structs. If not specified, defaults to xforms = CFunction()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhj ubah}(h]h ]h"]h$]h&]uh1j? hj ubeh}(h]h ]h"]h$]h&]uh1j hj hKhj hhubj! )}(hc``werror`` If True, treat warnings as errors, retuning an error code on warnings. Default: False. h](j' )}(h ``werror``h]j)}(hj h]hwerror}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j& hj hKhj ubj@ )}(hhh](jt)}(hFIf True, treat warnings as errors, retuning an error code on warnings.h]hFIf True, treat warnings as errors, retuning an error code on warnings.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhj ubjt)}(hDefault: False.h]hDefault: False.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhj ubeh}(h]h ]h"]h$]h&]uh1j? hj ubeh}(h]h ]h"]h$]h&]uh1j hj hKhj hhubj! )}(h[``wreturn`` If True, warns about the lack of a return markup on functions. Default: False.h](j' )}(h ``wreturn``h]j)}(hj h]hwreturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j& hj hKhj ubj@ )}(hhh](jt)}(h>If True, warns about the lack of a return markup on functions.h]h>If True, warns about the lack of a return markup on functions.}(hj2 hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhj/ ubjt)}(hDefault: False.h]hDefault: False.}(hj@ hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhj/ ubeh}(h]h ]h"]h$]h&]uh1j? hj ubeh}(h]h ]h"]h$]h&]uh1j hj hKhj hhubj! )}(hY``wshort_desc`` If True, warns if initial short description is missing. Default: False. h](j' )}(h``wshort_desc``h]j)}(hj` h]h wshort_desc}(hjb hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ ubah}(h]h ]h"]h$]h&]uh1j& hj hKhjZ ubj@ )}(hhh](jt)}(h7If True, warns if initial short description is missing.h]h7If True, warns if initial short description is missing.}(hjx hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhju ubjt)}(hDefault: False.h]hDefault: False.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hKhju ubeh}(h]h ]h"]h$]h&]uh1j? hjZ ubeh}(h]h ]h"]h$]h&]uh1j hj hKhj hhubj! )}(h``wcontents_before_sections`` If True, warn if there are contents before sections (deprecated). This option is kept just for backward-compatibility, but it does nothing, neither here nor at the original Perl script. Default: False. h](j' )}(h``wcontents_before_sections``h]j)}(hj h]hwcontents_before_sections}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j& hj hK$hj ubj@ )}(hhh](jt)}(hIf True, warn if there are contents before sections (deprecated). This option is kept just for backward-compatibility, but it does nothing, neither here nor at the original Perl script.h]hIf True, warn if there are contents before sections (deprecated). This option is kept just for backward-compatibility, but it does nothing, neither here nor at the original Perl script.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hK hj ubjt)}(hDefault: False.h]hDefault: False.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hK$hj ubeh}(h]h ]h"]h$]h&]uh1j? hj ubeh}(h]h ]h"]h$]h&]uh1j hj hK$hj hhubj! )}(hs``logger`` Optional logger class instance. If not specified, defaults to use: ``logging.getLogger("kernel-doc")`` h](j' )}(h ``logger``h]j)}(hj h]hlogger}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1j& hj hK)hj ubj@ )}(hhh](jt)}(hOptional logger class instance.h]hOptional logger class instance.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hK'hj ubjt)}(hFIf not specified, defaults to use: ``logging.getLogger("kernel-doc")``h](h#If not specified, defaults to use: }(hj hhhNhNubj)}(h#``logging.getLogger("kernel-doc")``h]hlogging.getLogger("kernel-doc")}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jshj hK)hj ubeh}(h]h ]h"]h$]h&]uh1j? hj ubeh}(h]h ]h"]h$]h&]uh1j hj hK)hj hhubj! )}(h@``yaml_file`` If defined, stores the output inside a YAML file. h](j' )}(h ``yaml_file``h]j)}(hj@ h]h yaml_file}(hjB hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj> ubah}(h]h ]h"]h$]h&]uh1j& hj hK,hj: ubj@ )}(hhh]jt)}(h1If defined, stores the output inside a YAML file.h]h1If defined, stores the output inside a YAML file.}(hjX hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hK,hjU ubah}(h]h ]h"]h$]h&]uh1j? hj: ubeh}(h]h ]h"]h$]h&]uh1j hj hK,hj hhubj! )}(h<``yaml_content`` Defines what will be inside the YAML file. h](j' )}(h``yaml_content``h]j)}(hjx h]h yaml_content}(hjz hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjv ubah}(h]h ]h"]h$]h&]uh1j& hj hK/hjr ubj@ )}(hhh]jt)}(h*Defines what will be inside the YAML file.h]h*Defines what will be inside the YAML file.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hK/hj ubah}(h]h ]h"]h$]h&]uh1j? hjr ubeh}(h]h ]h"]h$]h&]uh1j hj hK/hj hhubj! )}(hNote: There are two type of parsers defined here: - self.parse_file(): parses both kernel-doc markups and ``EXPORT_SYMBOL*`` macros; - self.process_export_file(): parses only ``EXPORT_SYMBOL*`` macros. h](j' )}(hNote:h]hNote:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j& hj hK7hj ubj@ )}(hhh](jt)}(h+There are two type of parsers defined here:h]h+There are two type of parsers defined here:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj hK2hj ubh bullet_list)}(hhh](h list_item)}(hPself.parse_file(): parses both kernel-doc markups and ``EXPORT_SYMBOL*`` macros;h]jt)}(hPself.parse_file(): parses both kernel-doc markups and ``EXPORT_SYMBOL*`` macros;h](h6self.parse_file(): parses both kernel-doc markups and }(hj hhhNhNubj)}(h``EXPORT_SYMBOL*``h]hEXPORT_SYMBOL*}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh macros;}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jshj hK4hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hDself.process_export_file(): parses only ``EXPORT_SYMBOL*`` macros. h]jt)}(hBself.process_export_file(): parses only ``EXPORT_SYMBOL*`` macros.h](h(self.process_export_file(): parses only }(hjhhhNhNubj)}(h``EXPORT_SYMBOL*``h]hEXPORT_SYMBOL*}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh macros.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jshj hK6hj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]bullet-uh1j hj hK4hj ubeh}(h]h ]h"]h$]h&]uh1j? hj ubeh}(h]h ]h"]h$]h&]uh1j hj hK7hj hhubeh}(h]h ]h"]h$]h&]uh1j hj hhhj hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 7error() (lib.python.kdoc.kdoc_files.KernelFiles method),lib.python.kdoc.kdoc_files.KernelFiles.errorhNtauh1hhj hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.errorhNubj)}(hhh](j)}(hKernelFiles.error(msg)h](jN)}(herrorh]herror}(hjXhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjThhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.errorhKubj)}(hmsgh]j)}(hmsgh]j)}(hmsgh]hmsg}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]hhuh1jhjgubah}(h]h ]h"]h$]h&]hhuh1jhjThhhjfhKubeh}(h]jNah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjijjjKernelFiles.errorjkj KernelFileserrorjmKernelFiles.error()uh1jhjfhKhjQhhubjo)}(hhh]jt)}(h?Ancillary routine to output an error and increment error count.h]h?Ancillary routine to output an error and increment error count.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjPhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjQhhhjfhKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhj hjPhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Cfile_not_found_cb() (lib.python.kdoc.kdoc_files.KernelFiles method)8lib.python.kdoc.kdoc_files.KernelFiles.file_not_found_cbhNtauh1hhj hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.file_not_found_cbhNubj)}(hhh](j)}(h$KernelFiles.file_not_found_cb(fname)h](jN)}(hfile_not_found_cbh]hfile_not_found_cb}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.file_not_found_cbhKubj)}(hfnameh]j)}(hfnameh]j)}(hfnameh]hfname}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjijjjKernelFiles.file_not_found_cbjkj KernelFilesfile_not_found_cbjmKernelFiles.file_not_found_cb()uh1jhjhKhjhhubjo)}(hhh]jt)}(h)Callback to warn if a file was not found.h]h)Callback to warn if a file was not found.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZj!j[j"j\j"j]j^j_uh1jhhhj hjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 5msg() (lib.python.kdoc.kdoc_files.KernelFiles method)*lib.python.kdoc.kdoc_files.KernelFiles.msghNtauh1hhj hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.msghNubj)}(hhh](j)}(hKernelFiles.msg(enable_lineno=False, export=False, internal=False, symbol=None, nosymbol=None, no_doc_sections=False, filenames=None, export_file=None)h](jN)}(hmsgh]hmsg}(hj<hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj8hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.msghKubj)}(henable_lineno=False, export=False, internal=False, symbol=None, nosymbol=None, no_doc_sections=False, filenames=None, export_file=Noneh](j)}(henable_lineno=Falseh](j)}(h enable_linenoh]h enable_lineno}(hjShhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjOubj()}(h=h]h=}(hjahhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjOubj9)}(hFalseh]hFalse}(hjohhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjOubeh}(h]h ]h"]h$]h&]hhuh1jhjKubj)}(h export=Falseh](j)}(hexporth]hexport}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hFalseh]hFalse}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjKubj)}(hinternal=Falseh](j)}(hinternalh]hinternal}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hFalseh]hFalse}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjKubj)}(h symbol=Noneh](j)}(hsymbolh]hsymbol}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hNoneh]hNone}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjKubj)}(h nosymbol=Noneh](j)}(hnosymbolh]hnosymbol}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubj()}(h=h]h=}(hj5hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj#ubj9)}(hNoneh]hNone}(hjChhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj#ubeh}(h]h ]h"]h$]h&]hhuh1jhjKubj)}(hno_doc_sections=Falseh](j)}(hno_doc_sectionsh]hno_doc_sections}(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubj()}(h=h]h=}(hjjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjXubj9)}(hFalseh]hFalse}(hjxhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjXubeh}(h]h ]h"]h$]h&]hhuh1jhjKubj)}(hfilenames=Noneh](j)}(h filenamesh]h filenames}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hNoneh]hNone}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjKubj)}(hexport_file=Noneh](j)}(h export_fileh]h export_file}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hNoneh]hNone}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjKubeh}(h]h ]h"]h$]h&]hhuh1jhj8hhhjJhKubeh}(h]j2ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjijjjKernelFiles.msgjkj KernelFilesmsgjmKernelFiles.msg()uh1jhjJhKhj5hhubjo)}(hhh]jt)}(hlInteracts over the kernel-doc results and output messages, returning kernel-doc markups on each interaction.h]hlInteracts over the kernel-doc results and output messages, returning kernel-doc markups on each interaction.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj4hKhj hhubah}(h]h ]h"]h$]h&]uh1jnhj5hhhjJhKubeh}(h]h ](pymethodeh"]h$]h&]jZj#j[j$j\j$j]j^j_uh1jhhhj hj4hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9out_msg() (lib.python.kdoc.kdoc_files.KernelFiles method).lib.python.kdoc.kdoc_files.KernelFiles.out_msghNtauh1hhj hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.out_msghNubj)}(hhh](j)}(h%KernelFiles.out_msg(fname, name, arg)h](jN)}(hout_msgh]hout_msg}(hj>hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj:hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.out_msghKubj)}(hfname, name, argh](j)}(hfnameh]j)}(hfnameh]hfname}(hjUhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]hhuh1jhjMubj)}(hnameh]j)}(hnameh]hname}(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubah}(h]h ]h"]h$]h&]hhuh1jhjMubj)}(hargh]j)}(hargh]harg}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjMubeh}(h]h ]h"]h$]h&]hhuh1jhj:hhhjLhKubeh}(h]j4ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjijjjKernelFiles.out_msgjkj KernelFilesout_msgjmKernelFiles.out_msg()uh1jhjLhKhj7hhubjo)}(hhh](jt)}(hIReturn output messages from a file name using the output style filtering.h]hIReturn output messages from a file name using the output style filtering.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshj6hKhjhhubjt)}(h:If output type was not handled by the styler, return None.h]h:If output type was not handled by the styler, return None.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshj6hKhjhhubeh}(h]h ]h"]h$]h&]uh1jnhj7hhhjLhKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhj hj6hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 7parse() (lib.python.kdoc.kdoc_files.KernelFiles method),lib.python.kdoc.kdoc_files.KernelFiles.parsehNtauh1hhj hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.parsehNubj)}(hhh](j)}(h.KernelFiles.parse(file_list, export_file=None)h](jN)}(hparseh]hparse}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.parsehKubj)}(hfile_list, export_file=Noneh](j)}(h file_listh]j)}(h file_listh]h file_list}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hexport_file=Noneh](j)}(h export_fileh]h export_file}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hj+hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hNoneh]hNone}(hj9hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjijjjKernelFiles.parsejkjZ KernelFilesparsejmKernelFiles.parse()uh1jhjhKhjhhubjo)}(hhh]jt)}(hParse all files.h]hParse all files.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhj`hhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZjzj[j{j\j{j]j^j_uh1jhhhj hjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j  KernelFilesprocess_export_filejm!KernelFiles.process_export_file()uh1jhjhKhjhhubjo)}(hhh]jt)}(hBParses ``EXPORT_SYMBOL*`` macros from a single Kernel source file.h](hParses }(hjGhhhNhNubj)}(h``EXPORT_SYMBOL*``h]hEXPORT_SYMBOL*}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGubh) macros from a single Kernel source file.}(hjGhhhNhNubeh}(h]h ]h"]h$]h&]uh1jshjhKhjDhhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZjpj[jqj\jqj]j^j_uh1jhhhj hjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9warning() (lib.python.kdoc.kdoc_files.KernelFiles method).lib.python.kdoc.kdoc_files.KernelFiles.warninghNtauh1hhj hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.warninghNubj)}(hhh](j)}(hKernelFiles.warning(msg)h](jN)}(hwarningh]hwarning}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_files.KernelFiles.warninghKubj)}(hmsgh]j)}(hmsgh]j)}(hmsgh]hmsg}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_filesjijjjKernelFiles.warningjkj KernelFileswarningjmKernelFiles.warning()uh1jhjhKhjhhubjo)}(hhh]jt)}(h@Ancillary routine to output a warning and increment error count.h]h@Ancillary routine to output a warning and increment error count.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhj hjhNubeh}(h]h ]h"]h$]h&]uh1jnhjhhhhjhKubeh}(h]h ](pyclasseh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhNhNubeh}(h](jfile-handler-classeseh ]h"]file handler classesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hParsed item data classh]hParsed item data class}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hhh]h}(h]h ]h"]h$]h&]entries](h!module; lib.python.kdoc.kdoc_item module-lib.python.kdoc.kdoc_itemhNtauh1hhjhhhv/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_itemhNubjt)}(h&Data class to store a kernel-doc Item.h]h&Data class to store a kernel-doc Item.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjhhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j -KdocItem (class in lib.python.kdoc.kdoc_item)"lib.python.kdoc.kdoc_item.KdocItemhNtauh1hhjhhhNhNubj)}(hhh](j)}(h6KdocItem(name, fname, type, start_line, **other_stuff)h](j)}(h2[<#text: 'class'>, >]h](hclass}(hj@hhhNhNubj$)}(h h]h }(hjHhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj@ubeh}(h]h ]h"]h$]h&]hhuh1jhj<hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItemhKubj<)}(hlib.python.kdoc.kdoc_item.h]hlib.python.kdoc.kdoc_item.}(hj]hhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hj<hhhj\hKubjN)}(hKdocItemh]hKdocItem}(hjkhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj<hhhj\hKubj)}(h,name, fname, type, start_line, **other_stuffh](j)}(hnameh]j)}(hnameh]hname}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&]hhuh1jhjyubj)}(hfnameh]j)}(hfnameh]hfname}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjyubj)}(htypeh]j)}(htypeh]htype}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjyubj)}(h start_lineh]j)}(h start_lineh]h start_line}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjyubj)}(h **other_stuffh](j()}(h**h]h**}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj)}(h other_stuffh]h other_stuff}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjyubeh}(h]h ]h"]h$]h&]hhuh1jhj<hhhj\hKubeh}(h]j7ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_itemjihjjjmjkjjmjmjmuh1jhj\hKhj9hhubjo)}(hhh](jt)}(hBases: :py:class:`object`h](hBases: }(hjhhhNhNubh)}(h:py:class:`object`h]j)}(hjh]hobject}(hj hhhNhNubah}(h]h ](jpypy-classeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainj*reftypeclass refexplicitrefwarnjjjjmjobjectuh1hhv/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_itemhKhjubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItemhKhjhhubjt)}(hlA class that will, eventually, encapsulate all of the parsed data that we then pass into the output modules.h]hlA class that will, eventually, encapsulate all of the parsed data that we then pass into the output modules.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItemhKhjhhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j =from_dict() (lib.python.kdoc.kdoc_item.KdocItem class method),lib.python.kdoc.kdoc_item.KdocItem.from_dicthNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItem.from_dicthNubj)}(hhh](j)}(hKdocItem.from_dict(d)h](j)}(h8[<#text: 'classmethod'>, >]h](h classmethod}(hjihhhNhNubj$)}(h h]h }(hjqhhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjiubeh}(h]h ]h"]h$]h&]hhuh1jhjehhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItem.from_dicthKubjN)}(h from_dicth]h from_dict}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjehhhjhKubj)}(hdh]j)}(hdh]j)}(hdh]hd}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjehhhjhKubeh}(h]j_ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_itemjijmjjKdocItem.from_dictjkjKdocItem from_dictjmKdocItem.from_dict()uh1jhjhKhjbhhubjo)}(hhh]jt)}(h$Create a KdocItem from a plain dict.h]h$Create a KdocItem from a plain dict.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjahKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjbhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhjahNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 1get() (lib.python.kdoc.kdoc_item.KdocItem method)&lib.python.kdoc.kdoc_item.KdocItem.gethNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItem.gethNubj)}(hhh](j)}(hKdocItem.get(key, default=None)h](jN)}(hgeth]hget}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItem.gethKubj)}(hkey, default=Noneh](j)}(hkeyh]j)}(hkeyh]hkey}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h default=Noneh](j)}(hdefaulth]hdefault}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubj()}(h=h]h=}(hj4hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj"ubj9)}(hNoneh]hNone}(hjBhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj"ubeh}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_itemjijmjj KdocItem.getjkjcKdocItemgetjmKdocItem.get()uh1jhjhKhjhhubjo)}(hhh]jt)}(hGet a value from optional keys.h]hGet a value from optional keys.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjihhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 8set_params() (lib.python.kdoc.kdoc_item.KdocItem method)-lib.python.kdoc.kdoc_item.KdocItem.set_paramshNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItem.set_paramshNubj)}(hhh](j)}(h0KdocItem.set_params(names, descs, types, starts)h](jN)}(h set_paramsh]h set_params}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItem.set_paramshKubj)}(hnames, descs, types, startsh](j)}(hnamesh]j)}(hnamesh]hnames}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hdescsh]j)}(hdescsh]hdescs}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(htypesh]j)}(htypesh]htypes}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hstartsh]j)}(hstartsh]hstarts}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_itemjijmjjKdocItem.set_paramsjkjKdocItem set_paramsjmKdocItem.set_params()uh1jhjhKhjhhubjo)}(hhh]jt)}(h?Set parameter list: names, descriptions, types and start lines.h]h?Set parameter list: names, descriptions, types and start lines.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhj#hhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZj=j[j>j\j>j]j^j_uh1jhhhjhjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j :set_sections() (lib.python.kdoc.kdoc_item.KdocItem method)/lib.python.kdoc.kdoc_item.KdocItem.set_sectionshNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItem.set_sectionshNubj)}(hhh](j)}(h,KdocItem.set_sections(sections, start_lines)h](jN)}(h set_sectionsh]h set_sections}(hjXhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjThhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_item.KdocItem.set_sectionshKubj)}(hsections, start_linesh](j)}(hsectionsh]j)}(hsectionsh]hsections}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]hhuh1jhjgubj)}(h start_linesh]j)}(h start_linesh]h start_lines}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjgubeh}(h]h ]h"]h$]h&]hhuh1jhjThhhjfhKubeh}(h]jNah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_itemjijmjjKdocItem.set_sectionsjkjKdocItem set_sectionsjmKdocItem.set_sections()uh1jhjfhKhjQhhubjo)}(hhh]jt)}(hSet sections and start lines.h]hSet sections and start lines.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjPhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjQhhhjfhKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhjPhNubeh}(h]h ]h"]h$]h&]uh1jnhj9hhhj\hKubeh}(h]h ](pyclasseh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhNhNubeh}(h](jparsed-item-data-classeh ]h"]parsed item data classah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hParser classes and methodsh]hParser classes and methods}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK ubh)}(hhh]h}(h]h ]h"]h$]h&]entries](h#module; lib.python.kdoc.kdoc_parser"module-lib.python.kdoc.kdoc_parserhNtauh1hhjhhhz/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parserhNubjt)}(hClasses and functions related to reading a C language source or header FILE and extract embedded documentation comments from it.h]hClasses and functions related to reading a C language source or header FILE and extract embedded documentation comments from it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjhhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 0KernelDoc (class in lib.python.kdoc.kdoc_parser)%lib.python.kdoc.kdoc_parser.KernelDochNtauh1hhjhhhNhNubj)}(hhh](j)}(h1KernelDoc(config, fname, xforms, store_src=False)h](j)}(h2[<#text: 'class'>, >]h](hclass}(hj%hhhNhNubj$)}(h h]h }(hj-hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj%ubeh}(h]h ]h"]h$]h&]hhuh1jhj!hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDochKubj<)}(hlib.python.kdoc.kdoc_parser.h]hlib.python.kdoc.kdoc_parser.}(hjBhhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hj!hhhjAhKubjN)}(h KernelDoch]h KernelDoc}(hjPhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj!hhhjAhKubj)}(h&config, fname, xforms, store_src=Falseh](j)}(hconfigh]j)}(hconfigh]hconfig}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]hhuh1jhj^ubj)}(hfnameh]j)}(hfnameh]hfname}(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]hhuh1jhj^ubj)}(hxformsh]j)}(hxformsh]hxforms}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhj^ubj)}(hstore_src=Falseh](j)}(h store_srch]h store_src}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj()}(h=h]h=}(hjhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjubj9)}(hFalseh]hFalse}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjubeh}(h]h ]h"]h$]h&]hhuh1jhj^ubeh}(h]h ]h"]h$]h&]hhuh1jhj!hhhjAhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjihjjjRjkjjRjmjRuh1jhjAhKhjhhubjo)}(hhh](jt)}(hBases: :py:class:`object`h](hBases: }(hjhhhNhNubh)}(h:py:class:`object`h]j)}(hjh]hobject}(hjhhhNhNubah}(h]h ](jpypy-classeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypeclass refexplicitrefwarnjjjjRjobjectuh1hhz/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parserhKhjubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDochKhjhhubjt)}(hTRead a C language source or header FILE and extract embedded documentation comments.h]hTRead a C language source or header FILE and extract embedded documentation comments.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDochKhjhhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Echeck_return_section() (lib.python.kdoc.kdoc_parser.KernelDoc method):lib.python.kdoc.kdoc_parser.KernelDoc.check_return_sectionhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.check_return_sectionhNubj)}(hhh](j)}(hAKernelDoc.check_return_section(ln, declaration_name, return_type)h](jN)}(hcheck_return_sectionh]hcheck_return_section}(hjEhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjAhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.check_return_sectionhKubj)}(h!ln, declaration_name, return_typeh](j)}(hlnh]j)}(hlnh]hln}(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubah}(h]h ]h"]h$]h&]hhuh1jhjTubj)}(hdeclaration_nameh]j)}(hdeclaration_nameh]hdeclaration_name}(hjthhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]hhuh1jhjTubj)}(h return_typeh]j)}(h return_typeh]h return_type}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjTubeh}(h]h ]h"]h$]h&]hhuh1jhjAhhhjShKubeh}(h]j;ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.check_return_sectionjkj KernelDoccheck_return_sectionjm KernelDoc.check_return_section()uh1jhjShKhj>hhubjo)}(hhh]jt)}(hRIf the function doesn't return void, warns about the lack of a return description.h]hTIf the function doesn’t return void, warns about the lack of a return description.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshj=hKhjhhubah}(h]h ]h"]h$]h&]uh1jnhj>hhhjShKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhj=hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ?check_sections() (lib.python.kdoc.kdoc_parser.KernelDoc method)4lib.python.kdoc.kdoc_parser.KernelDoc.check_sectionshNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.check_sectionshNubj)}(hhh](j)}(h2KernelDoc.check_sections(ln, decl_name, decl_type)h](jN)}(hcheck_sectionsh]hcheck_sections}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.check_sectionshKubj)}(hln, decl_name, decl_typeh](j)}(hlnh]j)}(hlnh]hln}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h decl_nameh]j)}(h decl_nameh]h decl_name}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h decl_typeh]j)}(h decl_typeh]h decl_type}(hj.hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.check_sectionsjkjN KernelDoccheck_sectionsjmKernelDoc.check_sections()uh1jhjhKhjhhubjo)}(hhh]jt)}(hZCheck for errors inside sections, emitting warnings if not found parameters are described.h]hZCheck for errors inside sections, emitting warnings if not found parameters are described.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjThhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZjnj[joj\joj]j^j_uh1jhhhjhjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Fcreate_parameter_list() (lib.python.kdoc.kdoc_parser.KernelDoc method);lib.python.kdoc.kdoc_parser.KernelDoc.create_parameter_listhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.create_parameter_listhNubj)}(hhh](j)}(hPKernelDoc.create_parameter_list(ln, decl_type, args, splitter, declaration_name)h](jN)}(hcreate_parameter_listh]hcreate_parameter_list}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.create_parameter_listhKubj)}(h/ln, decl_type, args, splitter, declaration_nameh](j)}(hlnh]j)}(hlnh]hln}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h decl_typeh]j)}(h decl_typeh]h decl_type}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hargsh]j)}(hargsh]hargs}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hsplitterh]j)}(hsplitterh]hsplitter}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hdeclaration_nameh]j)}(hdeclaration_nameh]hdeclaration_name}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.create_parameter_listjkj  KernelDoccreate_parameter_listjm!KernelDoc.create_parameter_list()uh1jhjhKhjhhubjo)}(hhh]jt)}(h9Creates a list of parameters, storing them at self.entry.h]h9Creates a list of parameters, storing them at self.entry.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhj&hhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZj@j[jAj\jAj]j^j_uh1jhhhjhjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Adump_declaration() (lib.python.kdoc.kdoc_parser.KernelDoc method)6lib.python.kdoc.kdoc_parser.KernelDoc.dump_declarationhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_declarationhNubj)}(hhh](j)}(h1KernelDoc.dump_declaration(ln, prototype, source)h](jN)}(hdump_declarationh]hdump_declaration}(hj[hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjWhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_declarationhKubj)}(hln, prototype, sourceh](j)}(hlnh]j)}(hlnh]hln}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubah}(h]h ]h"]h$]h&]hhuh1jhjjubj)}(h prototypeh]j)}(h prototypeh]h prototype}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjjubj)}(hsourceh]j)}(hsourceh]hsource}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjjubeh}(h]h ]h"]h$]h&]hhuh1jhjWhhhjihKubeh}(h]jQah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.dump_declarationjkj KernelDocdump_declarationjmKernelDoc.dump_declaration()uh1jhjihKhjThhubjo)}(hhh]jt)}(h3Store a data declaration inside self.entries array.h]h3Store a data declaration inside self.entries array.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjShKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjThhhjihKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhjShNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j :dump_enum() (lib.python.kdoc.kdoc_parser.KernelDoc method)/lib.python.kdoc.kdoc_parser.KernelDoc.dump_enumhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_enumhNubj)}(hhh](j)}(h&KernelDoc.dump_enum(ln, proto, source)h](jN)}(h dump_enumh]h dump_enum}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_enumhKubj)}(hln, proto, sourceh](j)}(hlnh]j)}(hlnh]hln}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhj ubj)}(hprotoh]j)}(hprotoh]hproto}(hj,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]hhuh1jhj ubj)}(hsourceh]j)}(hsourceh]hsource}(hjDhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@ubah}(h]h ]h"]h$]h&]hhuh1jhj ubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhj hKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.dump_enumjkjd KernelDoc dump_enumjmKernelDoc.dump_enum()uh1jhj hKhjhhubjo)}(hhh]jt)}(h,Store an ``enum`` inside self.entries array.h](h Store an }(hjmhhhNhNubj)}(h``enum``h]henum}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubh inside self.entries array.}(hjmhhhNhNubeh}(h]h ]h"]h$]h&]uh1jshjhKhjjhhubah}(h]h ]h"]h$]h&]uh1jnhjhhhj hKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j >dump_function() (lib.python.kdoc.kdoc_parser.KernelDoc method)3lib.python.kdoc.kdoc_parser.KernelDoc.dump_functionhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_functionhNubj)}(hhh](j)}(h.KernelDoc.dump_function(ln, prototype, source)h](jN)}(h dump_functionh]h dump_function}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_functionhKubj)}(hln, prototype, sourceh](j)}(hlnh]j)}(hlnh]hln}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(h prototypeh]j)}(h prototypeh]h prototype}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubj)}(hsourceh]j)}(hsourceh]hsource}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhjhKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.dump_functionjkj KernelDoc dump_functionjmKernelDoc.dump_function()uh1jhjhKhjhhubjo)}(hhh]jt)}(h=Store a function or function macro inside self.entries array.h]h=Store a function or function macro inside self.entries array.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjhhhjhKubeh}(h]h ](pymethodeh"]h$]h&]jZj8j[j9j\j9j]j^j_uh1jhhhjhjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j =dump_section() (lib.python.kdoc.kdoc_parser.KernelDoc method)2lib.python.kdoc.kdoc_parser.KernelDoc.dump_sectionhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_sectionhNubj)}(hhh](j)}(h&KernelDoc.dump_section(start_new=True)h](jN)}(h dump_sectionh]h dump_section}(hjShhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjOhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_sectionhKubj)}(hstart_new=Trueh]j)}(hstart_new=Trueh](j)}(h start_newh]h start_new}(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjfubj()}(h=h]h=}(hjxhhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjfubj9)}(hTrueh]hTrue}(hjhhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjfubeh}(h]h ]h"]h$]h&]hhuh1jhjbubah}(h]h ]h"]h$]h&]hhuh1jhjOhhhjahKubeh}(h]jIah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.dump_sectionjkj KernelDoc dump_sectionjmKernelDoc.dump_section()uh1jhjahKhjLhhubjo)}(hhh]jt)}(hADump section contents to arrays/hashes intended for that purpose.h]hADump section contents to arrays/hashes intended for that purpose.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjKhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjLhhhjahKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhjKhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j j\j>j]j^j_uh1jhhhjhjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9dump_var() (lib.python.kdoc.kdoc_parser.KernelDoc method).lib.python.kdoc.kdoc_parser.KernelDoc.dump_varhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_varhNubj)}(hhh](j)}(h%KernelDoc.dump_var(ln, proto, source)h](jN)}(hdump_varh]hdump_var}(hjXhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjThhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.dump_varhKubj)}(hln, proto, sourceh](j)}(hlnh]j)}(hlnh]hln}(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjkubah}(h]h ]h"]h$]h&]hhuh1jhjgubj)}(hprotoh]j)}(hprotoh]hproto}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjgubj)}(hsourceh]j)}(hsourceh]hsource}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]hhuh1jhjgubeh}(h]h ]h"]h$]h&]hhuh1jhjThhhjfhKubeh}(h]jNah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.dump_varjkj KernelDocdump_varjmKernelDoc.dump_var()uh1jhjfhKhjQhhubjo)}(hhh]jt)}(h&Store variables that are part of kAPI.h]h&Store variables that are part of kAPI.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjPhKhjhhubah}(h]h ]h"]h$]h&]uh1jnhjQhhhjfhKubeh}(h]h ](pymethodeh"]h$]h&]jZjj[jj\jj]j^j_uh1jhhhjhjPhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9emit_msg() (lib.python.kdoc.kdoc_parser.KernelDoc method).lib.python.kdoc.kdoc_parser.KernelDoc.emit_msghNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.emit_msghNubj)}(hhh](j)}(h,KernelDoc.emit_msg(ln, msg, *, warning=True)h](jN)}(hemit_msgh]hemit_msg}(hjhhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.emit_msghKubj)}(hln, msg, *, warning=Trueh](j)}(hlnh]j)}(hlnh]hln}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]hhuh1jhj ubj)}(hmsgh]j)}(hmsgh]hmsg}(hj) hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj% ubah}(h]h ]h"]h$]h&]hhuh1jhj ubj)}(h*h]j()}(h*h]h*}(hjA hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj= ubah}(h]h ]h"]h$]h&]hhuh1jhj ubj)}(h warning=Trueh](j)}(hwarningh]hwarning}(hjY hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU ubj()}(h=h]h=}(hjg hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjU ubj9)}(hTrueh]hTrue}(hju hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjU ubeh}(h]h ]h"]h$]h&]hhuh1jhj ubeh}(h]h ]h"]h$]h&]hhuh1jhjhhhj hKubeh}(h]jah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.emit_msgjkj KernelDocemit_msgjmKernelDoc.emit_msg()uh1jhj hKhjhhubjo)}(hhh]jt)}(hEmit a messageh]hEmit a message}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhKhj hhubah}(h]h ]h"]h$]h&]uh1jnhjhhhj hKubeh}(h]h ](pymethodeh"]h$]h&]jZj j[j j\j j]j^j_uh1jhhhjhjhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Eemit_unused_warnings() (lib.python.kdoc.kdoc_parser.KernelDoc method):lib.python.kdoc.kdoc_parser.KernelDoc.emit_unused_warningshNtauh1hhjhhhNhNubj)}(hhh](j)}(h KernelDoc.emit_unused_warnings()h](jN)}(hemit_unused_warningsh]hemit_unused_warnings}(hj hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.emit_unused_warningshKubj)}(h()h]h}(h]h ]h"]h$]h&]hhuh1jhj hhhj hKubeh}(h]j ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.emit_unused_warningsjkj KernelDocemit_unused_warningsjm KernelDoc.emit_unused_warnings()uh1jhj hKhj hhubjo)}(hhh](jt)}(hWhen the parser fails to produce a valid entry, it places some warnings under `entry.warnings` that will be discarded when resetting the state.h](hNWhen the parser fails to produce a valid entry, it places some warnings under }(hj hhhNhNubhtitle_reference)}(h`entry.warnings`h]hentry.warnings}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1j!hj ubh1 that will be discarded when resetting the state.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.emit_unused_warningshKhj hhubjt)}(h(Ensure that those warnings are not lost.h]h(Ensure that those warnings are not lost.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj!hKhj hhubhnote)}(hXBecause we are calling `config.warning()` here, those warnings are not filtered by the `-W` parameters: they will all be produced even when `-Wreturn`, `-Wshort-desc`, and/or `-Wcontents-before-sections` are used. Allowing those warnings to be filtered is complex, because it would require storing them in a buffer and then filtering them during the output step of the code, depending on the selected symbols.h](jt)}(hBecause we are calling `config.warning()` here, those warnings are not filtered by the `-W` parameters: they will all be produced even when `-Wreturn`, `-Wshort-desc`, and/or `-Wcontents-before-sections` are used.h](hBecause we are calling }(hj/!hhhNhNubj!)}(h`config.warning()`h]hconfig.warning()}(hj7!hhhNhNubah}(h]h ]h"]h$]h&]uh1j!hj/!ubh. here, those warnings are not filtered by the }(hj/!hhhNhNubj!)}(h`-W`h]h-W}(hjI!hhhNhNubah}(h]h ]h"]h$]h&]uh1j!hj/!ubh1 parameters: they will all be produced even when }(hj/!hhhNhNubj!)}(h `-Wreturn`h]h-Wreturn}(hj[!hhhNhNubah}(h]h ]h"]h$]h&]uh1j!hj/!ubh, }(hj/!hhhNhNubj!)}(h`-Wshort-desc`h]h -Wshort-desc}(hjm!hhhNhNubah}(h]h ]h"]h$]h&]uh1j!hj/!ubh , and/or }(hj/!hhhNhNubj!)}(h`-Wcontents-before-sections`h]h-Wcontents-before-sections}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1j!hj/!ubh are used.}(hj/!hhhNhNubeh}(h]h ]h"]h$]h&]uh1jshj!hK hj+!ubjt)}(hAllowing those warnings to be filtered is complex, because it would require storing them in a buffer and then filtering them during the output step of the code, depending on the selected symbols.h]hAllowing those warnings to be filtered is complex, because it would require storing them in a buffer and then filtering them during the output step of the code, depending on the selected symbols.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj!hKhj+!ubeh}(h]h ]h"]h$]h&]uh1j)!hj hhhj!hNubeh}(h]h ]h"]h$]h&]uh1jnhj hhhj hKubeh}(h]h ](pymethodeh"]h$]h&]jZj!j[j!j\j!j]j^j_uh1jhhhjhNhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Cformat_struct_decl() (lib.python.kdoc.kdoc_parser.KernelDoc method)8lib.python.kdoc.kdoc_parser.KernelDoc.format_struct_declhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.format_struct_declhNubj)}(hhh](j)}(h)KernelDoc.format_struct_decl(declaration)h](jN)}(hformat_struct_declh]hformat_struct_decl}(hj!hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj!hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.format_struct_declhKubj)}(h declarationh]j)}(h declarationh]j)}(h declarationh]h declaration}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&]hhuh1jhj!ubah}(h]h ]h"]h$]h&]hhuh1jhj!hhhj!hKubeh}(h]j!ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.format_struct_decljkj" KernelDocformat_struct_decljmKernelDoc.format_struct_decl()uh1jhj!hKhj!hhubjo)}(hhh]jt)}(h[Format the ``struct`` declaration into a standard form for inclusion in the resulting docs.h](h Format the }(hj"hhhNhNubj)}(h ``struct``h]hstruct}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubhF declaration into a standard form for inclusion in the resulting docs.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1jshj!hKhj "hhubah}(h]h ]h"]h$]h&]uh1jnhj!hhhj!hKubeh}(h]h ](pymethodeh"]h$]h&]jZj8"j[j9"j\j9"j]j^j_uh1jhhhjhj!hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ?is_comment_end() (lib.python.kdoc.kdoc_parser.KernelDoc method)4lib.python.kdoc.kdoc_parser.KernelDoc.is_comment_endhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.is_comment_endhNubj)}(hhh](j)}(h"KernelDoc.is_comment_end(ln, line)h](jN)}(his_comment_endh]his_comment_end}(hjS"hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjO"hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.is_comment_endhKubj)}(hln, lineh](j)}(hlnh]j)}(hlnh]hln}(hjj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjf"ubah}(h]h ]h"]h$]h&]hhuh1jhjb"ubj)}(hlineh]j)}(hlineh]hline}(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~"ubah}(h]h ]h"]h$]h&]hhuh1jhjb"ubeh}(h]h ]h"]h$]h&]hhuh1jhjO"hhhja"hKubeh}(h]jI"ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.is_comment_endjkj" KernelDocis_comment_endjmKernelDoc.is_comment_end()uh1jhja"hKhjL"hhubjo)}(hhh]jt)}(hFHelper function to detect (and effect) the end of a kerneldoc comment.h]hFHelper function to detect (and effect) the end of a kerneldoc comment.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjK"hKhj"hhubah}(h]h ]h"]h$]h&]uh1jnhjL"hhhja"hKubeh}(h]h ](pymethodeh"]h$]h&]jZj"j[j"j\j"j]j^j_uh1jhhhjhjK"hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ?is_new_section() (lib.python.kdoc.kdoc_parser.KernelDoc method)4lib.python.kdoc.kdoc_parser.KernelDoc.is_new_sectionhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.is_new_sectionhNubj)}(hhh](j)}(h"KernelDoc.is_new_section(ln, line)h](jN)}(his_new_sectionh]his_new_section}(hj"hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj"hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.is_new_sectionhKubj)}(hln, lineh](j)}(hlnh]j)}(hlnh]hln}(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]hhuh1jhj"ubj)}(hlineh]j)}(hlineh]hline}(hj #hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]hhuh1jhj"ubeh}(h]h ]h"]h$]h&]hhuh1jhj"hhhj"hKubeh}(h]j"ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.is_new_sectionjkj,# KernelDocis_new_sectionjmKernelDoc.is_new_section()uh1jhj"hKhj"hhubjo)}(hhh]jt)}(h?Helper function to determine if a new section is being started.h]h?Helper function to determine if a new section is being started.}(hj5#hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj"hKhj2#hhubah}(h]h ]h"]h$]h&]uh1jnhj"hhhj"hKubeh}(h]h ](pymethodeh"]h$]h&]jZjL#j[jM#j\jM#j]j^j_uh1jhhhjhj"hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Coutput_declaration() (lib.python.kdoc.kdoc_parser.KernelDoc method)8lib.python.kdoc.kdoc_parser.KernelDoc.output_declarationhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.output_declarationhNubj)}(hhh](j)}(h1KernelDoc.output_declaration(dtype, name, **args)h](jN)}(houtput_declarationh]houtput_declaration}(hjg#hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjc#hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.output_declarationhKubj)}(hdtype, name, **argsh](j)}(hdtypeh]j)}(hdtypeh]hdtype}(hj~#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjz#ubah}(h]h ]h"]h$]h&]hhuh1jhjv#ubj)}(hnameh]j)}(hnameh]hname}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]hhuh1jhjv#ubj)}(h**argsh](j()}(h**h]h**}(hj#hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj#ubj)}(hargsh]hargs}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubeh}(h]h ]h"]h$]h&]hhuh1jhjv#ubeh}(h]h ]h"]h$]h&]hhuh1jhjc#hhhju#hKubeh}(h]j]#ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.output_declarationjkj# KernelDocoutput_declarationjmKernelDoc.output_declaration()uh1jhju#hKhj`#hhubjo)}(hhh](jt)}(h$Store the entry into an entry array.h]h$Store the entry into an entry array.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj_#hKhj#hhubjt)}(h?The actual output and output filters will be handled elsewhere.h]h?The actual output and output filters will be handled elsewhere.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj_#hKhj#hhubeh}(h]h ]h"]h$]h&]uh1jnhj`#hhhju#hKubeh}(h]h ](pymethodeh"]h$]h&]jZj $j[j $j\j $j]j^j_uh1jhhhjhj_#hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j =parse_export() (lib.python.kdoc.kdoc_parser.KernelDoc method)2lib.python.kdoc.kdoc_parser.KernelDoc.parse_exporthNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.parse_exporthNubj)}(hhh](j)}(hKernelDoc.parse_export()h](jN)}(h parse_exporth]h parse_export}(hj%$hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj!$hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.parse_exporthKubj)}(h()h]h}(h]h ]h"]h$]h&]hhuh1jhj!$hhhj3$hKubeh}(h]j$ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.parse_exportjkjD$ KernelDoc parse_exportjmKernelDoc.parse_export()uh1jhj3$hKhj$hhubjo)}(hhh]jt)}(hBParses ``EXPORT_SYMBOL*`` macros from a single Kernel source file.h](hParses }(hjM$hhhNhNubj)}(h``EXPORT_SYMBOL*``h]hEXPORT_SYMBOL*}(hjU$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjM$ubh) macros from a single Kernel source file.}(hjM$hhhNhNubeh}(h]h ]h"]h$]h&]uh1jshj$hKhjJ$hhubah}(h]h ]h"]h$]h&]uh1jnhj$hhhj3$hKubeh}(h]h ](pymethodeh"]h$]h&]jZjv$j[jw$j\jw$j]j^j_uh1jhhhjhj$hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ;parse_kdoc() (lib.python.kdoc.kdoc_parser.KernelDoc method)0lib.python.kdoc.kdoc_parser.KernelDoc.parse_kdochNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.parse_kdochNubj)}(hhh](j)}(hKernelDoc.parse_kdoc()h](jN)}(h parse_kdoch]h parse_kdoc}(hj$hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj$hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.parse_kdochKubj)}(h()h]h}(h]h ]h"]h$]h&]hhuh1jhj$hhhj$hKubeh}(h]j$ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.parse_kdocjkj$ KernelDoc parse_kdocjmKernelDoc.parse_kdoc()uh1jhj$hKhj$hhubjo)}(hhh](jt)}(hOpen and process each line of a C source file. The parsing is controlled via a state machine, and the line is passed to a different process function depending on the state. The process function may update the state as needed.h]hOpen and process each line of a C source file. The parsing is controlled via a state machine, and the line is passed to a different process function depending on the state. The process function may update the state as needed.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj$hKhj$hhubjt)}(h?Besides parsing kernel-doc tags, it also parses export symbols.h]h?Besides parsing kernel-doc tags, it also parses export symbols.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj$hKhj$hhubeh}(h]h ]h"]h$]h&]uh1jnhj$hhhj$hKubeh}(h]h ](pymethodeh"]h$]h&]jZj$j[j$j\j$j]j^j_uh1jhhhjhj$hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j =process_body() (lib.python.kdoc.kdoc_parser.KernelDoc method)2lib.python.kdoc.kdoc_parser.KernelDoc.process_bodyhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_bodyhNubj)}(hhh](j)}(h(KernelDoc.process_body(ln, line, source)h](jN)}(h process_bodyh]h process_body}(hj$hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj$hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_bodyhKubj)}(hln, line, sourceh](j)}(hlnh]j)}(hlnh]hln}(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj %ubah}(h]h ]h"]h$]h&]hhuh1jhj%ubj)}(hlineh]j)}(hlineh]hline}(hj(%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj$%ubah}(h]h ]h"]h$]h&]hhuh1jhj%ubj)}(hsourceh]j)}(hsourceh]hsource}(hj@%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj<%ubah}(h]h ]h"]h$]h&]hhuh1jhj%ubeh}(h]h ]h"]h$]h&]hhuh1jhj$hhhj%hKubeh}(h]j$ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_bodyjkj`% KernelDoc process_bodyjmKernelDoc.process_body()uh1jhj%hKhj$hhubjo)}(hhh]jt)}(h,STATE_BODY: the bulk of a kerneldoc comment.h]h,STATE_BODY: the bulk of a kerneldoc comment.}(hji%hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj$hKhjf%hhubah}(h]h ]h"]h$]h&]uh1jnhj$hhhj%hKubeh}(h]h ](pymethodeh"]h$]h&]jZj%j[j%j\j%j]j^j_uh1jhhhjhj$hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j =process_decl() (lib.python.kdoc.kdoc_parser.KernelDoc method)2lib.python.kdoc.kdoc_parser.KernelDoc.process_declhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_declhNubj)}(hhh](j)}(h(KernelDoc.process_decl(ln, line, source)h](jN)}(h process_declh]h process_decl}(hj%hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj%hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_declhKubj)}(hln, line, sourceh](j)}(hlnh]j)}(hlnh]hln}(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&]hhuh1jhj%ubj)}(hlineh]j)}(hlineh]hline}(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&]hhu h1jhj%ubj)}(hsourceh]j)}(hsourceh]hsource}(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&]hhuh1jhj%ubeh}(h]h ]h"]h$]h&]hhuh1jhj%hhhj%hKubeh}(h]j%ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_decljkj& KernelDoc process_decljmKernelDoc.process_decl()uh1jhj%hKhj%hhubjo)}(hhh]jt)}(h=STATE_DECLARATION: We've seen the beginning of a declaration.h]h?STATE_DECLARATION: We’ve seen the beginning of a declaration.}(hj &hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj%hKhj&hhubah}(h]h ]h"]h$]h&]uh1jnhj%hhhj%hKubeh}(h]h ](pymethodeh"]h$]h&]jZj"&j[j#&j\j#&j]j^j_uh1jhhhjhj%hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Aprocess_docblock() (lib.python.kdoc.kdoc_parser.KernelDoc method)6lib.python.kdoc.kdoc_parser.KernelDoc.process_docblockhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_docblockhNubj)}(hhh](j)}(h,KernelDoc.process_docblock(ln, line, source)h](jN)}(hprocess_docblockh]hprocess_docblock}(hj=&hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj9&hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_docblockhKubj)}(hln, line, sourceh](j)}(hlnh]j)}(hlnh]hln}(hjT&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjP&ubah}(h]h ]h"]h$]h&]hhuh1jhjL&ubj)}(hlineh]j)}(hlineh]hline}(hjl&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjh&ubah}(h]h ]h"]h$]h&]hhuh1jhjL&ubj)}(hsourceh]j)}(hsourceh]hsource}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&ubah}(h]h ]h"]h$]h&]hhuh1jhjL&ubeh}(h]h ]h"]h$]h&]hhuh1jhj9&hhhjK&hKubeh}(h]j3&ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_docblockjkj& KernelDocprocess_docblockjmKernelDoc.process_docblock()uh1jhjK&hKhj6&hhubjo)}(hhh]jt)}(h(STATE_DOCBLOCK: within a ``DOC:`` block.h](hSTATE_DOCBLOCK: within a }(hj&hhhNhNubj)}(h``DOC:``h]hDOC:}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj&ubh block.}(hj&hhhNhNubeh}(h]h ]h"]h$]h&]uh1jshj5&hKhj&hhubah}(h]h ]h"]h$]h&]uh1jnhj6&hhhjK&hKubeh}(h]h ](pymethodeh"]h$]h&]jZj&j[j&j\j&j]j^j_uh1jhhhjhj5&hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Fprocess_export() (lib.python.kdoc.kdoc_parser.KernelDoc static method)4lib.python.kdoc.kdoc_parser.KernelDoc.process_exporthNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_exporthNubj)}(hhh](j)}(h,KernelDoc.process_export(function_set, line)h](j)}(h3[<#text: 'static'>, >]h](hstatic}(hj&hhhNhNubj$)}(h h]h }(hj&hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj&ubeh}(h]h ]h"]h$]h&]hhuh1jhj&hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_exporthKubjN)}(hprocess_exporth]hprocess_export}(hj'hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj&hhhj 'hKubj)}(hfunction_set, lineh](j)}(h function_seth]j)}(h function_seth]h function_set}(hj$'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 'ubah}(h]h ]h"]h$]h&]hhuh1jhj'ubj)}(hlineh]j)}(hlineh]hline}(hj<'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8'ubah}(h]h ]h"]h$]h&]hhuh1jhj'ubeh}(h]h ]h"]h$]h&]hhuh1jhj&hhhj 'hKubeh}(h]j&ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_exportjkj\' KernelDocprocess_exportjmKernelDoc.process_export()uh1jhj 'hKhj&hhubjo)}(hhh](jt)}(hprocess ``EXPORT_SYMBOL*`` tagsh](hprocess }(hje'hhhNhNubj)}(h``EXPORT_SYMBOL*``h]hEXPORT_SYMBOL*}(hjm'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhje'ubh tags}(hje'hhhNhNubeh}(h]h ]h"]h$]h&]uh1jshj&hKhjb'hhubjt)}(haThis method doesn't use any variable from the class, so declare it with a staticmethod decorator.h]hcThis method doesn’t use any variable from the class, so declare it with a staticmethod decorator.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj&hKhjb'hhubeh}(h]h ]h"]h$]h&]uh1jnhj&hhhj 'hKubeh}(h]h ](pymethodeh"]h$]h&]jZj'j[j'j\j'j]j^j_uh1jhhhjhj&hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Dprocess_inline_name() (lib.python.kdoc.kdoc_parser.KernelDoc method)9lib.python.kdoc.kdoc_parser.KernelDoc.process_inline_namehNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_inline_namehNubj)}(hhh](j)}(h/KernelDoc.process_inline_name(ln, line, source)h](jN)}(hprocess_inline_nameh]hprocess_inline_name}(hj'hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj'hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_inline_namehKubj)}(hln, line, sourceh](j)}(hlnh]j)}(hlnh]hln}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]hhuh1jhj'ubj)}(hlineh]j)}(hlineh]hline}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]hhuh1jhj'ubj)}(hsourceh]j)}(hsourceh]hsource}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]hhuh1jhj'ubeh}(h]h ]h"]h$]h&]hhuh1jhj'hhhj'hKubeh}(h]j'ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_inline_namejkj( KernelDocprocess_inline_namejmKernelDoc.process_inline_name()uh1jhj'hKhj'hhubjo)}(hhh]jt)}(hDSTATE_INLINE_NAME: beginning of docbook comments within a prototype.h]hDSTATE_INLINE_NAME: beginning of docbook comments within a prototype.}(hj'(hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj'hKhj$(hhubah}(h]h ]h"]h$]h&]uh1jnhj'hhhj'hKubeh}(h]h ](pymethodeh"]h$]h&]jZj>(j[j?(j\j?(j]j^j_uh1jhhhjhj'hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Dprocess_inline_text() (lib.python.kdoc.kdoc_parser.KernelDoc method)9lib.python.kdoc.kdoc_parser.KernelDoc.process_inline_texthNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_inline_texthNubj)}(hhh](j)}(h/KernelDoc.process_inline_text(ln, line, source)h](jN)}(hprocess_inline_texth]hprocess_inline_text}(hjY(hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjU(hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_inline_texthKubj)}(hln, line, sourceh](j)}(hlnh]j)}(hlnh]hln}(hjp(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjl(ubah}(h]h ]h"]h$]h&]hhuh1jhjh(ubj)}(hlineh]j)}(hlineh]hline}(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]hhuh1jhjh(ubj)}(hsourceh]j)}(hsourceh]hsource}(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]hhuh1jhjh(ubeh}(h]h ]h"]h$]h&]hhuh1jhjU(hhhjg(hKubeh}(h]jO(ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_inline_textjkj( KernelDocprocess_inline_textjmKernelDoc.process_inline_text()uh1jhjg(hKhjR(hhubjo)}(hhh]jt)}(h7STATE_INLINE_TEXT: docbook comments within a prototype.h]h7STATE_INLINE_TEXT: docbook comments within a prototype.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjQ(hKhj(hhubah}(h]h ]h"]h$]h&]uh1jnhjR(hhhjg(hKubeh}(h]h ](pymethodeh"]h$]h&]jZj(j[j(j\j(j]j^j_uh1jhhhjhjQ(hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j =process_name() (lib.python.kdoc.kdoc_parser.KernelDoc method)2lib.python.kdoc.kdoc_parser.KernelDoc.process_namehNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_namehNubj)}(hhh](j)}(h(KernelDoc.process_name(ln, line, source)h](jN)}(h process_nameh]h process_name}(hj(hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj(hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_namehKubj)}(hln, line, sourceh](j)}(hlnh]j)}(hlnh]hln}(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]hhuh1jhj )ubj)}(hlineh]j)}(hlineh]hline}(hj*)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&)ubah}(h]h ]h"]h$]h&]hhuh1jhj )ubj)}(hsourceh]j)}(hsourceh]hsource}(hjB)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>)ubah}(h]h ]h"]h$]h&]hhuh1jhj )ubeh}(h]h ]h"]h$]h&]hhuh1jhj(hhhj )hKubeh}(h]j(ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_namejkjb) KernelDoc process_namejmKernelDoc.process_name()uh1jhj )hKhj(hhubjo)}(hhh]jt)}(h5STATE_NAME: Looking for the "name - description" lineh]h9STATE_NAME: Looking for the “name - description” line}(hjk)hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj(hKhjh)hhubah}(h]h ]h"]h$]h&]uh1jnhj(hhhj )hKubeh}(h]h ](pymethodeh"]h$]h&]jZj)j[j)j\j)j]j^j_uh1jhhhjhj(hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ?process_normal() (lib.python.kdoc.kdoc_parser.KernelDoc method)4lib.python.kdoc.kdoc_parser.KernelDoc.process_normalhNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_normalhNubj)}(hhh](j)}(h*KernelDoc.process_normal(ln, line, source)h](jN)}(hprocess_normalh]hprocess_normal}(hj)hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj)hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_normalhKubj)}(hln, line, sourceh](j)}(hlnh]j)}(hlnh]hln}(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]hhuh1jhj)ubj)}(hlineh]j)}(hlineh]hline}(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]hhuh1jhj)ubj)}(hsourceh]j)}(hsourceh]hsource}(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]hhuh1jhj)ubeh}(h]h ]h"]h$]h&]hhuh1jhj)hhhj)hKubeh}(h]j)ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_normaljkj* KernelDocprocess_normaljmKernelDoc.process_normal()uh1jhj)hKhj)hhubjo)}(hhh]jt)}(h:STATE_NORMAL: looking for the ``/**`` to begin everything.h](hSTATE_NORMAL: looking for the }(hj *hhhNhNubj)}(h``/**``h]h/**}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj *ubh to begin everything.}(hj *hhhNhNubeh}(h]h ]h"]h$]h&]uh1jshj)hKhj *hhubah}(h]h ]h"]h$]h&]uh1jnhj)hhhj)hKubeh}(h]h ](pymethodeh"]h$]h&]jZj6*j[j7*j\j7*j]j^j_uh1jhhhjhj)hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j >process_proto() (lib.python.kdoc.kdoc_parser.KernelDoc method)3lib.python.kdoc.kdoc_parser.KernelDoc.process_protohNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_protohNubj)}(hhh](j)}(h)KernelDoc.process_proto(ln, line, source)h](jN)}(h process_protoh]h process_proto}(hjQ*hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjM*hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.process_protohKubj)}(hln, line, sourceh](j)}(hlnh]j)}(hlnh]hln}(hjh*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjd*ubah}(h]h ]h"]h$]h&]hhuh1jhj`*ubj)}(hlineh]j)}(hlineh]hline}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj|*ubah}(h]h ]h"]h$]h&]hhuh1jhj`*ubj)}(hsourceh]j)}(hsourceh]hsource}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj*ubah}(h]h ]h"]h$]h&]hhuh1jhj`*ubeh}(h]h ]h"]h$]h&]hhuh1jhjM*hhhj_*hKubeh}(h]jG*ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.process_protojkj* KernelDoc process_protojmKernelDoc.process_proto()uh1jhj_*hKhjJ*hhubjo)}(hhh]jt)}(h3STATE_PROTO: reading a function/whatever prototype.h]h3STATE_PROTO: reading a function/whatever prototype.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjI*hKhj*hhubah}(h]h ]h"]h$]h&]uh1jnhjJ*hhhj_*hKubeh}(h]h ](pymethodeh"]h$]h&]jZj*j[j*j\j*j]j^j_uh1jhhhjhjI*hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Gprocess_proto_function() (lib.python.kdoc.kdoc_parser.KernelDoc method), 1: , 2: , 3: , 4: , 5: , 6: , 7: , 8: }h](j$)}(h h]h }(hj0hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj0ubj)}(h=h]h=}(hj0hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj0ubj$)}(h h]h }(hj0hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj0ubhXn{0: , 1: , 2: , 3: , 4: , 5: , 6: , 7: , 8: }}(hj0hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj0hhhj0hKubeh}(h]j0ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.state_actionsjkj1 KernelDoc state_actionsjmj 1uh1jhj0hKhj0hhubjo)}(hhh]jt)}(hIThe state/action table telling us which function to invoke in each state.h]hIThe state/action table telling us which function to invoke in each state.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj0hKhj 1hhubah}(h]h ]h"]h$]h&]uh1jnhj0hhhj0hKubeh}(h]h ](py attributeeh"]h$]h&]jZj'1j[j(1j\j(1j]j^j_uh1jhhhjhj0hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j >syscall_munge() (lib.python.kdoc.kdoc_parser.KernelDoc method)3lib.python.kdoc.kdoc_parser.KernelDoc.syscall_mungehNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.syscall_mungehNubj)}(hhh](j)}(h"KernelDoc.syscall_munge(ln, proto)h](jN)}(h syscall_mungeh]h syscall_munge}(hjB1hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj>1hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.syscall_mungehKubj)}(h ln, protoh](j)}(hlnh]j)}(hlnh]hln}(hjY1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjU1ubah}(h]h ]h"]h$]h&]hhuh1jhjQ1ubj)}(hprotoh]j)}(hprotoh]hproto}(hjq1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjm1ubah}(h]h ]h"]h$]h&]hhuh1jhjQ1ubeh}(h]h ]h"]h$]h&]hhuh1jhj>1hhhjP1hKubeh}(h]j81ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.syscall_mungejkj1 KernelDoc syscall_mungejmKernelDoc.syscall_munge()uh1jhjP1hKhj;1hhubjo)}(hhh]jt)}(hHandle syscall definitions.h]hHandle syscall definitions.}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj:1hKhj1hhubah}(h]h ]h"]h$]h&]uh1jnhj;1hhhjP1hKubeh}(h]h ](pymethodeh"]h$]h&]jZj1j[j1j\j1j]j^j_uh1jhhhjhj:1hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j Atracepoint_munge() (lib.python.kdoc.kdoc_parser.KernelDoc method)6lib.python.kdoc.kdoc_parser.KernelDoc.tracepoint_mungehNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.tracepoint_mungehNubj)}(hhh](j)}(h%KernelDoc.tracepoint_munge(ln, proto)h](jN)}(htracepoint_mungeh]htracepoint_munge}(hj1hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj1hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.tracepoint_mungehKubj)}(h ln, protoh](j)}(hlnh]j)}(hlnh]hln}(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]hhuh1jhj1ubj)}(hprotoh]j)}(hprotoh]hproto}(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]hhuh1jhj1ubeh}(h]h ]h"]h$]h&]hhuh1jhj1hhhj1hKubeh}(h]j1ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.tracepoint_mungejkj2 KernelDoctracepoint_mungejmKernelDoc.tracepoint_munge()uh1jhj1hKhj1hhubjo)}(hhh]jt)}(hHandle tracepoint definitions.h]hHandle tracepoint definitions.}(hj$2hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj1hKhj!2hhubah}(h]h ]h"]h$]h&]uh1jnhj1hhhj1hKubeh}(h]h ](pymethodeh"]h$]h&]jZj;2j[j<2j\j<2j]j^j_uh1jhhhjhj1hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j =undescribed (lib.python.kdoc.kdoc_parser.KernelDoc attribute)1lib.python.kdoc.kdoc_parser.KernelDoc.undescribedhNtauh1hhjhhh>docstring of lib.python.kdoc.kdoc_parser.KernelDoc.undescribedhNubj)}(hhh](j)}(hKernelDoc.undescribedh](jN)}(h undescribedh]h undescribed}(hjV2hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjR2hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelDoc.undescribedhKubj)}(h'-- undescribed --'h](j$)}(h h]h }(hji2hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hje2ubj)}(h=h]h=}(hjw2hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhje2ubj$)}(h h]h }(hj2hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hje2ubh'-- undescribed --'}(hje2hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhjR2hhhjd2hKubeh}(h]jL2ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjijRjjKernelDoc.undescribedjkj2 KernelDoc undescribedjmj2uh1jhjd2hKhjO2hhubjo)}(hhh]jt)}(h2String to write when a parameter is not described.h]h2String to write when a parameter is not described.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjN2hKhj2hhubah}(h]h ]h"]h$]h&]uh1jnhjO2hhhjd2hKubeh}(h]h ](py attributeeh"]h$]h&]jZj2j[j2j\j2j]j^j_uh1jhhhjhjN2hNubeh}(h]h ]h"]h$]h&]uh1jnhjhhhjAhKubeh}(h]h ](pyclasseh"]h$]h&]jZj2j[j2j\j2j]j^j_uh1jhhhjhNhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 2KernelEntry (class in lib.python.kdoc.kdoc_parser)'lib.python.kdoc.kdoc_parser.KernelEntryhNtauh1hhjhhhNhNubj)}(hhh](j)}(hKernelEntry(config, fname, ln)h](j)}(h2[<#text: 'class'>, >]h](hclass}(hj2hhhNhNubj$)}(h h]h }(hj2hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj2ubeh}(h]h ]h"]h$]h&]hhuh1jhj2hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntryhKubj<)}(hlib.python.kdoc.kdoc_parser.h]hlib.python.kdoc.kdoc_parser.}(hj3hhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hj2hhhj3hKubjN)}(h KernelEntryh]h KernelEntry}(hj3hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj2hhhj3hKubj)}(hconfig, fname, lnh](j)}(hconfigh]j)}(hconfigh]hconfig}(hj+3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'3ubah}(h]h ]h"]h$]h&]hhuh1jhj#3ubj)}(hfnameh]j)}(hfnameh]hfname}(hjC3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?3ubah}(h]h ]h"]h$]h&]hhuh1jhj#3ubj)}(hlnh]j)}(hlnh]hln}(hj[3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjW3ubah}(h]h ]h"]h$]h&]hhuh1jhj#3ubeh}(h]h ]h"]h$]h&]hhuh1jhj2hhhj3hKubeh}(h]j2ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjihjjj3jkj{3j3jmj3uh1jhj3hKhj2hhubjo)}(hhh](jt)}(hBases: :py:class:`object`h](hBases: }(hj3hhhNhNubh)}(h:py:class:`object`h]j)}(hj3h]hobject}(hj3hhhNhNubah}(h]h ](jpypy-classeh"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]refdocj refdomainj3reftypeclass refexplicitrefwarnjj{3jj3jobjectuh1hhjhKhj3ubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntryhKhj}3hhubjt)}(h*Encapsulates a Kernel documentation entry.h]h*Encapsulates a Kernel documentation entry.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntryhKhj}3hhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ;add_text() (lib.python.kdoc.kdoc_parser.KernelEntry method)0lib.python.kdoc.kdoc_parser.KernelEntry.add_texthNtauh1hhj}3hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.add_texthNubj)}(hhh](j)}(hKernelEntry.add_text(text)h](jN)}(hadd_texth]hadd_text}(hj3hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj3hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.add_texthKubj)}(htexth]j)}(htexth]j)}(htexth]htext}(hj3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]hhuh1jhj3ubah}(h]h ]h"]h$]h&]hhuh1jhj3hhhj3hKubeh}(h]j3ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij3jjKernelEntry.add_textjkj 4 KernelEntryadd_textjmKernelEntry.add_text()uh1jhj3hKhj3hhubjo)}(hhh]jt)}(h*Add a new text to the entry contents list.h]h*Add a new text to the entry contents list.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj3hKhj4hhubah}(h]h ]h"]h$]h&]uh1jnhj3hhhj3hKubeh}(h]h ](pymethodeh"]h$]h&]jZj+4j[j,4j\j,4j]j^j_uh1jhhhj}3hj3hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j @begin_section() (lib.python.kdoc.kdoc_parser.KernelEntry method)5lib.python.kdoc.kdoc_parser.KernelEntry.begin_sectionhNtauh1hhj}3hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.begin_sectionhNubj)}(hhh](j)}(hCKernelEntry.begin_section(line_no, title='Description', dump=False)h](jN)}(h begin_sectionh]h begin_section}(hjF4hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjB4hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.begin_sectionhKubj)}(h(line_no, title='Description', dump=Falseh](j)}(hline_noh]j)}(hline_noh]hline_no}(hj]4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjY4ubah}(h]h ]h"]h$]h&]hhuh1jhjU4ubj)}(htitle='Description'h](j)}(htitleh]htitle}(hju4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq4ubj()}(h=h]h=}(hj4hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjq4ubj9)}(h 'Description'h]h 'Description'}(hj4hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjq4ubeh}(h]h ]h"]h$]h&]hhuh1jhjU4ubj)}(h dump=Falseh](j)}(hdumph]hdump}(hj4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4ubj()}(h=h]h=}(hj4hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj4ubj9)}(hFalseh]hFalse}(hj4hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj4ubeh}(h]h ]h"]h$]h&]hhuh1jhjU4ubeh}(h]h ]h"]h$]h&]hhuh1jhjB4hhhjT4hKubeh}(h]j<4ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij3jjKernelEntry.begin_sectionjkj4 KernelEntry begin_sectionjmKernelEntry.begin_section()uh1jhjT4hKhj?4hhubjo)}(hhh]jt)}(hBegin a new section.h]hBegin a new section.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj>4hKhj4hhubah}(h]h ]h"]h$]h&]uh1jnhj?4hhhjT4hKubeh}(h]h ](pymethodeh"]h$]h&]jZj5j[j5j\j5j]j^j_uh1jhhhj}3hj>4hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ;contents() (lib.python.kdoc.kdoc_parser.KernelEntry method)0lib.python.kdoc.kdoc_parser.KernelEntry.contentshNtauh1hhj}3hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.contentshNubj)}(hhh](j)}(hKernelEntry.contents()h](jN)}(hcontentsh]hcontents}(hj"5hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj5hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.contentshKubj)}(h()h]h}(h]h ]h"]h$]h&]hhuh1jhj5hhhj05hKubeh}(h]j5ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij3jjKernelEntry.contentsjkjA5 KernelEntrycontentsjmKernelEntry.contents()uh1jhj05hKhj5hhubjo)}(hhh]jt)}(h8Returns a string with all content texts that were added.h]h8Returns a string with all content texts that were added.}(hjJ5hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj5hKhjG5hhubah}(h]h ]h"]h$]h&]uh1jnhj5hhhj05hKubeh}(h]h ](pymethodeh"]h$]h&]jZja5j[jb5j\jb5j]j^j_uh1jhhhj}3hj5hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ?dump_section() (lib.python.kdoc.kdoc_parser.KernelEntry method)4lib.python.kdoc.kdoc_parser.KernelEntry.dump_sectionhNtauh1hhj}3hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.dump_sectionhNubj)}(hhh](j)}(h(KernelEntry.dump_section(start_new=True)h](jN)}(h dump_sectionh]h dump_section}(hj|5hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjx5hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.dump_sectionhKubj)}(hstart_new=Trueh]j)}(hstart_new=Trueh](j)}(h start_newh]h start_new}(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5ubj()}(h=h]h=}(hj5hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hj5ubj9)}(hTrueh]hTrue}(hj5hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hj5ubeh}(h]h ]h"]h$]h&]hhuh1jhj5ubah}(h]h ]h"]h$]h&]hhuh1jhjx5hhhj5hKubeh}(h]jr5ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij3jjKernelEntry.dump_sectionjkj5 KernelEntry dump_sectionjmKernelEntry.dump_section()uh1jhj5hKhju5hhubjo)}(hhh]jt)}(hBDumps section contents to arrays/hashes intended for that purpose.h]hBDumps section contents to arrays/hashes intended for that purpose.}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjt5hKhj5hhubah}(h]h ]h"]h$]h&]uh1jnhju5hhhj5hKubeh}(h]h ](pymethodeh"]h$]h&]jZj5j[j5j\j5j]j^j_uh1jhhhj}3hjt5hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ;emit_msg() (lib.python.kdoc.kdoc_parser.KernelEntry method)0lib.python.kdoc.kdoc_parser.KernelEntry.emit_msghNtauh1hhj}3hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.emit_msghNubj)}(hhh](j)}(h.KernelEntry.emit_msg(ln, msg, *, warning=True)h](jN)}(hemit_msgh]hemit_msg}(hj 6hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj6hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.KernelEntry.emit_msghKubj)}(hln, msg, *, warning=Trueh](j)}(hlnh]j)}(hlnh]hln}(hj"6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]hhuh1jhj6ubj)}(hmsgh]j)}(hmsgh]hmsg}(hj:6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj66ubah}(h]h ]h"]h$]h&]hhuh1jhj6ubj)}(h*h]j()}(h*h]h*}(hjR6hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjN6ubah}(h]h ]h"]h$]h&]hhuh1jhj6ubj)}(h warning=Trueh](j)}(hwarningh]hwarning}(hjj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjf6ubj()}(h=h]h=}(hjx6hhhNhNubah}(h]h ]j4ah"]h$]h&]uh1j'hjf6ubj9)}(hTrueh]hTrue}(hj6hhhNhNubah}(h]h ]jEah"]h$]h&]support_smartquotesuh1j8hjf6ubeh}(h]h ]h"]h$]h&]hhuh1jhj6ubeh}(h]h ]h"]h$]h&]hhuh1jhj6hhhj6hKubeh}(h]j6ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij3jjKernelEntry.emit_msgjkj6 KernelEntryemit_msgjmKernelEntry.emit_msg()uh1jhj6hKhj6hhubjo)}(hhh]jt)}(hEmit a message.h]hEmit a message.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj6hKhj6hhubah}(h]h ]h"]h$]h&]uh1jnhj6hhhj6hKubeh}(h]h ](pymethodeh"]h$]h&]jZj6j[j6j\j6j]j^j_uh1jhhhj}3hj6hNubeh}(h]h ]h"]h$]h&]uh1jnhj2hhhj3hKubeh}(h]h ](pyclasseh"]h$]h&]jZj6j[j6j\j6j]j^j_uh1jhhhjhNhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 7SECTION_DEFAULT (in module lib.python.kdoc.kdoc_parser)+lib.python.kdoc.kdoc_parser.SECTION_DEFAULThNtauh1hhjhhh8docstring of lib.python.kdoc.kdoc_parser.SECTION_DEFAULThNubj)}(hhh](j)}(hSECTION_DEFAULTh](j<)}(hlib.python.kdoc.kdoc_parser.h]hlib.python.kdoc.kdoc_parser.}(hj6hhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hj6hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.SECTION_DEFAULThKubjN)}(hj6h]hSECTION_DEFAULT}(hj6hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj6hhhj6hKubj)}(h 'Description'h](j$)}(h h]h }(hj7hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj 7ubj)}(h=h]h=}(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 7ubj$)}(h h]h }(hj,7hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj 7ubh 'Description'}(hj 7hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj6hhhj6hKubeh}(h]j6ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjihjjj6jkjJ7j6jmj6uh1jhj6hKhj6hhubjo)}(hhh]jt)}(hDefault section.h]hDefault section.}(hjO7hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj6hKhjL7hhubah}(h]h ]h"]h$]h&]uh1jnhj6hhhj6hKubeh}(h]h ](pydataeh"]h$]h&]jZjf7j[jg7j\jg7j]j^j_uh1jhhhjhj6hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j ,state (class in lib.python.kdoc.kdoc_parser)!lib.python.kdoc.kdoc_parser.statehNtauh1hhjhhhNhNubj)}(hhh](j)}(hstate()h](j)}(h2[<#text: 'class'>, >]h](hclass}(hj7hhhNhNubj$)}(h h]h }(hj7hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj7ubeh}(h]h ]h"]h$]h&]hhuh1jhj|7hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.statehKubj<)}(hlib.python.kdoc.kdoc_parser.h]hlib.python.kdoc.kdoc_parser.}(hj7hhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hj|7hhhj7hKubjN)}(hstateh]hstate}(hj7hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj|7hhhj7hKubeh}(h]jw7ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjihjjj7jkj7j7jmj7uh1jhj7hKhjy7hhubjo)}(hhh](jt)}(hBases: :py:class:`object`h](hBases: }(hj7hhhNhNubh)}(h:py:class:`object`h]j)}(hj7h]hobject}(hj7hhhNhNubah}(h]h ](jpypy-classeh"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]refdocj refdomainj7reftypeclass refexplicitrefwarnjj7jj7jobjectuh1hhjhKhj7ubeh}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.statehKhj7hhubjt)}(h*States used by the parser's state machine.h]h,States used by the parser’s state machine.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jsh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.statehKhj7hhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 2BODY (lib.python.kdoc.kdoc_parser.state attribute)&lib.python.kdoc.kdoc_parser.state.BODYhNtauh1hhj7hhh3docstring of lib.python.kdoc.kdoc_parser.state.BODYhNubj)}(hhh](j)}(h state.BODYh](jN)}(hBODYh]hBODY}(hj8hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj8hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.BODYhKubj)}(h3h](j$)}(h h]h }(hj+8hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj'8ubj)}(h=h]h=}(hj98hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'8ubj$)}(h h]h }(hjG8hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj'8ubh3}(hj'8hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj8hhhj&8hKubeh}(h]j8ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jj state.BODYjkje8stateBODYjmjf8uh1jhj&8hKhj8hhubjo)}(hhh]jt)}(hThe body of the comment.h]hThe body of the comment.}(hjm8hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj8hKhjj8hhubah}(h]h ]h"]h$]h&]uh1jnhj8hhhj&8hKubeh}(h]h ](py attributeeh"]h$]h&]jZj8j[j8j\j8j]j^j_uh1jhhhj7hj8hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9DECLARATION (lib.python.kdoc.kdoc_parser.state attribute)-lib.python.kdoc.kdoc_parser.state.DECLARATIONhNtauh1hhj7hhh:docstring of lib.python.kdoc.kdoc_parser.state.DECLARATIONhNubj)}(hhh](j)}(hstate.DECLARATIONh](jN)}(h DECLARATIONh]h DECLARATION}(hj8hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj8hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.DECLARATIONhKubj)}(h2h](j$)}(h h]h }(hj8hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj8ubj)}(h=h]h=}(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubj$)}(h h]h }(hj8hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj8ubh2}(hj8hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj8hhhj8hKubeh}(h]j8ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jjstate.DECLARATIONjkj8state DECLARATIONjmj8uh1jhj8hKhj8hhubjo)}(hhh]jt)}(h3We have seen a declaration which might not be done.h]h3We have seen a declaration which might not be done.}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj8hKhj8hhubah}(h]h ]h"]h$]h&]uh1jnhj8hhhj8hKubeh}(h]h ](py attributeeh"]h$]h&]jZj 9j[j 9j\j 9j]j^j_uh1jhhhj7hj8hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 6DOCBLOCK (lib.python.kdoc.kdoc_parser.state attribute)*lib.python.kdoc.kdoc_parser.state.DOCBLOCKhNtauh1hhj7hhh7docstring of lib.python.kdoc.kdoc_parser.state.DOCBLOCKhNubj)}(hhh](j)}(hstate.DOCBLOCKh](jN)}(hDOCBLOCKh]hDOCBLOCK}(hj&9hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj"9hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.DOCBLOCKhKubj)}(h6h](j$)}(h h]h }(hj99hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj59ubj)}(h=h]h=}(hjG9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj59ubj$)}(h h]h }(hjU9hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj59ubh6}(hj59hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj"9hhhj49hKubeh}(h]j9ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jjstate.DOCBLOCKjkjs9stateDOCBLOCKjmjt9uh1jhj49hKhj9hhubjo)}(hhh]jt)}(hDocumentation block.h]hDocumentation block.}(hj{9hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj9hKhjx9hhubah}(h]h ]h"]h$]h&]uh1jnhj9hhhj49hKubeh}(h]h ](py attributeeh"]h$]h&]jZj9j[j9j\j9j]j^j_uh1jhhhj7hj9hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9INLINE_NAME (lib.python.kdoc.kdoc_parser.state attribute)-lib.python.kdoc.kdoc_parser.state.INLINE_NAMEhNtauh1hhj7hhh:docstring of lib.python.kdoc.kdoc_parser.state.INLINE_NAMEhNubj)}(hhh](j)}(hstate.INLINE_NAMEh](jN)}(h INLINE_NAMEh]h INLINE_NAME}(hj9hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj9hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.INLINE_NAMEhKubj)}(h7h](j$)}(h h]h }(hj9hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj9ubj)}(h=h]h=}(hj9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj9ubj$)}(h h]h }(hj9hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj9ubh7}(hj9hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj9hhhj9hKubeh}(h]j9ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jjstate.INLINE_NAMEjkj9state INLINE_NAMEjmj9uh1jhj9hKhj9hhubjo)}(hhh]jt)}(h!Gathering doc outside main block.h]h!Gathering doc outside main block.}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj9hKhj9hhubah}(h]h ]h"]h$]h&]uh1jnhj9hhhj9hKubeh}(h]h ](py attributeeh"]h$]h&]jZj:j[j:j\j:j]j^j_uh1jhhhj7hj9hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9INLINE_TEXT (lib.python.kdoc.kdoc_parser.state attribute)-lib.python.kdoc.kdoc_parser.state.INLINE_TEXThNtauh1hhj7hhh:docstring of lib.python.kdoc.kdoc_parser.state.INLINE_TEXThNubj)}(hhh](j)}(hstate.INLINE_TEXTBh](jN)}(h INLINE_TEXTh]h INLINE_TEXT}(hj4:hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj0:hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.INLINE_TEXThKubj)}(h8h](j$)}(h h]h }(hjG:hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjC:ubj)}(h=h]h=}(hjU:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjC:ubj$)}(h h]h }(hjc:hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjC:ubh8}(hjC:hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj0:hhhjB:hKubeh}(h]j*:ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jjstate.INLINE_TEXTjkj:state INLINE_TEXTjmj:uh1jhjB:hKhj-:hhubjo)}(hhh]jt)}(h Reading the body of inline docs.h]h Reading the body of inline docs.}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj,:hKhj:hhubah}(h]h ]h"]h$]h&]uh1jnhj-:hhhjB:hKubeh}(h]h ](py attributeeh"]h$]h&]jZj:j[j:j\j:j]j^j_uh1jhhhj7hj,:hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 2NAME (lib.python.kdoc.kdoc_parser.state attribute)&lib.python.kdoc.kdoc_parser.state.NAMEhNtauh1hhj7hhh3docstring of lib.python.kdoc.kdoc_parser.state.NAMEhNubj)}(hhh](j)}(h state.NAMEh](jN)}(hNAMEh]hNAME}(hj:hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj:hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.NAMEhKubj)}(h1h](j$)}(h h]h }(hj:hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj:ubj)}(h=h]h=}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubj$)}(h h]h }(hj:hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj:ubh1}(hj:hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj:hhhj:hKubeh}(h]j:ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jj state.NAMEjkj;stateNAMEjmj ;uh1jhj:hKhj:hhubjo)}(hhh]jt)}(hLooking for function name.h]hLooking for function name.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj:hKhj ;hhubah}(h]h ]h"]h$]h&]uh1jnhj:hhhj:hKubeh}(h]h ](py attributeeh"]h$]h&]jZj';j[j(;j\j(;j]j^j_uh1jhhhj7hj:hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 4NORMAL (lib.python.kdoc.kdoc_parser.state attribute)(lib.python.kdoc.kdoc_parser.state.NORMALhNtauh1hhj7hhh5docstring of lib.python.kdoc.kdoc_parser.state.NORMALhNubj)}(hhh](j)}(h state.NORMALh](jN)}(hNORMALh]hNORMAL}(hjB;hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj>;hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.NORMALhKubj)}(h0h](j$)}(h h]h }(hjU;hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjQ;ubj)}(h=h]h=}(hjc;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQ;ubj$)}(h h]h }(hjq;hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hjQ;ubh0}(hjQ;hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj>;hhhjP;hKubeh}(h]j8;ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jj state.NORMALjkj;stateNORMALjmj;uh1jhjP;hKhj;;hhubjo)}(hhh]jt)}(h Normal code.h]h Normal code.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj:;hKhj;hhubah}(h]h ]h"]h$]h&]uh1jnhj;;hhhjP;hKubeh}(h]h ](py attributeeh"]h$]h&]jZj;j[j;j\j;j]j^j_uh1jhhhj7hj:;hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 3PROTO (lib.python.kdoc.kdoc_parser.state attribute)'lib.python.kdoc.kdoc_parser.state.PROTOhNtauh1hhj7hhh4docstring of lib.python.kdoc.kdoc_parser.state.PROTOhNubj)}(hhh](j)}(h state.PROTOh](jN)}(hPROTOh]hPROTO}(hj;hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj;hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.PROTOhKubj)}(h5h](j$)}(h h]h }(hj;hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj;ubj)}(h=h]h=}(hj;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;ubj$)}(h h]h }(hj;hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj;ubh5}(hj;hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj;hhhj;hKubeh}(h]j;ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jj state.PROTOjkj<statePROTOjmj<uh1jhj;hKhj;hhubjo)}(hhh]jt)}(hScanning prototype.h]hScanning prototype.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj;hKhj<hhubah}(h]h ]h"]h$]h&]uh1jnhj;hhhj;hKubeh}(h]h ](py attributeeh"]h$]h&]jZj5<j[j6<j\j6<j]j^j_uh1jhhhj7hj;hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j =SPECIAL_SECTION (lib.python.kdoc.kdoc_parser.state attribute)1lib.python.kdoc.kdoc_parser.state.SPECIAL_SECTIONhNtauh1hhj7hhh>docstring of lib.python.kdoc.kdoc_parser.state.SPECIAL_SECTIONhNubj)}(hhh](j)}(hstate.SPECIAL_SECTIONh](jN)}(hSPECIAL_SECTIONh]hSPECIAL_SECTION}(hjP<hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjL<hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.SPECIAL_SECTIONhKubj)}(h4h](j$)}(h h]h }(hjc<hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj_<ubj)}(h=h]h=}(hjq<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj_<ubj$)}(h h]h }(hj<hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj_<ubh4}(hj_<hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhjL<hhhj^<hKubeh}(h]jF<ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jjstate.SPECIAL_SECTIONjkj<stateSPECIAL_SECTIONjmj<uh1jhj^<hKhjI<hhubjo)}(hhh]jt)}(h%Doc section ending with a blank line.h]h%Doc section ending with a blank line.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjH<hKhj<hhubah}(h]h ]h"]h$]h&]uh1jnhjI<hhhj^<hKubeh}(h]h ](py attributeeh"]h$]h&]jZj<j[j<j\j<j]j^j_uh1jhhhj7hjH<hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 2name (lib.python.kdoc.kdoc_parser.state attribute)&lib.python.kdoc.kdoc_parser.state.namehNtauh1hhj7hhh3docstring of lib.python.kdoc.kdoc_parser.state.namehNubj)}(hhh](j)}(h state.nameh](jN)}(hnameh]hname}(hj<hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj<hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.state.namehKubj)}(ho['NORMAL', 'NAME', 'DECLARATION', 'BODY', 'SPECIAL_SECTION', 'PROTO', 'DOCBLOCK', 'INLINE_NAME', 'INLINE_TEXT']h](j$)}(h h]h }(hj<hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj<ubj)}(h=h]h=}(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj<ubj$)}(h h]h }(hj=hhhNhNubah}(h]h ]j0ah"]h$]h&]uh1j#hj<ubho['NORMAL', 'NAME', 'DECLARATION', 'BODY', 'SPECIAL_SECTION', 'PROTO', 'DOCBLOCK', 'INLINE_NAME', 'INLINE_TEXT']}(hj<hhhNhNubeh}(h]h ]h"]h$]h&]hhuh1jhj<hhhj<hKubeh}(h]j<ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjij7jj state.namejkj$=statenamejmj%=uh1jhj<hKhj<hhubjo)}(hhh]jt)}(hNames for each parser state.h]hNames for each parser state.}(hj,=hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj<hKhj)=hhubah}(h]h ]h"]h$]h&]uh1jnhj<hhhj<hKubeh}(h]h ](py attributeeh"]h$]h&]jZjC=j[jD=j\jD=j]j^j_uh1jhhhj7hj<hNubeh}(h]h ]h"]h$]h&]uh1jnhjy7hhhj7hKubeh}(h]h ](pyclasseh"]h$]h&]jZjQ=j[jR=j\jR=j]j^j_uh1jhhhjhNhNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j >trim_private_members() (in module lib.python.kdoc.kdoc_parser)0lib.python.kdoc.kdoc_parser.trim_private_membershNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.trim_private_membershNubj)}(hhh](j)}(htrim_private_members(text)h](j<)}(hlib.python.kdoc.kdoc_parser.h]hlib.python.kdoc.kdoc_parser.}(hjl=hhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hjh=hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.trim_private_membershKubjN)}(htrim_private_membersh]htrim_private_members}(hj{=hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhjh=hhhjz=hKubj)}(htexth]j)}(htexth]j)}(htexth]htext}(hj=hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]hhuh1jhj=ubah}(h]h ]h"]h$]h&]hhuh1jhjh=hhhjz=hKubeh}(h]jb=ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjihjjj}=jkj=j}=jmtrim_private_members()uh1jhjz=hKhje=hhubjo)}(hhh]jt)}(hCRemove ``struct``/``enum`` members that have been marked "private".h](hRemove }(hj=hhhNhNubj)}(h ``struct``h]hstruct}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh/}(hj=hhhNhNubj)}(h``enum``h]henum}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh- members that have been marked “private”.}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1jshjd=hKhj=hhubah}(h]h ]h"]h$]h&]uh1jnhje=hhhjz=hKubeh}(h]h ](pyfunctioneh"]h$]h&]jZj=j[j=j\j=j]j^j_uh1jhhhjhjd=hNubh)}(hhh]h}(h]h ]h"]h$]h&]entries](j 9trim_whitespace() (in module lib.python.kdoc.kdoc_parser)+lib.python.kdoc.kdoc_parser.trim_whitespacehNtauh1hhjhhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.trim_whitespacehNubj)}(hhh](j)}(htrim_whitespace(s)h](j<)}(hlib.python.kdoc.kdoc_parser.h]hlib.python.kdoc.kdoc_parser.}(hj >hhhNhNubah}(h]h ](jHjIeh"]h$]h&]hhuh1j;hj >hhh/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parser.trim_whitespacehKubjN)}(htrim_whitespaceh]htrim_whitespace}(hj>hhhNhNubah}(h]h ](jZj[eh"]h$]h&]hhuh1jMhj >hhhj>hKubj)}(hsh]j)}(hsh]j)}(hsh]hs}(hj2>hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj.>ubah}(h]h ]h"]h$]h&]hhuh1jhj*>ubah}(h]h ]h"]h$]h&]hhuh1jhj >hhhj>hKubeh}(h]j>ah ](jbjceh"]h$]h&]jglib.python.kdoc.kdoc_parserjihjjj>jkjR>j>jmtrim_whitespace()uh1jhj>hKhj>hhubjo)}(hhh]jt)}(h1A little helper to get rid of excess white space.h]h1A little helper to get rid of excess white space.}(hjX>hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj>hKhjU>hhubah}(h]h ]h"]h$]h&]uh1jnhj>hhhj>hKubeh}(h]h ](pyfunctioneh"]h$]h&]jZjo>j[jp>j\jp>j]j^j_uh1jhhhjhj>hNubeh}(h](jparser-classes-and-methodseh ]h"]parser classes and methodsah$]h&]uh1hhhhhhhhK ubeh}(h]kernel-doc-parser-stageah ]h"]kernel-doc parser stageah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_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_handlerj>error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _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}refids}nameids}(j>j~>jjjjjjjy>jv>u nametypes}(j>jjjjy>uh}(j~>hjhhhtarget)}(hhh]h}(h]hah ]h"]h$]h&]ismoduh1j>h|/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/xforms_lists.py:docstring of lib.python.kdoc.xforms_listshKhhhhubj jjjjljrjjj}jjj jjjj>)}(hhh]h}(h]jah ]h"]h$]h&]ismoduh1j>hx/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_files.py:docstring of lib.python.kdoc.kdoc_fileshKhjhhubjjjjjyjjfjkjNjTjjj2j8j4j:jjjjjjjjjjjj>)}(hhh]h}(h]jah ]h"]h$]h&]ismoduh1j>hv/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_item.py:docstring of lib.python.kdoc.kdoc_itemhKhjhhubj7j<j_jejjjjjNjTjv>jjj>)}(hhh]h}(h]jah ]h"]h$]h&]ismoduh1j>hz/var/lib/git/docbuild/linux/Documentation/../tools/lib/python/kdoc/kdoc_parser.py:docstring of lib.python.kdoc.kdoc_parserhKhjhhubjj!j;jAjjjjjQjWjjjjjIjOjjjjjNjTjjj j j!j!jI"jO"j"j"j]#jc#j$j!$j$j$j$j$j%j%j3&j9&j&j&j'j'jO(jU(j(j(j)j)jG*jM*j*j*j+j+j-,j3,j,j,j-j-j+.j1.j/j%/j/j/j-0j30j0j0j81j>1j1j1jL2jR2j2j2j3j3j<4jB4j5j5jr5jx5j6j6j6j6jw7j|7j8j8j8j8j9j"9j9j9j*:j0:j:j:j8;j>;j;j;jF<jL<j<j<jb=jh=j>j >u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.