diff options
Diffstat (limited to 'coverage-report/d_5d0ec0d5422112df_lsp_debian_control_reference_data_py.html')
| -rw-r--r-- | coverage-report/d_5d0ec0d5422112df_lsp_debian_control_reference_data_py.html | 2896 |
1 files changed, 0 insertions, 2896 deletions
diff --git a/coverage-report/d_5d0ec0d5422112df_lsp_debian_control_reference_data_py.html b/coverage-report/d_5d0ec0d5422112df_lsp_debian_control_reference_data_py.html deleted file mode 100644 index 70398a4..0000000 --- a/coverage-report/d_5d0ec0d5422112df_lsp_debian_control_reference_data_py.html +++ /dev/null @@ -1,2896 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <title>Coverage for src/debputy/lsp/lsp_debian_control_reference_data.py: 59%</title> - <link rel="icon" sizes="32x32" href="favicon_32.png"> - <link rel="stylesheet" href="style.css" type="text/css"> - <script type="text/javascript" src="coverage_html.js" defer></script> -</head> -<body class="pyfile"> -<header> - <div class="content"> - <h1> - <span class="text">Coverage for </span><b>src/debputy/lsp/lsp_debian_control_reference_data.py</b>: - <span class="pc_cov">59%</span> - </h1> - <aside id="help_panel_wrapper"> - <input id="help_panel_state" type="checkbox"> - <label for="help_panel_state"> - <img id="keyboard_icon" src="keybd_closed.png" alt="Show/hide keyboard shortcuts" /> - </label> - <div id="help_panel"> - <p class="legend">Shortcuts on this page</p> - <div class="keyhelp"> - <p> - <kbd>r</kbd> - <kbd>m</kbd> - <kbd>x</kbd> - <kbd>p</kbd> - toggle line displays - </p> - <p> - <kbd>j</kbd> - <kbd>k</kbd> - next/prev highlighted chunk - </p> - <p> - <kbd>0</kbd> (zero) top of page - </p> - <p> - <kbd>1</kbd> (one) first highlighted chunk - </p> - <p> - <kbd>[</kbd> - <kbd>]</kbd> - prev/next file - </p> - <p> - <kbd>u</kbd> up to the index - </p> - <p> - <kbd>?</kbd> show/hide this help - </p> - </div> - </div> - </aside> - <h2> - <span class="text">335 statements </span> - <button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">212<span class="text"> run</span></button> - <button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">123<span class="text"> missing</span></button> - <button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">6<span class="text"> excluded</span></button> - <button type="button" class="par run show_par button_toggle_par" value="par" data-shortcut="p" title="Toggle lines partially run">13<span class="text"> partial</span></button> - </h2> - <p class="text"> - <a id="prevFileLink" class="nav" href="d_5d0ec0d5422112df_lsp_debian_control_py.html">« prev</a> - <a id="indexLink" class="nav" href="index.html">^ index</a> - <a id="nextFileLink" class="nav" href="d_5d0ec0d5422112df_lsp_debian_copyright_py.html">» next</a> - - <a class="nav" href="https://coverage.readthedocs.io/en/7.2.7">coverage.py v7.2.7</a>, - created at 2024-04-07 12:14 +0200 - </p> - <aside class="hidden"> - <button type="button" class="button_next_chunk" data-shortcut="j"/> - <button type="button" class="button_prev_chunk" data-shortcut="k"/> - <button type="button" class="button_top_of_page" data-shortcut="0"/> - <button type="button" class="button_first_chunk" data-shortcut="1"/> - <button type="button" class="button_prev_file" data-shortcut="["/> - <button type="button" class="button_next_file" data-shortcut="]"/> - <button type="button" class="button_to_index" data-shortcut="u"/> - <button type="button" class="button_show_hide_help" data-shortcut="?"/> - </aside> - </div> -</header> -<main id="source"> - <p class="run"><span class="n"><a id="t1" href="#t1">1</a></span><span class="t"><span class="key">import</span> <span class="nam">dataclasses</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2" href="#t2">2</a></span><span class="t"><span class="key">import</span> <span class="nam">functools</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t3" href="#t3">3</a></span><span class="t"><span class="key">import</span> <span class="nam">itertools</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t4" href="#t4">4</a></span><span class="t"><span class="key">import</span> <span class="nam">re</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t5" href="#t5">5</a></span><span class="t"><span class="key">import</span> <span class="nam">sys</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t6" href="#t6">6</a></span><span class="t"><span class="key">import</span> <span class="nam">textwrap</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t7" href="#t7">7</a></span><span class="t"><span class="key">from</span> <span class="nam">abc</span> <span class="key">import</span> <span class="nam">ABC</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t8" href="#t8">8</a></span><span class="t"><span class="key">from</span> <span class="nam">enum</span> <span class="key">import</span> <span class="nam">Enum</span><span class="op">,</span> <span class="nam">auto</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t9" href="#t9">9</a></span><span class="t"><span class="key">from</span> <span class="nam">typing</span> <span class="key">import</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t10" href="#t10">10</a></span><span class="t"> <span class="nam">FrozenSet</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t11" href="#t11">11</a></span><span class="t"> <span class="nam">Optional</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t12" href="#t12">12</a></span><span class="t"> <span class="nam">cast</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t13" href="#t13">13</a></span><span class="t"> <span class="nam">Mapping</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t14" href="#t14">14</a></span><span class="t"> <span class="nam">Iterable</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t15" href="#t15">15</a></span><span class="t"> <span class="nam">List</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t16" href="#t16">16</a></span><span class="t"> <span class="nam">Generic</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t17" href="#t17">17</a></span><span class="t"> <span class="nam">TypeVar</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t18" href="#t18">18</a></span><span class="t"> <span class="nam">Union</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t19" href="#t19">19</a></span><span class="t"> <span class="nam">Callable</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t20" href="#t20">20</a></span><span class="t"> <span class="nam">Tuple</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t21" href="#t21">21</a></span><span class="t"> <span class="nam">Any</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t22" href="#t22">22</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t23" href="#t23">23</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t24" href="#t24">24</a></span><span class="t"><span class="key">from</span> <span class="nam">debian</span><span class="op">.</span><span class="nam">debian_support</span> <span class="key">import</span> <span class="nam">DpkgArchTable</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t25" href="#t25">25</a></span><span class="t"><span class="key">from</span> <span class="nam">lsprotocol</span><span class="op">.</span><span class="nam">types</span> <span class="key">import</span> <span class="nam">DiagnosticSeverity</span><span class="op">,</span> <span class="nam">Diagnostic</span><span class="op">,</span> <span class="nam">DiagnosticTag</span><span class="op">,</span> <span class="nam">Range</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t26" href="#t26">26</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t27" href="#t27">27</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">lsp</span><span class="op">.</span><span class="nam">quickfixes</span> <span class="key">import</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t28" href="#t28">28</a></span><span class="t"> <span class="nam">propose_correct_text_quick_fix</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t29" href="#t29">29</a></span><span class="t"> <span class="nam">propose_remove_line_quick_fix</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t30" href="#t30">30</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t31" href="#t31">31</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">lsp</span><span class="op">.</span><span class="nam">text_util</span> <span class="key">import</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t32" href="#t32">32</a></span><span class="t"> <span class="nam">normalize_dctrl_field_name</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t33" href="#t33">33</a></span><span class="t"> <span class="nam">LintCapablePositionCodec</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t34" href="#t34">34</a></span><span class="t"> <span class="nam">detect_possible_typo</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t35" href="#t35">35</a></span><span class="t"> <span class="nam">te_range_to_lsp</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t36" href="#t36">36</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t37" href="#t37">37</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">lsp</span><span class="op">.</span><span class="nam">vendoring</span><span class="op">.</span><span class="nam">_deb822_repro</span><span class="op">.</span><span class="nam">parsing</span> <span class="key">import</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t38" href="#t38">38</a></span><span class="t"> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t39" href="#t39">39</a></span><span class="t"> <span class="nam">LIST_SPACE_SEPARATED_INTERPRETATION</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t40" href="#t40">40</a></span><span class="t"> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t41" href="#t41">41</a></span><span class="t"> <span class="nam">Deb822FileElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t42" href="#t42">42</a></span><span class="t"> <span class="nam">Interpretation</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t43" href="#t43">43</a></span><span class="t"> <span class="nam">LIST_COMMA_SEPARATED_INTERPRETATION</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t44" href="#t44">44</a></span><span class="t"> <span class="nam">ListInterpretation</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t45" href="#t45">45</a></span><span class="t"> <span class="nam">_parsed_value_render_factory</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t46" href="#t46">46</a></span><span class="t"> <span class="nam">Deb822ParsedValueElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t47" href="#t47">47</a></span><span class="t"> <span class="nam">LIST_UPLOADERS_INTERPRETATION</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t48" href="#t48">48</a></span><span class="t"> <span class="nam">_parse_whitespace_list_value</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t49" href="#t49">49</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t50" href="#t50">50</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">lsp</span><span class="op">.</span><span class="nam">vendoring</span><span class="op">.</span><span class="nam">_deb822_repro</span><span class="op">.</span><span class="nam">tokens</span> <span class="key">import</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t51" href="#t51">51</a></span><span class="t"> <span class="nam">Deb822FieldNameToken</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t52" href="#t52">52</a></span><span class="t"> <span class="nam">_value_line_tokenizer</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t53" href="#t53">53</a></span><span class="t"> <span class="nam">Deb822ValueToken</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t54" href="#t54">54</a></span><span class="t"> <span class="nam">Deb822Token</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t55" href="#t55">55</a></span><span class="t"> <span class="nam">_RE_WHITESPACE_SEPARATED_WORD_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t56" href="#t56">56</a></span><span class="t"> <span class="nam">Deb822SpaceSeparatorToken</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t57" href="#t57">57</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t58" href="#t58">58</a></span><span class="t"><span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">util</span> <span class="key">import</span> <span class="nam">PKGNAME_REGEX</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t59" href="#t59">59</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t60" href="#t60">60</a></span><span class="t"><span class="key">try</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t61" href="#t61">61</a></span><span class="t"> <span class="key">from</span> <span class="nam">debputy</span><span class="op">.</span><span class="nam">lsp</span><span class="op">.</span><span class="nam">vendoring</span><span class="op">.</span><span class="nam">_deb822_repro</span><span class="op">.</span><span class="nam">locatable</span> <span class="key">import</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t62" href="#t62">62</a></span><span class="t"> <span class="nam">Position</span> <span class="key">as</span> <span class="nam">TEPosition</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t63" href="#t63">63</a></span><span class="t"> <span class="nam">Range</span> <span class="key">as</span> <span class="nam">TERange</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t64" href="#t64">64</a></span><span class="t"> <span class="nam">START_POSITION</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t65" href="#t65">65</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t66" href="#t66">66</a></span><span class="t"><span class="key">except</span> <span class="nam">ImportError</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t67" href="#t67">67</a></span><span class="t"> <span class="key">pass</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t68" href="#t68">68</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t69" href="#t69">69</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t70" href="#t70">70</a></span><span class="t"><span class="nam">F</span> <span class="op">=</span> <span class="nam">TypeVar</span><span class="op">(</span><span class="str">"F"</span><span class="op">,</span> <span class="nam">bound</span><span class="op">=</span><span class="str">"Deb822KnownField"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t71" href="#t71">71</a></span><span class="t"><span class="nam">S</span> <span class="op">=</span> <span class="nam">TypeVar</span><span class="op">(</span><span class="str">"S"</span><span class="op">,</span> <span class="nam">bound</span><span class="op">=</span><span class="str">"StanzaMetadata"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t72" href="#t72">72</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t73" href="#t73">73</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t74" href="#t74">74</a></span><span class="t"><span class="com"># FIXME: should go into python3-debian</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t75" href="#t75">75</a></span><span class="t"><span class="nam">_RE_COMMA</span> <span class="op">=</span> <span class="nam">re</span><span class="op">.</span><span class="nam">compile</span><span class="op">(</span><span class="str">"([^,]*),([^,]*)"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t76" href="#t76">76</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t77" href="#t77">77</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t78" href="#t78">78</a></span><span class="t"><span class="op">@</span><span class="nam">_value_line_tokenizer</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t79" href="#t79">79</a></span><span class="t"><span class="key">def</span> <span class="nam">comma_or_space_split_tokenizer</span><span class="op">(</span><span class="nam">v</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t80" href="#t80">80</a></span><span class="t"> <span class="com"># type: (str) -> Iterable[Deb822Token]</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t81" href="#t81">81</a></span><span class="t"> <span class="key">assert</span> <span class="str">"\n"</span> <span class="key">not</span> <span class="key">in</span> <span class="nam">v</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t82" href="#t82">82</a></span><span class="t"> <span class="key">for</span> <span class="nam">match</span> <span class="key">in</span> <span class="nam">_RE_WHITESPACE_SEPARATED_WORD_LIST</span><span class="op">.</span><span class="nam">finditer</span><span class="op">(</span><span class="nam">v</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t83" href="#t83">83</a></span><span class="t"> <span class="nam">space_before</span><span class="op">,</span> <span class="nam">word</span><span class="op">,</span> <span class="nam">space_after</span> <span class="op">=</span> <span class="nam">match</span><span class="op">.</span><span class="nam">groups</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t84" href="#t84">84</a></span><span class="t"> <span class="key">if</span> <span class="nam">space_before</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t85" href="#t85">85</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Deb822SpaceSeparatorToken</span><span class="op">(</span><span class="nam">sys</span><span class="op">.</span><span class="nam">intern</span><span class="op">(</span><span class="nam">space_before</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t86" href="#t86">86</a></span><span class="t"> <span class="key">if</span> <span class="str">","</span> <span class="key">in</span> <span class="nam">word</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t87" href="#t87">87</a></span><span class="t"> <span class="key">for</span> <span class="nam">m</span> <span class="key">in</span> <span class="nam">_RE_COMMA</span><span class="op">.</span><span class="nam">finditer</span><span class="op">(</span><span class="nam">word</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t88" href="#t88">88</a></span><span class="t"> <span class="nam">word_before</span><span class="op">,</span> <span class="nam">word_after</span> <span class="op">=</span> <span class="nam">m</span><span class="op">.</span><span class="nam">groups</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t89" href="#t89">89</a></span><span class="t"> <span class="key">if</span> <span class="nam">word_before</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t90" href="#t90">90</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Deb822ValueToken</span><span class="op">(</span><span class="nam">word_before</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t91" href="#t91">91</a></span><span class="t"> <span class="com"># ... not quite a whitespace, but it is too much pain to make it a non-whitespace token.</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t92" href="#t92">92</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Deb822SpaceSeparatorToken</span><span class="op">(</span><span class="str">","</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t93" href="#t93">93</a></span><span class="t"> <span class="key">if</span> <span class="nam">word_after</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t94" href="#t94">94</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Deb822ValueToken</span><span class="op">(</span><span class="nam">word_after</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t95" href="#t95">95</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t96" href="#t96">96</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Deb822ValueToken</span><span class="op">(</span><span class="nam">word</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t97" href="#t97">97</a></span><span class="t"> <span class="key">if</span> <span class="nam">space_after</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t98" href="#t98">98</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Deb822SpaceSeparatorToken</span><span class="op">(</span><span class="nam">sys</span><span class="op">.</span><span class="nam">intern</span><span class="op">(</span><span class="nam">space_after</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t99" href="#t99">99</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t100" href="#t100">100</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t101" href="#t101">101</a></span><span class="t"><span class="com"># FIXME: should go into python3-debian</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t102" href="#t102">102</a></span><span class="t"><span class="nam">LIST_COMMA_OR_SPACE_SEPARATED_INTERPRETATION</span> <span class="op">=</span> <span class="nam">ListInterpretation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t103" href="#t103">103</a></span><span class="t"> <span class="nam">comma_or_space_split_tokenizer</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t104" href="#t104">104</a></span><span class="t"> <span class="nam">_parse_whitespace_list_value</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t105" href="#t105">105</a></span><span class="t"> <span class="nam">Deb822ParsedValueElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t106" href="#t106">106</a></span><span class="t"> <span class="nam">Deb822SpaceSeparatorToken</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t107" href="#t107">107</a></span><span class="t"> <span class="nam">Deb822SpaceSeparatorToken</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t108" href="#t108">108</a></span><span class="t"> <span class="nam">_parsed_value_render_factory</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t109" href="#t109">109</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t110" href="#t110">110</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t111" href="#t111">111</a></span><span class="t"><span class="nam">CustomFieldCheck</span> <span class="op">=</span> <span class="nam">Callable</span><span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t112" href="#t112">112</a></span><span class="t"> <span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t113" href="#t113">113</a></span><span class="t"> <span class="str">"F"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t114" href="#t114">114</a></span><span class="t"> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t115" href="#t115">115</a></span><span class="t"> <span class="str">"TERange"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t116" href="#t116">116</a></span><span class="t"> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t117" href="#t117">117</a></span><span class="t"> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t118" href="#t118">118</a></span><span class="t"> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t119" href="#t119">119</a></span><span class="t"> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t120" href="#t120">120</a></span><span class="t"> <span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t121" href="#t121">121</a></span><span class="t"> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t122" href="#t122">122</a></span><span class="t"><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t123" href="#t123">123</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t124" href="#t124">124</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t125" href="#t125">125</a></span><span class="t"><span class="nam">ALL_SECTIONS_WITHOUT_COMPONENT</span> <span class="op">=</span> <span class="nam">frozenset</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t126" href="#t126">126</a></span><span class="t"> <span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t127" href="#t127">127</a></span><span class="t"> <span class="str">"admin"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t128" href="#t128">128</a></span><span class="t"> <span class="str">"cli-mono"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t129" href="#t129">129</a></span><span class="t"> <span class="str">"comm"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t130" href="#t130">130</a></span><span class="t"> <span class="str">"database"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t131" href="#t131">131</a></span><span class="t"> <span class="str">"debian-installer"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t132" href="#t132">132</a></span><span class="t"> <span class="str">"debug"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t133" href="#t133">133</a></span><span class="t"> <span class="str">"devel"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t134" href="#t134">134</a></span><span class="t"> <span class="str">"doc"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t135" href="#t135">135</a></span><span class="t"> <span class="str">"editors"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t136" href="#t136">136</a></span><span class="t"> <span class="str">"education"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t137" href="#t137">137</a></span><span class="t"> <span class="str">"electronics"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t138" href="#t138">138</a></span><span class="t"> <span class="str">"embedded"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t139" href="#t139">139</a></span><span class="t"> <span class="str">"fonts"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t140" href="#t140">140</a></span><span class="t"> <span class="str">"games"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t141" href="#t141">141</a></span><span class="t"> <span class="str">"gnome"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t142" href="#t142">142</a></span><span class="t"> <span class="str">"gnu-r"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t143" href="#t143">143</a></span><span class="t"> <span class="str">"gnustep"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t144" href="#t144">144</a></span><span class="t"> <span class="str">"graphics"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t145" href="#t145">145</a></span><span class="t"> <span class="str">"hamradio"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t146" href="#t146">146</a></span><span class="t"> <span class="str">"haskell"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t147" href="#t147">147</a></span><span class="t"> <span class="str">"interpreters"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t148" href="#t148">148</a></span><span class="t"> <span class="str">"introspection"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t149" href="#t149">149</a></span><span class="t"> <span class="str">"java"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t150" href="#t150">150</a></span><span class="t"> <span class="str">"javascript"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t151" href="#t151">151</a></span><span class="t"> <span class="str">"kde"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t152" href="#t152">152</a></span><span class="t"> <span class="str">"kernel"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t153" href="#t153">153</a></span><span class="t"> <span class="str">"libdevel"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t154" href="#t154">154</a></span><span class="t"> <span class="str">"libs"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t155" href="#t155">155</a></span><span class="t"> <span class="str">"lisp"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t156" href="#t156">156</a></span><span class="t"> <span class="str">"localization"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t157" href="#t157">157</a></span><span class="t"> <span class="str">"mail"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t158" href="#t158">158</a></span><span class="t"> <span class="str">"math"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t159" href="#t159">159</a></span><span class="t"> <span class="str">"metapackages"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t160" href="#t160">160</a></span><span class="t"> <span class="str">"misc"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t161" href="#t161">161</a></span><span class="t"> <span class="str">"net"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t162" href="#t162">162</a></span><span class="t"> <span class="str">"news"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t163" href="#t163">163</a></span><span class="t"> <span class="str">"ocaml"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t164" href="#t164">164</a></span><span class="t"> <span class="str">"oldlibs"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t165" href="#t165">165</a></span><span class="t"> <span class="str">"otherosfs"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t166" href="#t166">166</a></span><span class="t"> <span class="str">"perl"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t167" href="#t167">167</a></span><span class="t"> <span class="str">"php"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t168" href="#t168">168</a></span><span class="t"> <span class="str">"python"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t169" href="#t169">169</a></span><span class="t"> <span class="str">"ruby"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t170" href="#t170">170</a></span><span class="t"> <span class="str">"rust"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t171" href="#t171">171</a></span><span class="t"> <span class="str">"science"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t172" href="#t172">172</a></span><span class="t"> <span class="str">"shells"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t173" href="#t173">173</a></span><span class="t"> <span class="str">"sound"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t174" href="#t174">174</a></span><span class="t"> <span class="str">"tasks"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t175" href="#t175">175</a></span><span class="t"> <span class="str">"tex"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t176" href="#t176">176</a></span><span class="t"> <span class="str">"text"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t177" href="#t177">177</a></span><span class="t"> <span class="str">"utils"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t178" href="#t178">178</a></span><span class="t"> <span class="str">"vcs"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t179" href="#t179">179</a></span><span class="t"> <span class="str">"video"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t180" href="#t180">180</a></span><span class="t"> <span class="str">"virtual"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t181" href="#t181">181</a></span><span class="t"> <span class="str">"web"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t182" href="#t182">182</a></span><span class="t"> <span class="str">"x11"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t183" href="#t183">183</a></span><span class="t"> <span class="str">"xfce"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t184" href="#t184">184</a></span><span class="t"> <span class="str">"zope"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t185" href="#t185">185</a></span><span class="t"> <span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t186" href="#t186">186</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t187" href="#t187">187</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t188" href="#t188">188</a></span><span class="t"><span class="nam">ALL_COMPONENTS</span> <span class="op">=</span> <span class="nam">frozenset</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t189" href="#t189">189</a></span><span class="t"> <span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t190" href="#t190">190</a></span><span class="t"> <span class="str">"main"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t191" href="#t191">191</a></span><span class="t"> <span class="str">"restricted"</span><span class="op">,</span> <span class="com"># Ubuntu</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t192" href="#t192">192</a></span><span class="t"> <span class="str">"non-free"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t193" href="#t193">193</a></span><span class="t"> <span class="str">"non-free-firmware"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t194" href="#t194">194</a></span><span class="t"> <span class="str">"contrib"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t195" href="#t195">195</a></span><span class="t"> <span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t196" href="#t196">196</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t197" href="#t197">197</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t198" href="#t198">198</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t199" href="#t199">199</a></span><span class="t"><span class="key">def</span> <span class="nam">_fields</span><span class="op">(</span><span class="op">*</span><span class="nam">fields</span><span class="op">:</span> <span class="nam">F</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Mapping</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">F</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t200" href="#t200">200</a></span><span class="t"> <span class="key">return</span> <span class="op">{</span><span class="nam">normalize_dctrl_field_name</span><span class="op">(</span><span class="nam">f</span><span class="op">.</span><span class="nam">name</span><span class="op">.</span><span class="nam">lower</span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">:</span> <span class="nam">f</span> <span class="key">for</span> <span class="nam">f</span> <span class="key">in</span> <span class="nam">fields</span><span class="op">}</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t201" href="#t201">201</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t202" href="#t202">202</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t203" href="#t203">203</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">slots</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t204" href="#t204">204</a></span><span class="t"><span class="key">class</span> <span class="nam">Keyword</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t205" href="#t205">205</a></span><span class="t"> <span class="nam">value</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t206" href="#t206">206</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t207" href="#t207">207</a></span><span class="t"> <span class="nam">is_obsolete</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t208" href="#t208">208</a></span><span class="t"> <span class="nam">replaced_by</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t209" href="#t209">209</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t210" href="#t210">210</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t211" href="#t211">211</a></span><span class="t"><span class="key">def</span> <span class="nam">_allowed_values</span><span class="op">(</span><span class="op">*</span><span class="nam">values</span><span class="op">:</span> <span class="nam">Union</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">Keyword</span><span class="op">]</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Mapping</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">Keyword</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t212" href="#t212">212</a></span><span class="t"> <span class="nam">as_keywords</span> <span class="op">=</span> <span class="op">[</span><span class="nam">k</span> <span class="key">if</span> <span class="nam">isinstance</span><span class="op">(</span><span class="nam">k</span><span class="op">,</span> <span class="nam">Keyword</span><span class="op">)</span> <span class="key">else</span> <span class="nam">Keyword</span><span class="op">(</span><span class="nam">k</span><span class="op">)</span> <span class="key">for</span> <span class="nam">k</span> <span class="key">in</span> <span class="nam">values</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t213" href="#t213">213</a></span><span class="t"> <span class="nam">as_mapping</span> <span class="op">=</span> <span class="op">{</span><span class="nam">k</span><span class="op">.</span><span class="nam">value</span><span class="op">:</span> <span class="nam">k</span> <span class="key">for</span> <span class="nam">k</span> <span class="key">in</span> <span class="nam">as_keywords</span> <span class="key">if</span> <span class="nam">k</span><span class="op">.</span><span class="nam">value</span><span class="op">}</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t214" href="#t214">214</a></span><span class="t"> <span class="com"># Simple bug check</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t215" href="#t215">215</a></span><span class="t"> <span class="key">assert</span> <span class="nam">len</span><span class="op">(</span><span class="nam">as_keywords</span><span class="op">)</span> <span class="op">==</span> <span class="nam">len</span><span class="op">(</span><span class="nam">as_mapping</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t216" href="#t216">216</a></span><span class="t"> <span class="key">return</span> <span class="nam">as_mapping</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t217" href="#t217">217</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t218" href="#t218">218</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t219" href="#t219">219</a></span><span class="t"><span class="nam">ALL_SECTIONS</span> <span class="op">=</span> <span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t220" href="#t220">220</a></span><span class="t"> <span class="op">*</span><span class="op">[</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t221" href="#t221">221</a></span><span class="t"> <span class="nam">s</span> <span class="key">if</span> <span class="nam">c</span> <span class="key">is</span> <span class="key">None</span> <span class="key">else</span> <span class="str">f"{c}/{s}"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t222" href="#t222">222</a></span><span class="t"> <span class="key">for</span> <span class="nam">c</span><span class="op">,</span> <span class="nam">s</span> <span class="key">in</span> <span class="nam">itertools</span><span class="op">.</span><span class="nam">product</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t223" href="#t223">223</a></span><span class="t"> <span class="nam">itertools</span><span class="op">.</span><span class="nam">chain</span><span class="op">(</span><span class="nam">cast</span><span class="op">(</span><span class="str">"Iterable[Optional[str]]"</span><span class="op">,</span> <span class="op">[</span><span class="key">None</span><span class="op">]</span><span class="op">)</span><span class="op">,</span> <span class="nam">ALL_COMPONENTS</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t224" href="#t224">224</a></span><span class="t"> <span class="nam">ALL_SECTIONS_WITHOUT_COMPONENT</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t225" href="#t225">225</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t226" href="#t226">226</a></span><span class="t"> <span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t227" href="#t227">227</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t228" href="#t228">228</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t229" href="#t229">229</a></span><span class="t"><span class="nam">ALL_PRIORITIES</span> <span class="op">=</span> <span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t230" href="#t230">230</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t231" href="#t231">231</a></span><span class="t"> <span class="str">"required"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t232" href="#t232">232</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t233" href="#t233">233</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t234" href="#t234">234</a></span><span class="t"><span class="str"> The package is necessary for the proper functioning of the system (read: dpkg needs it).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t235" href="#t235">235</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t236" href="#t236">236</a></span><span class="t"><span class="str"> Applicable if dpkg *needs* this package to function and it is not a library.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t237" href="#t237">237</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t238" href="#t238">238</a></span><span class="t"><span class="str"> No two packages that both have a priority of *standard* or higher may conflict with</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t239" href="#t239">239</a></span><span class="t"><span class="str"> each other.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t240" href="#t240">240</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t241" href="#t241">241</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t242" href="#t242">242</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t243" href="#t243">243</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t244" href="#t244">244</a></span><span class="t"> <span class="str">"important"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t245" href="#t245">245</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t246" href="#t246">246</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t247" href="#t247">247</a></span><span class="t"><span class="str"> The *important* packages are a bare minimum of commonly-expected and necessary tools.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t248" href="#t248">248</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t249" href="#t249">249</a></span><span class="t"><span class="str"> Applicable if 99% of all users in the distribution needs this package and it is not a library.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t250" href="#t250">250</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t251" href="#t251">251</a></span><span class="t"><span class="str"> No two packages that both have a priority of *standard* or higher may conflict with</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t252" href="#t252">252</a></span><span class="t"><span class="str"> each other.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t253" href="#t253">253</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t254" href="#t254">254</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t255" href="#t255">255</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t256" href="#t256">256</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t257" href="#t257">257</a></span><span class="t"> <span class="str">"standard"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t258" href="#t258">258</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t259" href="#t259">259</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t260" href="#t260">260</a></span><span class="t"><span class="str"> These packages provide a reasonable small but not too limited character-mode system. This is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t261" href="#t261">261</a></span><span class="t"><span class="str"> what will be installed by default (by the debian-installer) if the user does not select anything</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t262" href="#t262">262</a></span><span class="t"><span class="str"> else. This does not include many large applications.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t263" href="#t263">263</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t264" href="#t264">264</a></span><span class="t"><span class="str"> Applicable if your distribution installer will install this package by default on a new system</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t265" href="#t265">265</a></span><span class="t"><span class="str"> and it is not a library.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t266" href="#t266">266</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t267" href="#t267">267</a></span><span class="t"><span class="str"> No two packages that both have a priority of *standard* or higher may conflict with</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t268" href="#t268">268</a></span><span class="t"><span class="str"> each other.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t269" href="#t269">269</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t270" href="#t270">270</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t271" href="#t271">271</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t272" href="#t272">272</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t273" href="#t273">273</a></span><span class="t"> <span class="str">"optional"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t274" href="#t274">274</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"This is the default priority and used by the majority of all packages"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t275" href="#t275">275</a></span><span class="t"> <span class="str">" in the Debian archive"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t276" href="#t276">276</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t277" href="#t277">277</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t278" href="#t278">278</a></span><span class="t"> <span class="str">"extra"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t279" href="#t279">279</a></span><span class="t"> <span class="nam">is_obsolete</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t280" href="#t280">280</a></span><span class="t"> <span class="nam">replaced_by</span><span class="op">=</span><span class="str">"optional"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t281" href="#t281">281</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"Obsolete alias of `optional`."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t282" href="#t282">282</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t283" href="#t283">283</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t284" href="#t284">284</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t285" href="#t285">285</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t286" href="#t286">286</a></span><span class="t"><span class="key">def</span> <span class="nam">all_architectures_and_wildcards</span><span class="op">(</span><span class="nam">arch2table</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Union</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">Keyword</span><span class="op">]</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t287" href="#t287">287</a></span><span class="t"> <span class="nam">wildcards</span> <span class="op">=</span> <span class="nam">set</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t288" href="#t288">288</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t289" href="#t289">289</a></span><span class="t"> <span class="str">"any"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t290" href="#t290">290</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t291" href="#t291">291</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t292" href="#t292">292</a></span><span class="t"><span class="str"> The package is an architecture dependent package and need to be compiled for each and every</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t293" href="#t293">293</a></span><span class="t"><span class="str"> architecture it.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t294" href="#t294">294</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t295" href="#t295">295</a></span><span class="t"><span class="str"> The name `any` refers to the fact that this is an architecture *wildcard* matching</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t296" href="#t296">296</a></span><span class="t"><span class="str"> *any machine architecture* supported by dpkg.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t297" href="#t297">297</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t298" href="#t298">298</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t299" href="#t299">299</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t300" href="#t300">300</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t301" href="#t301">301</a></span><span class="t"> <span class="str">"all"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t302" href="#t302">302</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t303" href="#t303">303</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t304" href="#t304">304</a></span><span class="t"><span class="str"> The package is an architecture independent package. This is typically fitting for packages containing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t305" href="#t305">305</a></span><span class="t"><span class="str"> only scripts, data or documentation.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t306" href="#t306">306</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t307" href="#t307">307</a></span><span class="t"><span class="str"> This name `all` refers to the fact that the package can be used for *all* architectures at the same.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t308" href="#t308">308</a></span><span class="t"><span class="str"> Though note that it is still subject to the rules of the `Multi-Arch` field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t309" href="#t309">309</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t310" href="#t310">310</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t311" href="#t311">311</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t312" href="#t312">312</a></span><span class="t"> <span class="key">for</span> <span class="nam">arch_name</span><span class="op">,</span> <span class="nam">quad_tuple</span> <span class="key">in</span> <span class="nam">arch2table</span><span class="op">.</span><span class="nam">items</span><span class="op">(</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t313" href="#t313">313</a></span><span class="t"> <span class="key">yield</span> <span class="nam">arch_name</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t314" href="#t314">314</a></span><span class="t"> <span class="nam">cpu_wc</span> <span class="op">=</span> <span class="str">"any-"</span> <span class="op">+</span> <span class="nam">quad_tuple</span><span class="op">.</span><span class="nam">cpu_name</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t315" href="#t315">315</a></span><span class="t"> <span class="nam">os_wc</span> <span class="op">=</span> <span class="nam">quad_tuple</span><span class="op">.</span><span class="nam">os_name</span> <span class="op">+</span> <span class="str">"-any"</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t316" href="#t316">316</a></span><span class="t"> <span class="key">if</span> <span class="nam">cpu_wc</span> <span class="key">not</span> <span class="key">in</span> <span class="nam">wildcards</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t317" href="#t317">317</a></span><span class="t"> <span class="key">yield</span> <span class="nam">cpu_wc</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t318" href="#t318">318</a></span><span class="t"> <span class="nam">wildcards</span><span class="op">.</span><span class="nam">add</span><span class="op">(</span><span class="nam">cpu_wc</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t319" href="#t319">319</a></span><span class="t"> <span class="key">if</span> <span class="nam">os_wc</span> <span class="key">not</span> <span class="key">in</span> <span class="nam">wildcards</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t320" href="#t320">320</a></span><span class="t"> <span class="key">yield</span> <span class="nam">os_wc</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t321" href="#t321">321</a></span><span class="t"> <span class="nam">wildcards</span><span class="op">.</span><span class="nam">add</span><span class="op">(</span><span class="nam">os_wc</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t322" href="#t322">322</a></span><span class="t"> <span class="com"># Add the remaining wildcards</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t323" href="#t323">323</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t324" href="#t324">324</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t325" href="#t325">325</a></span><span class="t"><span class="op">@</span><span class="nam">functools</span><span class="op">.</span><span class="nam">lru_cache</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t326" href="#t326">326</a></span><span class="t"><span class="key">def</span> <span class="nam">dpkg_arch_and_wildcards</span><span class="op">(</span><span class="op">)</span> <span class="op">-></span> <span class="nam">FrozenSet</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t327" href="#t327">327</a></span><span class="t"> <span class="nam">dpkg_arch_table</span> <span class="op">=</span> <span class="nam">DpkgArchTable</span><span class="op">.</span><span class="nam">load_arch_table</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t328" href="#t328">328</a></span><span class="t"> <span class="key">return</span> <span class="nam">frozenset</span><span class="op">(</span><span class="nam">all_architectures_and_wildcards</span><span class="op">(</span><span class="nam">dpkg_arch_table</span><span class="op">.</span><span class="nam">_arch2table</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t329" href="#t329">329</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t330" href="#t330">330</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t331" href="#t331">331</a></span><span class="t"><span class="key">def</span> <span class="nam">_extract_first_value_and_position</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t332" href="#t332">332</a></span><span class="t"> <span class="nam">kvpair</span><span class="op">:</span> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t333" href="#t333">333</a></span><span class="t"> <span class="nam">stanza_pos</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t334" href="#t334">334</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t335" href="#t335">335</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t336" href="#t336">336</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">Tuple</span><span class="op">[</span><span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">Range</span><span class="op">]</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t337" href="#t337">337</a></span><span class="t"> <span class="nam">kvpair_pos</span> <span class="op">=</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">position_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span><span class="nam">stanza_pos</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t338" href="#t338">338</a></span><span class="t"> <span class="nam">value_element_pos</span> <span class="op">=</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">value_element</span><span class="op">.</span><span class="nam">position_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t339" href="#t339">339</a></span><span class="t"> <span class="nam">kvpair_pos</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t340" href="#t340">340</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t341" href="#t341">341</a></span><span class="t"> <span class="key">for</span> <span class="nam">value_ref</span> <span class="key">in</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">interpret_as</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t342" href="#t342">342</a></span><span class="t"> <span class="nam">LIST_SPACE_SEPARATED_INTERPRETATION</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t343" href="#t343">343</a></span><span class="t"> <span class="op">)</span><span class="op">.</span><span class="nam">iter_value_references</span><span class="op">(</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t344" href="#t344">344</a></span><span class="t"> <span class="nam">v</span> <span class="op">=</span> <span class="nam">value_ref</span><span class="op">.</span><span class="nam">value</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t345" href="#t345">345</a></span><span class="t"> <span class="nam">section_value_loc</span> <span class="op">=</span> <span class="nam">value_ref</span><span class="op">.</span><span class="nam">locatable</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t346" href="#t346">346</a></span><span class="t"> <span class="nam">value_range_te</span> <span class="op">=</span> <span class="nam">section_value_loc</span><span class="op">.</span><span class="nam">range_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t347" href="#t347">347</a></span><span class="t"> <span class="nam">value_element_pos</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t348" href="#t348">348</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t349" href="#t349">349</a></span><span class="t"> <span class="nam">value_range_server_units</span> <span class="op">=</span> <span class="nam">te_range_to_lsp</span><span class="op">(</span><span class="nam">value_range_te</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t350" href="#t350">350</a></span><span class="t"> <span class="nam">value_range</span> <span class="op">=</span> <span class="nam">position_codec</span><span class="op">.</span><span class="nam">range_to_client_units</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t351" href="#t351">351</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> <span class="nam">value_range_server_units</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t352" href="#t352">352</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t353" href="#t353">353</a></span><span class="t"> <span class="key">return</span> <span class="nam">v</span><span class="op">,</span> <span class="nam">value_range</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t354" href="#t354">354</a></span><span class="t"> <span class="key">return</span> <span class="key">None</span><span class="op">,</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t355" href="#t355">355</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t356" href="#t356">356</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t357" href="#t357">357</a></span><span class="t"><span class="key">def</span> <span class="nam">_dctrl_ma_field_validation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t358" href="#t358">358</a></span><span class="t"> <span class="nam">_known_field</span><span class="op">:</span> <span class="str">"F"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t359" href="#t359">359</a></span><span class="t"> <span class="nam">_kvpair</span><span class="op">:</span> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t360" href="#t360">360</a></span><span class="t"> <span class="nam">_field_range</span><span class="op">:</span> <span class="str">"TERange"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t361" href="#t361">361</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t362" href="#t362">362</a></span><span class="t"> <span class="nam">stanza_position</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t363" href="#t363">363</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t364" href="#t364">364</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t365" href="#t365">365</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t366" href="#t366">366</a></span><span class="t"> <span class="nam">ma_kvpair</span> <span class="op">=</span> <span class="nam">stanza</span><span class="op">.</span><span class="nam">get_kvpair_element</span><span class="op">(</span><span class="str">"Multi-Arch"</span><span class="op">,</span> <span class="nam">use_get</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t367" href="#t367">367</a></span><span class="t"> <span class="nam">arch</span> <span class="op">=</span> <span class="nam">stanza</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"Architecture"</span><span class="op">,</span> <span class="str">"any"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t368" href="#t368">368</a></span><span class="t"> <span class="key">if</span> <span class="nam">arch</span> <span class="op">==</span> <span class="str">"all"</span> <span class="key">and</span> <span class="nam">ma_kvpair</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t369" href="#t369">369</a></span><span class="t"> <span class="nam">ma_value</span><span class="op">,</span> <span class="nam">ma_value_range</span> <span class="op">=</span> <span class="nam">_extract_first_value_and_position</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t370" href="#t370">370</a></span><span class="t"> <span class="nam">ma_kvpair</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t371" href="#t371">371</a></span><span class="t"> <span class="nam">stanza_position</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t372" href="#t372">372</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t373" href="#t373">373</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t374" href="#t374">374</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t375" href="#t375">375</a></span><span class="t"> <span class="key">if</span> <span class="nam">ma_value</span> <span class="op">==</span> <span class="str">"same"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t376" href="#t376">376</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t377" href="#t377">377</a></span><span class="t"> <span class="nam">ma_value_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t378" href="#t378">378</a></span><span class="t"> <span class="str">"Multi-Arch: same is not valid for Architecture: all packages. Maybe you want foreign?"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t379" href="#t379">379</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t380" href="#t380">380</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t381" href="#t381">381</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t382" href="#t382">382</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t383" href="#t383">383</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t384" href="#t384">384</a></span><span class="t"><span class="key">def</span> <span class="nam">_udeb_only_field_validation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t385" href="#t385">385</a></span><span class="t"> <span class="nam">known_field</span><span class="op">:</span> <span class="str">"F"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t386" href="#t386">386</a></span><span class="t"> <span class="nam">_kvpair</span><span class="op">:</span> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t387" href="#t387">387</a></span><span class="t"> <span class="nam">field_range_te</span><span class="op">:</span> <span class="str">"TERange"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t388" href="#t388">388</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t389" href="#t389">389</a></span><span class="t"> <span class="nam">_stanza_position</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t390" href="#t390">390</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t391" href="#t391">391</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t392" href="#t392">392</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t393" href="#t393">393</a></span><span class="t"> <span class="nam">package_type</span> <span class="op">=</span> <span class="nam">stanza</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"Package-Type"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t394" href="#t394">394</a></span><span class="t"> <span class="key">if</span> <span class="nam">package_type</span> <span class="op">!=</span> <span class="str">"udeb"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t395" href="#t395">395</a></span><span class="t"> <span class="nam">field_range_server_units</span> <span class="op">=</span> <span class="nam">te_range_to_lsp</span><span class="op">(</span><span class="nam">field_range_te</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t396" href="#t396">396</a></span><span class="t"> <span class="nam">field_range</span> <span class="op">=</span> <span class="nam">position_codec</span><span class="op">.</span><span class="nam">range_to_client_units</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t397" href="#t397">397</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t398" href="#t398">398</a></span><span class="t"> <span class="nam">field_range_server_units</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t399" href="#t399">399</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t400" href="#t400">400</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t401" href="#t401">401</a></span><span class="t"> <span class="nam">field_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t402" href="#t402">402</a></span><span class="t"> <span class="str">f"The {known_field.name} field is only applicable to udeb packages (`Package-Type: udeb`)"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t403" href="#t403">403</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t404" href="#t404">404</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t405" href="#t405">405</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t406" href="#t406">406</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t407" href="#t407">407</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t408" href="#t408">408</a></span><span class="t"><span class="key">def</span> <span class="nam">_arch_not_all_only_field_validation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t409" href="#t409">409</a></span><span class="t"> <span class="nam">known_field</span><span class="op">:</span> <span class="str">"F"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t410" href="#t410">410</a></span><span class="t"> <span class="nam">_kvpair</span><span class="op">:</span> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t411" href="#t411">411</a></span><span class="t"> <span class="nam">field_range_te</span><span class="op">:</span> <span class="str">"TERange"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t412" href="#t412">412</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t413" href="#t413">413</a></span><span class="t"> <span class="nam">_stanza_position</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t414" href="#t414">414</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t415" href="#t415">415</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t416" href="#t416">416</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t417" href="#t417">417</a></span><span class="t"> <span class="nam">architecture</span> <span class="op">=</span> <span class="nam">stanza</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="str">"Architecture"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t418" href="#t418">418</a></span><span class="t"> <span class="key">if</span> <span class="nam">architecture</span> <span class="op">==</span> <span class="str">"all"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t419" href="#t419">419</a></span><span class="t"> <span class="nam">field_range_server_units</span> <span class="op">=</span> <span class="nam">te_range_to_lsp</span><span class="op">(</span><span class="nam">field_range_te</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t420" href="#t420">420</a></span><span class="t"> <span class="nam">field_range</span> <span class="op">=</span> <span class="nam">position_codec</span><span class="op">.</span><span class="nam">range_to_client_units</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t421" href="#t421">421</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t422" href="#t422">422</a></span><span class="t"> <span class="nam">field_range_server_units</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t423" href="#t423">423</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t424" href="#t424">424</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t425" href="#t425">425</a></span><span class="t"> <span class="nam">field_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t426" href="#t426">426</a></span><span class="t"> <span class="str">f"The {known_field.name} field is not applicable to arch:all packages (`Architecture: all`)"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t427" href="#t427">427</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t428" href="#t428">428</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t429" href="#t429">429</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t430" href="#t430">430</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t431" href="#t431">431</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t432" href="#t432">432</a></span><span class="t"><span class="key">def</span> <span class="nam">_each_value_match_regex_validation</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t433" href="#t433">433</a></span><span class="t"> <span class="nam">regex</span><span class="op">:</span> <span class="nam">re</span><span class="op">.</span><span class="nam">Pattern</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t434" href="#t434">434</a></span><span class="t"> <span class="op">*</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t435" href="#t435">435</a></span><span class="t"> <span class="nam">diagnostic_severity</span><span class="op">:</span> <span class="nam">DiagnosticSeverity</span> <span class="op">=</span> <span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t436" href="#t436">436</a></span><span class="t"><span class="op">)</span> <span class="op">-></span> <span class="nam">CustomFieldCheck</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t437" href="#t437">437</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t438" href="#t438">438</a></span><span class="t"> <span class="key">def</span> <span class="nam">_validator</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t439" href="#t439">439</a></span><span class="t"> <span class="nam">_known_field</span><span class="op">:</span> <span class="str">"F"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t440" href="#t440">440</a></span><span class="t"> <span class="nam">kvpair</span><span class="op">:</span> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t441" href="#t441">441</a></span><span class="t"> <span class="nam">field_range_te</span><span class="op">:</span> <span class="str">"TERange"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t442" href="#t442">442</a></span><span class="t"> <span class="nam">_stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t443" href="#t443">443</a></span><span class="t"> <span class="nam">_stanza_position</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t444" href="#t444">444</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t445" href="#t445">445</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t446" href="#t446">446</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t447" href="#t447">447</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t448" href="#t448">448</a></span><span class="t"> <span class="nam">value_element_pos</span> <span class="op">=</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">value_element</span><span class="op">.</span><span class="nam">position_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t449" href="#t449">449</a></span><span class="t"> <span class="nam">field_range_te</span><span class="op">.</span><span class="nam">start_pos</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t450" href="#t450">450</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t451" href="#t451">451</a></span><span class="t"> <span class="key">for</span> <span class="nam">value_ref</span> <span class="key">in</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">interpret_as</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t452" href="#t452">452</a></span><span class="t"> <span class="nam">LIST_SPACE_SEPARATED_INTERPRETATION</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t453" href="#t453">453</a></span><span class="t"> <span class="op">)</span><span class="op">.</span><span class="nam">iter_value_references</span><span class="op">(</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t454" href="#t454">454</a></span><span class="t"> <span class="nam">v</span> <span class="op">=</span> <span class="nam">value_ref</span><span class="op">.</span><span class="nam">value</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t455" href="#t455">455</a></span><span class="t"> <span class="nam">m</span> <span class="op">=</span> <span class="nam">regex</span><span class="op">.</span><span class="nam">fullmatch</span><span class="op">(</span><span class="nam">v</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t456" href="#t456">456</a></span><span class="t"> <span class="key">if</span> <span class="nam">m</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">456 ↛ 459</span><span class="annotate long">line 456 didn't jump to line 459, because the condition on line 456 was never false</span></span></p> - <p class="run"><span class="n"><a id="t457" href="#t457">457</a></span><span class="t"> <span class="key">continue</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t458" href="#t458">458</a></span><span class="t"> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t459" href="#t459">459</a></span><span class="t"> <span class="nam">section_value_loc</span> <span class="op">=</span> <span class="nam">value_ref</span><span class="op">.</span><span class="nam">locatable</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t460" href="#t460">460</a></span><span class="t"> <span class="nam">value_range_te</span> <span class="op">=</span> <span class="nam">section_value_loc</span><span class="op">.</span><span class="nam">range_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t461" href="#t461">461</a></span><span class="t"> <span class="nam">value_element_pos</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t462" href="#t462">462</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t463" href="#t463">463</a></span><span class="t"> <span class="nam">value_range_server_units</span> <span class="op">=</span> <span class="nam">te_range_to_lsp</span><span class="op">(</span><span class="nam">value_range_te</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t464" href="#t464">464</a></span><span class="t"> <span class="nam">value_range</span> <span class="op">=</span> <span class="nam">position_codec</span><span class="op">.</span><span class="nam">range_to_client_units</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t465" href="#t465">465</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> <span class="nam">value_range_server_units</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t466" href="#t466">466</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t467" href="#t467">467</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t468" href="#t468">468</a></span><span class="t"> <span class="nam">value_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t469" href="#t469">469</a></span><span class="t"> <span class="str">f'The value "{v}" does not match the regex {regex.pattern}.'</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t470" href="#t470">470</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">diagnostic_severity</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t471" href="#t471">471</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t472" href="#t472">472</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t473" href="#t473">473</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t474" href="#t474">474</a></span><span class="t"> <span class="key">return</span> <span class="nam">_validator</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t475" href="#t475">475</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t476" href="#t476">476</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t477" href="#t477">477</a></span><span class="t"><span class="key">def</span> <span class="nam">_combined_custom_field_check</span><span class="op">(</span><span class="op">*</span><span class="nam">checks</span><span class="op">:</span> <span class="nam">CustomFieldCheck</span><span class="op">)</span> <span class="op">-></span> <span class="nam">CustomFieldCheck</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t478" href="#t478">478</a></span><span class="t"> <span class="key">def</span> <span class="nam">_validator</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t479" href="#t479">479</a></span><span class="t"> <span class="nam">known_field</span><span class="op">:</span> <span class="str">"F"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t480" href="#t480">480</a></span><span class="t"> <span class="nam">kvpair</span><span class="op">:</span> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t481" href="#t481">481</a></span><span class="t"> <span class="nam">field_range_te</span><span class="op">:</span> <span class="str">"TERange"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t482" href="#t482">482</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t483" href="#t483">483</a></span><span class="t"> <span class="nam">stanza_position</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t484" href="#t484">484</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t485" href="#t485">485</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t486" href="#t486">486</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t487" href="#t487">487</a></span><span class="t"> <span class="key">for</span> <span class="nam">check</span> <span class="key">in</span> <span class="nam">checks</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t488" href="#t488">488</a></span><span class="t"> <span class="key">yield</span> <span class="key">from</span> <span class="nam">check</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t489" href="#t489">489</a></span><span class="t"> <span class="nam">known_field</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t490" href="#t490">490</a></span><span class="t"> <span class="nam">kvpair</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t491" href="#t491">491</a></span><span class="t"> <span class="nam">field_range_te</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t492" href="#t492">492</a></span><span class="t"> <span class="nam">stanza</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t493" href="#t493">493</a></span><span class="t"> <span class="nam">stanza_position</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t494" href="#t494">494</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t495" href="#t495">495</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t496" href="#t496">496</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t497" href="#t497">497</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t498" href="#t498">498</a></span><span class="t"> <span class="key">return</span> <span class="nam">_validator</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t499" href="#t499">499</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t500" href="#t500">500</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t501" href="#t501">501</a></span><span class="t"><span class="key">class</span> <span class="nam">FieldValueClass</span><span class="op">(</span><span class="nam">Enum</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t502" href="#t502">502</a></span><span class="t"> <span class="nam">SINGLE_VALUE</span> <span class="op">=</span> <span class="nam">auto</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> <span class="nam">LIST_SPACE_SEPARATED_INTERPRETATION</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t503" href="#t503">503</a></span><span class="t"> <span class="nam">SPACE_SEPARATED_LIST</span> <span class="op">=</span> <span class="nam">auto</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> <span class="nam">LIST_SPACE_SEPARATED_INTERPRETATION</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t504" href="#t504">504</a></span><span class="t"> <span class="nam">BUILD_PROFILES_LIST</span> <span class="op">=</span> <span class="nam">auto</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> <span class="key">None</span> <span class="com"># TODO</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t505" href="#t505">505</a></span><span class="t"> <span class="nam">COMMA_SEPARATED_LIST</span> <span class="op">=</span> <span class="nam">auto</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> <span class="nam">LIST_COMMA_SEPARATED_INTERPRETATION</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t506" href="#t506">506</a></span><span class="t"> <span class="nam">COMMA_SEPARATED_EMAIL_LIST</span> <span class="op">=</span> <span class="nam">auto</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> <span class="nam">LIST_UPLOADERS_INTERPRETATION</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t507" href="#t507">507</a></span><span class="t"> <span class="nam">COMMA_OR_SPACE_SEPARATED_LIST</span> <span class="op">=</span> <span class="nam">auto</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> <span class="nam">LIST_COMMA_OR_SPACE_SEPARATED_INTERPRETATION</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t508" href="#t508">508</a></span><span class="t"> <span class="nam">FREE_TEXT_FIELD</span> <span class="op">=</span> <span class="nam">auto</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t509" href="#t509">509</a></span><span class="t"> <span class="nam">DEP5_FILE_LIST</span> <span class="op">=</span> <span class="nam">auto</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> <span class="key">None</span> <span class="com"># TODO</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t510" href="#t510">510</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t511" href="#t511">511</a></span><span class="t"> <span class="key">def</span> <span class="nam">interpreter</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">Interpretation</span><span class="op">[</span><span class="nam">Any</span><span class="op">]</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t512" href="#t512">512</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">value</span><span class="op">[</span><span class="num">1</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t513" href="#t513">513</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t514" href="#t514">514</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t515" href="#t515">515</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">slots</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t516" href="#t516">516</a></span><span class="t"><span class="key">class</span> <span class="nam">Deb822KnownField</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t517" href="#t517">517</a></span><span class="t"> <span class="nam">name</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t518" href="#t518">518</a></span><span class="t"> <span class="nam">field_value_class</span><span class="op">:</span> <span class="nam">FieldValueClass</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t519" href="#t519">519</a></span><span class="t"> <span class="nam">warn_if_default</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t520" href="#t520">520</a></span><span class="t"> <span class="nam">replaced_by</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t521" href="#t521">521</a></span><span class="t"> <span class="nam">deprecated_with_no_replacement</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t522" href="#t522">522</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">DiagnosticSeverity</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t523" href="#t523">523</a></span><span class="t"> <span class="nam">default_value</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t524" href="#t524">524</a></span><span class="t"> <span class="nam">known_values</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">Mapping</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">Keyword</span><span class="op">]</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t525" href="#t525">525</a></span><span class="t"> <span class="nam">unknown_value_diagnostic_severity</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">DiagnosticSeverity</span><span class="op">]</span> <span class="op">=</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t526" href="#t526">526</a></span><span class="t"> <span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t527" href="#t527">527</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t528" href="#t528">528</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t529" href="#t529">529</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t530" href="#t530">530</a></span><span class="t"> <span class="nam">is_stanza_name</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t531" href="#t531">531</a></span><span class="t"> <span class="nam">is_single_value_field</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t532" href="#t532">532</a></span><span class="t"> <span class="nam">custom_field_check</span><span class="op">:</span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">CustomFieldCheck</span><span class="op">]</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t533" href="#t533">533</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t534" href="#t534">534</a></span><span class="t"> <span class="key">def</span> <span class="nam">field_diagnostics</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t535" href="#t535">535</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t536" href="#t536">536</a></span><span class="t"> <span class="nam">kvpair</span><span class="op">:</span> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t537" href="#t537">537</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t538" href="#t538">538</a></span><span class="t"> <span class="nam">stanza_position</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t539" href="#t539">539</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t540" href="#t540">540</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t541" href="#t541">541</a></span><span class="t"> <span class="op">*</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t542" href="#t542">542</a></span><span class="t"> <span class="nam">field_name_typo_reported</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t543" href="#t543">543</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t544" href="#t544">544</a></span><span class="t"> <span class="nam">field_name_token</span> <span class="op">=</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">field_token</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t545" href="#t545">545</a></span><span class="t"> <span class="nam">field_range_te</span> <span class="op">=</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">range_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span><span class="nam">stanza_position</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t546" href="#t546">546</a></span><span class="t"> <span class="nam">field_position_te</span> <span class="op">=</span> <span class="nam">field_range_te</span><span class="op">.</span><span class="nam">start_pos</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t547" href="#t547">547</a></span><span class="t"> <span class="key">yield</span> <span class="key">from</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_diagnostics_for_field_name</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t548" href="#t548">548</a></span><span class="t"> <span class="nam">field_name_token</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t549" href="#t549">549</a></span><span class="t"> <span class="nam">field_position_te</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t550" href="#t550">550</a></span><span class="t"> <span class="nam">field_name_typo_reported</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t551" href="#t551">551</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t552" href="#t552">552</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t553" href="#t553">553</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t554" href="#t554">554</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">custom_field_check</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t555" href="#t555">555</a></span><span class="t"> <span class="key">yield</span> <span class="key">from</span> <span class="nam">self</span><span class="op">.</span><span class="nam">custom_field_check</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t556" href="#t556">556</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t557" href="#t557">557</a></span><span class="t"> <span class="nam">kvpair</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t558" href="#t558">558</a></span><span class="t"> <span class="nam">field_range_te</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t559" href="#t559">559</a></span><span class="t"> <span class="nam">stanza</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t560" href="#t560">560</a></span><span class="t"> <span class="nam">stanza_position</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t561" href="#t561">561</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t562" href="#t562">562</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t563" href="#t563">563</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t564" href="#t564">564</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">self</span><span class="op">.</span><span class="nam">spellcheck_value</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t565" href="#t565">565</a></span><span class="t"> <span class="key">yield</span> <span class="key">from</span> <span class="nam">self</span><span class="op">.</span><span class="nam">_known_value_diagnostics</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t566" href="#t566">566</a></span><span class="t"> <span class="nam">kvpair</span><span class="op">,</span> <span class="nam">field_position_te</span><span class="op">,</span> <span class="nam">position_codec</span><span class="op">,</span> <span class="nam">lines</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t567" href="#t567">567</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t568" href="#t568">568</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t569" href="#t569">569</a></span><span class="t"> <span class="key">def</span> <span class="nam">_diagnostics_for_field_name</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t570" href="#t570">570</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t571" href="#t571">571</a></span><span class="t"> <span class="nam">token</span><span class="op">:</span> <span class="nam">Deb822FieldNameToken</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t572" href="#t572">572</a></span><span class="t"> <span class="nam">token_position</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t573" href="#t573">573</a></span><span class="t"> <span class="nam">typo_detected</span><span class="op">:</span> <span class="nam">bool</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t574" href="#t574">574</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t575" href="#t575">575</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t576" href="#t576">576</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t577" href="#t577">577</a></span><span class="t"> <span class="nam">field_name</span> <span class="op">=</span> <span class="nam">token</span><span class="op">.</span><span class="nam">text</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t578" href="#t578">578</a></span><span class="t"> <span class="com"># Defeat the case-insensitivity from python-debian</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t579" href="#t579">579</a></span><span class="t"> <span class="nam">field_name_cased</span> <span class="op">=</span> <span class="nam">str</span><span class="op">(</span><span class="nam">field_name</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t580" href="#t580">580</a></span><span class="t"> <span class="nam">token_range_server_units</span> <span class="op">=</span> <span class="nam">te_range_to_lsp</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t581" href="#t581">581</a></span><span class="t"> <span class="nam">TERange</span><span class="op">.</span><span class="nam">from_position_and_size</span><span class="op">(</span><span class="nam">token_position</span><span class="op">,</span> <span class="nam">token</span><span class="op">.</span><span class="nam">size</span><span class="op">(</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t582" href="#t582">582</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t583" href="#t583">583</a></span><span class="t"> <span class="nam">token_range</span> <span class="op">=</span> <span class="nam">position_codec</span><span class="op">.</span><span class="nam">range_to_client_units</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t584" href="#t584">584</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t585" href="#t585">585</a></span><span class="t"> <span class="nam">token_range_server_units</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t586" href="#t586">586</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t587" href="#t587">587</a></span><span class="t"> <span class="key">if</span> <span class="nam">self</span><span class="op">.</span><span class="nam">deprecated_with_no_replacement</span><span class="op">:</span> </span><span class="r"><span class="annotate short">587 ↛ 588</span><span class="annotate long">line 587 didn't jump to line 588, because the condition on line 587 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t588" href="#t588">588</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t589" href="#t589">589</a></span><span class="t"> <span class="nam">token_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t590" href="#t590">590</a></span><span class="t"> <span class="str">f"{field_name_cased} is deprecated and no longer used"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t591" href="#t591">591</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t592" href="#t592">592</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t593" href="#t593">593</a></span><span class="t"> <span class="nam">tags</span><span class="op">=</span><span class="op">[</span><span class="nam">DiagnosticTag</span><span class="op">.</span><span class="nam">Deprecated</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t594" href="#t594">594</a></span><span class="t"> <span class="nam">data</span><span class="op">=</span><span class="nam">propose_remove_line_quick_fix</span><span class="op">(</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t595" href="#t595">595</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t596" href="#t596">596</a></span><span class="t"> <span class="key">elif</span> <span class="nam">self</span><span class="op">.</span><span class="nam">replaced_by</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">596 ↛ 597</span><span class="annotate long">line 596 didn't jump to line 597, because the condition on line 596 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t597" href="#t597">597</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t598" href="#t598">598</a></span><span class="t"> <span class="nam">token_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t599" href="#t599">599</a></span><span class="t"> <span class="str">f"{field_name_cased} is a deprecated name for {self.replaced_by}"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t600" href="#t600">600</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t601" href="#t601">601</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t602" href="#t602">602</a></span><span class="t"> <span class="nam">tags</span><span class="op">=</span><span class="op">[</span><span class="nam">DiagnosticTag</span><span class="op">.</span><span class="nam">Deprecated</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t603" href="#t603">603</a></span><span class="t"> <span class="nam">data</span><span class="op">=</span><span class="nam">propose_correct_text_quick_fix</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">replaced_by</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t604" href="#t604">604</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t605" href="#t605">605</a></span><span class="t"> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t606" href="#t606">606</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">typo_detected</span> <span class="key">and</span> <span class="nam">field_name_cased</span> <span class="op">!=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">name</span><span class="op">:</span> </span><span class="r"><span class="annotate short">606 ↛ 607</span><span class="annotate long">line 606 didn't jump to line 607, because the condition on line 606 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t607" href="#t607">607</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t608" href="#t608">608</a></span><span class="t"> <span class="nam">token_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t609" href="#t609">609</a></span><span class="t"> <span class="str">f"Non-canonical spelling of {self.name}"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t610" href="#t610">610</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Information</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t611" href="#t611">611</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t612" href="#t612">612</a></span><span class="t"> <span class="nam">data</span><span class="op">=</span><span class="nam">propose_correct_text_quick_fix</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">name</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t613" href="#t613">613</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t614" href="#t614">614</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t615" href="#t615">615</a></span><span class="t"> <span class="key">def</span> <span class="nam">_known_value_diagnostics</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t616" href="#t616">616</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t617" href="#t617">617</a></span><span class="t"> <span class="nam">kvpair</span><span class="op">:</span> <span class="nam">Deb822KeyValuePairElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t618" href="#t618">618</a></span><span class="t"> <span class="nam">field_position_te</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t619" href="#t619">619</a></span><span class="t"> <span class="nam">position_codec</span><span class="op">:</span> <span class="str">"LintCapablePositionCodec"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t620" href="#t620">620</a></span><span class="t"> <span class="nam">lines</span><span class="op">:</span> <span class="nam">List</span><span class="op">[</span><span class="nam">str</span><span class="op">]</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t621" href="#t621">621</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t622" href="#t622">622</a></span><span class="t"> <span class="nam">unknown_value_severity</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">unknown_value_diagnostic_severity</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t623" href="#t623">623</a></span><span class="t"> <span class="nam">allowed_values</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">known_values</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t624" href="#t624">624</a></span><span class="t"> <span class="nam">interpreter</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">field_value_class</span><span class="op">.</span><span class="nam">interpreter</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t625" href="#t625">625</a></span><span class="t"> <span class="key">if</span> <span class="key">not</span> <span class="nam">allowed_values</span> <span class="key">or</span> <span class="nam">interpreter</span> <span class="key">is</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t626" href="#t626">626</a></span><span class="t"> <span class="key">return</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t627" href="#t627">627</a></span><span class="t"> <span class="nam">hint_text</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t628" href="#t628">628</a></span><span class="t"> <span class="nam">values</span> <span class="op">=</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">interpret_as</span><span class="op">(</span><span class="nam">interpreter</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t629" href="#t629">629</a></span><span class="t"> <span class="nam">value_off</span> <span class="op">=</span> <span class="nam">kvpair</span><span class="op">.</span><span class="nam">value_element</span><span class="op">.</span><span class="nam">position_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t630" href="#t630">630</a></span><span class="t"> <span class="nam">field_position_te</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t631" href="#t631">631</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t632" href="#t632">632</a></span><span class="t"> <span class="nam">first_value</span> <span class="op">=</span> <span class="key">True</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t633" href="#t633">633</a></span><span class="t"> <span class="key">for</span> <span class="nam">value_ref</span> <span class="key">in</span> <span class="nam">values</span><span class="op">.</span><span class="nam">iter_value_references</span><span class="op">(</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t634" href="#t634">634</a></span><span class="t"> <span class="nam">value</span> <span class="op">=</span> <span class="nam">value_ref</span><span class="op">.</span><span class="nam">value</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t635" href="#t635">635</a></span><span class="t"> <span class="key">if</span> <span class="op">(</span> </span><span class="r"><span class="annotate short">635 ↛ 639</span><span class="annotate long">line 635 didn't jump to line 639</span></span></p> - <p class="pln"><span class="n"><a id="t636" href="#t636">636</a></span><span class="t"> <span class="key">not</span> <span class="nam">first_value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t637" href="#t637">637</a></span><span class="t"> <span class="key">and</span> <span class="nam">self</span><span class="op">.</span><span class="nam">field_value_class</span> <span class="op">==</span> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t638" href="#t638">638</a></span><span class="t"> <span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t639" href="#t639">639</a></span><span class="t"> <span class="nam">value_loc</span> <span class="op">=</span> <span class="nam">value_ref</span><span class="op">.</span><span class="nam">locatable</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t640" href="#t640">640</a></span><span class="t"> <span class="nam">value_position_te</span> <span class="op">=</span> <span class="nam">value_loc</span><span class="op">.</span><span class="nam">position_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t641" href="#t641">641</a></span><span class="t"> <span class="nam">value_off</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t642" href="#t642">642</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t643" href="#t643">643</a></span><span class="t"> <span class="nam">value_range_in_server_units</span> <span class="op">=</span> <span class="nam">te_range_to_lsp</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t644" href="#t644">644</a></span><span class="t"> <span class="nam">TERange</span><span class="op">.</span><span class="nam">from_position_and_size</span><span class="op">(</span><span class="nam">value_position_te</span><span class="op">,</span> <span class="nam">value_loc</span><span class="op">.</span><span class="nam">size</span><span class="op">(</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t645" href="#t645">645</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t646" href="#t646">646</a></span><span class="t"> <span class="nam">value_range</span> <span class="op">=</span> <span class="nam">position_codec</span><span class="op">.</span><span class="nam">range_to_client_units</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t647" href="#t647">647</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t648" href="#t648">648</a></span><span class="t"> <span class="nam">value_range_in_server_units</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t649" href="#t649">649</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t650" href="#t650">650</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t651" href="#t651">651</a></span><span class="t"> <span class="nam">value_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t652" href="#t652">652</a></span><span class="t"> <span class="str">f"The field {self.name} can only have exactly one value."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t653" href="#t653">653</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t654" href="#t654">654</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t655" href="#t655">655</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t656" href="#t656">656</a></span><span class="t"> <span class="com"># TODO: Add quickfix if the value is also invalid</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t657" href="#t657">657</a></span><span class="t"> <span class="key">continue</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t658" href="#t658">658</a></span><span class="t"> <span class="nam">first_value</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t659" href="#t659">659</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t660" href="#t660">660</a></span><span class="t"> <span class="nam">known_value</span> <span class="op">=</span> <span class="nam">self</span><span class="op">.</span><span class="nam">known_values</span><span class="op">.</span><span class="nam">get</span><span class="op">(</span><span class="nam">value</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t661" href="#t661">661</a></span><span class="t"> <span class="key">if</span> <span class="nam">known_value</span> <span class="key">is</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t662" href="#t662">662</a></span><span class="t"> <span class="nam">candidates</span> <span class="op">=</span> <span class="nam">detect_possible_typo</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t663" href="#t663">663</a></span><span class="t"> <span class="nam">value</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t664" href="#t664">664</a></span><span class="t"> <span class="nam">self</span><span class="op">.</span><span class="nam">known_values</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t665" href="#t665">665</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t666" href="#t666">666</a></span><span class="t"> <span class="key">if</span> <span class="nam">hint_text</span> <span class="key">is</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">666 ↛ 672</span><span class="annotate long">line 666 didn't jump to line 672, because the condition on line 666 was never false</span></span></p> - <p class="par run show_par"><span class="n"><a id="t667" href="#t667">667</a></span><span class="t"> <span class="key">if</span> <span class="nam">len</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">known_values</span><span class="op">)</span> <span class="op"><</span> <span class="num">5</span><span class="op">:</span> </span><span class="r"><span class="annotate short">667 ↛ 668</span><span class="annotate long">line 667 didn't jump to line 668, because the condition on line 667 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t668" href="#t668">668</a></span><span class="t"> <span class="nam">values</span> <span class="op">=</span> <span class="str">", "</span><span class="op">.</span><span class="nam">join</span><span class="op">(</span><span class="nam">sorted</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">known_values</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t669" href="#t669">669</a></span><span class="t"> <span class="nam">hint_text</span> <span class="op">=</span> <span class="str">f" Known values for this field: {values}"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t670" href="#t670">670</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t671" href="#t671">671</a></span><span class="t"> <span class="nam">hint_text</span> <span class="op">=</span> <span class="str">""</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t672" href="#t672">672</a></span><span class="t"> <span class="nam">fix_data</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t673" href="#t673">673</a></span><span class="t"> <span class="nam">severity</span> <span class="op">=</span> <span class="nam">unknown_value_severity</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t674" href="#t674">674</a></span><span class="t"> <span class="nam">fix_text</span> <span class="op">=</span> <span class="nam">hint_text</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t675" href="#t675">675</a></span><span class="t"> <span class="key">if</span> <span class="nam">candidates</span><span class="op">:</span> </span><span class="r"><span class="annotate short">675 ↛ 676</span><span class="annotate long">line 675 didn't jump to line 676, because the condition on line 675 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t676" href="#t676">676</a></span><span class="t"> <span class="nam">match</span> <span class="op">=</span> <span class="nam">candidates</span><span class="op">[</span><span class="num">0</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t677" href="#t677">677</a></span><span class="t"> <span class="nam">fix_text</span> <span class="op">=</span> <span class="str">f' It is possible that the value is a typo of "{match}".{fix_text}'</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t678" href="#t678">678</a></span><span class="t"> <span class="nam">fix_data</span> <span class="op">=</span> <span class="op">[</span><span class="nam">propose_correct_text_quick_fix</span><span class="op">(</span><span class="nam">m</span><span class="op">)</span> <span class="key">for</span> <span class="nam">m</span> <span class="key">in</span> <span class="nam">candidates</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t679" href="#t679">679</a></span><span class="t"> <span class="key">elif</span> <span class="nam">severity</span> <span class="key">is</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">679 ↛ 680</span><span class="annotate long">line 679 didn't jump to line 680, because the condition on line 679 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t680" href="#t680">680</a></span><span class="t"> <span class="key">continue</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t681" href="#t681">681</a></span><span class="t"> <span class="key">if</span> <span class="nam">severity</span> <span class="key">is</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"><span class="annotate short">681 ↛ 682</span><span class="annotate long">line 681 didn't jump to line 682, because the condition on line 681 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t682" href="#t682">682</a></span><span class="t"> <span class="nam">severity</span> <span class="op">=</span> <span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t683" href="#t683">683</a></span><span class="t"> <span class="nam">message</span> <span class="op">=</span> <span class="nam">fix_text</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t684" href="#t684">684</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t685" href="#t685">685</a></span><span class="t"> <span class="nam">message</span> <span class="op">=</span> <span class="str">f'The value "{value}" is not supported in {self.name}.{fix_text}'</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t686" href="#t686">686</a></span><span class="t"> <span class="key">elif</span> <span class="nam">known_value</span><span class="op">.</span><span class="nam">is_obsolete</span><span class="op">:</span> </span><span class="r"><span class="annotate short">686 ↛ 687</span><span class="annotate long">line 686 didn't jump to line 687, because the condition on line 686 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t687" href="#t687">687</a></span><span class="t"> <span class="nam">replacement</span> <span class="op">=</span> <span class="nam">known_value</span><span class="op">.</span><span class="nam">replaced_by</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t688" href="#t688">688</a></span><span class="t"> <span class="key">if</span> <span class="nam">replacement</span> <span class="key">is</span> <span class="key">not</span> <span class="key">None</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t689" href="#t689">689</a></span><span class="t"> <span class="nam">message</span> <span class="op">=</span> <span class="str">f'The value "{value}" has been replaced by {replacement}'</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t690" href="#t690">690</a></span><span class="t"> <span class="nam">severity</span> <span class="op">=</span> <span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t691" href="#t691">691</a></span><span class="t"> <span class="nam">fix_data</span> <span class="op">=</span> <span class="op">[</span><span class="nam">propose_correct_text_quick_fix</span><span class="op">(</span><span class="nam">replacement</span><span class="op">)</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t692" href="#t692">692</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t693" href="#t693">693</a></span><span class="t"> <span class="nam">message</span> <span class="op">=</span> <span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t694" href="#t694">694</a></span><span class="t"> <span class="str">f'The value "{value}" is obsolete without a single replacement'</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t695" href="#t695">695</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t696" href="#t696">696</a></span><span class="t"> <span class="nam">severity</span> <span class="op">=</span> <span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t697" href="#t697">697</a></span><span class="t"> <span class="nam">fix_data</span> <span class="op">=</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t698" href="#t698">698</a></span><span class="t"> <span class="key">else</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t699" href="#t699">699</a></span><span class="t"> <span class="com"># All good</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t700" href="#t700">700</a></span><span class="t"> <span class="key">continue</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t701" href="#t701">701</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t702" href="#t702">702</a></span><span class="t"> <span class="nam">value_loc</span> <span class="op">=</span> <span class="nam">value_ref</span><span class="op">.</span><span class="nam">locatable</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t703" href="#t703">703</a></span><span class="t"> <span class="nam">value_position_te</span> <span class="op">=</span> <span class="nam">value_loc</span><span class="op">.</span><span class="nam">position_in_parent</span><span class="op">(</span><span class="op">)</span><span class="op">.</span><span class="nam">relative_to</span><span class="op">(</span><span class="nam">value_off</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t704" href="#t704">704</a></span><span class="t"> <span class="nam">value_range_in_server_units</span> <span class="op">=</span> <span class="nam">te_range_to_lsp</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t705" href="#t705">705</a></span><span class="t"> <span class="nam">TERange</span><span class="op">.</span><span class="nam">from_position_and_size</span><span class="op">(</span><span class="nam">value_position_te</span><span class="op">,</span> <span class="nam">value_loc</span><span class="op">.</span><span class="nam">size</span><span class="op">(</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t706" href="#t706">706</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t707" href="#t707">707</a></span><span class="t"> <span class="nam">value_range</span> <span class="op">=</span> <span class="nam">position_codec</span><span class="op">.</span><span class="nam">range_to_client_units</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t708" href="#t708">708</a></span><span class="t"> <span class="nam">lines</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t709" href="#t709">709</a></span><span class="t"> <span class="nam">value_range_in_server_units</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t710" href="#t710">710</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t711" href="#t711">711</a></span><span class="t"> <span class="key">yield</span> <span class="nam">Diagnostic</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t712" href="#t712">712</a></span><span class="t"> <span class="nam">value_range</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t713" href="#t713">713</a></span><span class="t"> <span class="nam">message</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t714" href="#t714">714</a></span><span class="t"> <span class="nam">severity</span><span class="op">=</span><span class="nam">severity</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t715" href="#t715">715</a></span><span class="t"> <span class="nam">source</span><span class="op">=</span><span class="str">"debputy"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t716" href="#t716">716</a></span><span class="t"> <span class="nam">data</span><span class="op">=</span><span class="nam">fix_data</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t717" href="#t717">717</a></span><span class="t"> <span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t718" href="#t718">718</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t719" href="#t719">719</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t720" href="#t720">720</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">slots</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t721" href="#t721">721</a></span><span class="t"><span class="key">class</span> <span class="nam">DctrlKnownField</span><span class="op">(</span><span class="nam">Deb822KnownField</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t722" href="#t722">722</a></span><span class="t"> <span class="nam">inherits_from_source</span><span class="op">:</span> <span class="nam">bool</span> <span class="op">=</span> <span class="key">False</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t723" href="#t723">723</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t724" href="#t724">724</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t725" href="#t725">725</a></span><span class="t"><span class="nam">SOURCE_FIELDS</span> <span class="op">=</span> <span class="nam">_fields</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t726" href="#t726">726</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t727" href="#t727">727</a></span><span class="t"> <span class="str">"Source"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t728" href="#t728">728</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t729" href="#t729">729</a></span><span class="t"> <span class="nam">custom_field_check</span><span class="op">=</span><span class="nam">_each_value_match_regex_validation</span><span class="op">(</span><span class="nam">PKGNAME_REGEX</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t730" href="#t730">730</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t731" href="#t731">731</a></span><span class="t"> <span class="nam">is_stanza_name</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t732" href="#t732">732</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t733" href="#t733">733</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t734" href="#t734">734</a></span><span class="t"><span class="str"> Declares the name of the source package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t735" href="#t735">735</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t736" href="#t736">736</a></span><span class="t"><span class="str"> Note this must match the name in the first entry of `debian/changelog` file.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t737" href="#t737">737</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t738" href="#t738">738</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t739" href="#t739">739</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t740" href="#t740">740</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t741" href="#t741">741</a></span><span class="t"> <span class="str">"Standards-Version"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t742" href="#t742">742</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t743" href="#t743">743</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t744" href="#t744">744</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t745" href="#t745">745</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t746" href="#t746">746</a></span><span class="t"><span class="str"> Declares the last semantic version of the Debian Policy this package as last checked against.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t747" href="#t747">747</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t748" href="#t748">748</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t749" href="#t749">749</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t750" href="#t750">750</a></span><span class="t"><span class="str"> Standards-Version: 4.5.2</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t751" href="#t751">751</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t752" href="#t752">752</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t753" href="#t753">753</a></span><span class="t"><span class="str"> Note that the last version part of the full Policy version (the **.X** in 4.5.2**.X**) is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t754" href="#t754">754</a></span><span class="t"><span class="str"> typically omitted as it is used solely for editorial changes to the policy (e.g. typo fixes).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t755" href="#t755">755</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t756" href="#t756">756</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t757" href="#t757">757</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t758" href="#t758">758</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t759" href="#t759">759</a></span><span class="t"> <span class="str">"Section"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t760" href="#t760">760</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t761" href="#t761">761</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">ALL_SECTIONS</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t762" href="#t762">762</a></span><span class="t"> <span class="nam">unknown_value_diagnostic_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t763" href="#t763">763</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t764" href="#t764">764</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t765" href="#t765">765</a></span><span class="t"><span class="str"> Define the default section for packages in this source package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t766" href="#t766">766</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t767" href="#t767">767</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t768" href="#t768">768</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t769" href="#t769">769</a></span><span class="t"><span class="str"> Section: devel</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t770" href="#t770">770</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t771" href="#t771">771</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t772" href="#t772">772</a></span><span class="t"><span class="str"> Please see <https://packages.debian.org/unstable> for more details about the sections.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t773" href="#t773">773</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t774" href="#t774">774</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t775" href="#t775">775</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t776" href="#t776">776</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t777" href="#t777">777</a></span><span class="t"> <span class="str">"Priority"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t778" href="#t778">778</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t779" href="#t779">779</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"optional"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t780" href="#t780">780</a></span><span class="t"> <span class="nam">warn_if_default</span><span class="op">=</span><span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t781" href="#t781">781</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">ALL_PRIORITIES</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t782" href="#t782">782</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t783" href="#t783">783</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t784" href="#t784">784</a></span><span class="t"><span class="str"> Define the default priority for packages in this source package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t785" href="#t785">785</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t786" href="#t786">786</a></span><span class="t"><span class="str"> The priority field describes how important the package is for the functionality of the system.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t787" href="#t787">787</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t788" href="#t788">788</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t789" href="#t789">789</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t790" href="#t790">790</a></span><span class="t"><span class="str"> Priority: optional</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t791" href="#t791">791</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t792" href="#t792">792</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t793" href="#t793">793</a></span><span class="t"><span class="str"> Unless you know you need a different value, you should choose **optional** for your packages.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t794" href="#t794">794</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t795" href="#t795">795</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t796" href="#t796">796</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t797" href="#t797">797</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t798" href="#t798">798</a></span><span class="t"> <span class="str">"Maintainer"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t799" href="#t799">799</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t800" href="#t800">800</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t801" href="#t801">801</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t802" href="#t802">802</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t803" href="#t803">803</a></span><span class="t"><span class="str"> The maintainer of the package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t804" href="#t804">804</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t805" href="#t805">805</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t806" href="#t806">806</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t807" href="#t807">807</a></span><span class="t"><span class="str"> Maintainer: Jane Contributor <jane@janes.email-provider.org></span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t808" href="#t808">808</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t809" href="#t809">809</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t810" href="#t810">810</a></span><span class="t"><span class="str"> Note: If a person is listed in the Maintainer field, they should *not* be listed in Uploaders field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t811" href="#t811">811</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t812" href="#t812">812</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t813" href="#t813">813</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t814" href="#t814">814</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t815" href="#t815">815</a></span><span class="t"> <span class="str">"Uploaders"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t816" href="#t816">816</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_EMAIL_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t817" href="#t817">817</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t818" href="#t818">818</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t819" href="#t819">819</a></span><span class="t"><span class="str"> Comma separated list of uploaders associated with the package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t820" href="#t820">820</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t821" href="#t821">821</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t822" href="#t822">822</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t823" href="#t823">823</a></span><span class="t"><span class="str"> Uploaders:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t824" href="#t824">824</a></span><span class="t"><span class="str"> John Doe <john@doe.org>,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t825" href="#t825">825</a></span><span class="t"><span class="str"> Lisbeth Worker <lis@worker.org>,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t826" href="#t826">826</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t827" href="#t827">827</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t828" href="#t828">828</a></span><span class="t"><span class="str"> Formally uploaders are considered co-maintainers for the package with the party listed in the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t829" href="#t829">829</a></span><span class="t"><span class="str"> **Maintainer** field being the primary maintainer. In practice, each maintainer or maintenance</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t830" href="#t830">830</a></span><span class="t"><span class="str"> team can have their own ruleset about the difference between the **Maintainer** and the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t831" href="#t831">831</a></span><span class="t"><span class="str"> **Uploaders**. As an example, the Python packaging team has a different rule set for how to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t832" href="#t832">832</a></span><span class="t"><span class="str"> react to a package depending on whether the packaging team is the **Maintainer** or in the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t833" href="#t833">833</a></span><span class="t"><span class="str"> **Uploaders** field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t834" href="#t834">834</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t835" href="#t835">835</a></span><span class="t"><span class="str"> Note: If a person is listed in the Maintainer field, they should *not* be listed in Uploaders field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t836" href="#t836">836</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t837" href="#t837">837</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t838" href="#t838">838</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t839" href="#t839">839</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t840" href="#t840">840</a></span><span class="t"> <span class="str">"Vcs-Browser"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t841" href="#t841">841</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t842" href="#t842">842</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t843" href="#t843">843</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t844" href="#t844">844</a></span><span class="t"><span class="str"> URL to the Version control system repo used for the packaging. The URL should be usable with a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t845" href="#t845">845</a></span><span class="t"><span class="str"> browser *without* requiring any login.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t846" href="#t846">846</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t847" href="#t847">847</a></span><span class="t"><span class="str"> This should be used together with one of the other **Vcs-** fields.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t848" href="#t848">848</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t849" href="#t849">849</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t850" href="#t850">850</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t851" href="#t851">851</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t852" href="#t852">852</a></span><span class="t"> <span class="str">"Vcs-Git"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t853" href="#t853">853</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t854" href="#t854">854</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t855" href="#t855">855</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t856" href="#t856">856</a></span><span class="t"><span class="str"> URL to the git repo used for the packaging. The URL should be usable with `git clone`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t857" href="#t857">857</a></span><span class="t"><span class="str"> *without* requiring any login.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t858" href="#t858">858</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t859" href="#t859">859</a></span><span class="t"><span class="str"> This should be used together with the **Vcs-Browser** field provided there is a web UI for the repo.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t860" href="#t860">860</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t861" href="#t861">861</a></span><span class="t"><span class="str"> Note it is possible to specify a branch via the `-b` option.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t862" href="#t862">862</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t863" href="#t863">863</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t864" href="#t864">864</a></span><span class="t"><span class="str"> Vcs-Git: https://salsa.debian.org/some/packaging-repo -b debian/unstable</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t865" href="#t865">865</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t866" href="#t866">866</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t867" href="#t867">867</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t868" href="#t868">868</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t869" href="#t869">869</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t870" href="#t870">870</a></span><span class="t"> <span class="str">"Vcs-Svn"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t871" href="#t871">871</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> <span class="com"># TODO: Might be a single value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t872" href="#t872">872</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t873" href="#t873">873</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t874" href="#t874">874</a></span><span class="t"><span class="str"> URL to the git repo used for the packaging. The URL should be usable with `svn checkout`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t875" href="#t875">875</a></span><span class="t"><span class="str"> *without* requiring any login.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t876" href="#t876">876</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t877" href="#t877">877</a></span><span class="t"><span class="str"> This should be used together with the **Vcs-Browser** field provided there is a web UI for the repo.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t878" href="#t878">878</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t879" href="#t879">879</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t880" href="#t880">880</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t881" href="#t881">881</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t882" href="#t882">882</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t883" href="#t883">883</a></span><span class="t"> <span class="str">"Vcs-Arch"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t884" href="#t884">884</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> <span class="com"># TODO: Might be a single value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t885" href="#t885">885</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t886" href="#t886">886</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t887" href="#t887">887</a></span><span class="t"><span class="str"> URL to the git repo used for the packaging. The URL should be usable for getting a copy of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t888" href="#t888">888</a></span><span class="t"><span class="str"> sources *without* requiring any login.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t889" href="#t889">889</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t890" href="#t890">890</a></span><span class="t"><span class="str"> This should be used together with the **Vcs-Browser** field provided there is a web UI for the repo.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t891" href="#t891">891</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t892" href="#t892">892</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t893" href="#t893">893</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t894" href="#t894">894</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t895" href="#t895">895</a></span><span class="t"> <span class="str">"Vcs-Cvs"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t896" href="#t896">896</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> <span class="com"># TODO: Might be a single value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t897" href="#t897">897</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t898" href="#t898">898</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t899" href="#t899">899</a></span><span class="t"><span class="str"> URL to the git repo used for the packaging. The URL should be usable for getting a copy of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t900" href="#t900">900</a></span><span class="t"><span class="str"> sources *without* requiring any login.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t901" href="#t901">901</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t902" href="#t902">902</a></span><span class="t"><span class="str"> This should be used together with the **Vcs-Browser** field provided there is a web UI for the repo.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t903" href="#t903">903</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t904" href="#t904">904</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t905" href="#t905">905</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t906" href="#t906">906</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t907" href="#t907">907</a></span><span class="t"> <span class="str">"Vcs-Darcs"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t908" href="#t908">908</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> <span class="com"># TODO: Might be a single value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t909" href="#t909">909</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t910" href="#t910">910</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t911" href="#t911">911</a></span><span class="t"><span class="str"> URL to the git repo used for the packaging. The URL should be usable for getting a copy of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t912" href="#t912">912</a></span><span class="t"><span class="str"> sources *without* requiring any login.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t913" href="#t913">913</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t914" href="#t914">914</a></span><span class="t"><span class="str"> This should be used together with the **Vcs-Browser** field provided there is a web UI for the repo.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t915" href="#t915">915</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t916" href="#t916">916</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t917" href="#t917">917</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t918" href="#t918">918</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t919" href="#t919">919</a></span><span class="t"> <span class="str">"Vcs-Hg"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t920" href="#t920">920</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> <span class="com"># TODO: Might be a single value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t921" href="#t921">921</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t922" href="#t922">922</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t923" href="#t923">923</a></span><span class="t"><span class="str"> URL to the git repo used for the packaging. The URL should be usable for getting a copy of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t924" href="#t924">924</a></span><span class="t"><span class="str"> sources *without* requiring any login.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t925" href="#t925">925</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t926" href="#t926">926</a></span><span class="t"><span class="str"> This should be used together with the **Vcs-Browser** field provided there is a web UI for the repo.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t927" href="#t927">927</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t928" href="#t928">928</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t929" href="#t929">929</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t930" href="#t930">930</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t931" href="#t931">931</a></span><span class="t"> <span class="str">"Vcs-Mtn"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t932" href="#t932">932</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> <span class="com"># TODO: Might be a single value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t933" href="#t933">933</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t934" href="#t934">934</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t935" href="#t935">935</a></span><span class="t"><span class="str"> URL to the git repo used for the packaging. The URL should be usable for getting a copy of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t936" href="#t936">936</a></span><span class="t"><span class="str"> sources *without* requiring any login.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t937" href="#t937">937</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t938" href="#t938">938</a></span><span class="t"><span class="str"> This should be used together with the **Vcs-Browser** field provided there is a web UI for the repo.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t939" href="#t939">939</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t940" href="#t940">940</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t941" href="#t941">941</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t942" href="#t942">942</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t943" href="#t943">943</a></span><span class="t"> <span class="str">"DM-Upload-Allowed"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t944" href="#t944">944</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t945" href="#t945">945</a></span><span class="t"> <span class="nam">deprecated_with_no_replacement</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t946" href="#t946">946</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t947" href="#t947">947</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span><span class="str">"yes"</span><span class="op">,</span> <span class="str">"no"</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t948" href="#t948">948</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t949" href="#t949">949</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t950" href="#t950">950</a></span><span class="t"><span class="str"> Obsolete field</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t951" href="#t951">951</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t952" href="#t952">952</a></span><span class="t"><span class="str"> It was used to enabling Debian Maintainers to upload the package without requiring a Debian Developer</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t953" href="#t953">953</a></span><span class="t"><span class="str"> to sign the package. This mechanism has been replaced by a new authorization mechanism.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t954" href="#t954">954</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t955" href="#t955">955</a></span><span class="t"><span class="str"> Please see <https://lists.debian.org/debian-devel-announce/2012/09/msg00008.html> for details about the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t956" href="#t956">956</a></span><span class="t"><span class="str"> replacement.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t957" href="#t957">957</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t958" href="#t958">958</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t959" href="#t959">959</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t960" href="#t960">960</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t961" href="#t961">961</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t962" href="#t962">962</a></span><span class="t"> <span class="str">"Build-Depends"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t963" href="#t963">963</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t964" href="#t964">964</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t965" href="#t965">965</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t966" href="#t966">966</a></span><span class="t"><span class="str"> All minimum build-dependencies for this source package. Needed for any target including **clean**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t967" href="#t967">967</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t968" href="#t968">968</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t969" href="#t969">969</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t970" href="#t970">970</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t971" href="#t971">971</a></span><span class="t"> <span class="str">"Build-Depends-Arch"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t972" href="#t972">972</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t973" href="#t973">973</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t974" href="#t974">974</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t975" href="#t975">975</a></span><span class="t"><span class="str"> Build-dependencies required for building the architecture dependent binary packages of this source</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t976" href="#t976">976</a></span><span class="t"><span class="str"> package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t977" href="#t977">977</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t978" href="#t978">978</a></span><span class="t"><span class="str"> These build-dependencies must be satisfied when executing the **build-arch** and **binary-arch**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t979" href="#t979">979</a></span><span class="t"><span class="str"> targets either directly or indirectly in addition to those listed in **Build-Depends**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t980" href="#t980">980</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t981" href="#t981">981</a></span><span class="t"><span class="str"> Note that these dependencies are *not* available during **clean**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t982" href="#t982">982</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t983" href="#t983">983</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t984" href="#t984">984</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t985" href="#t985">985</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t986" href="#t986">986</a></span><span class="t"> <span class="str">"Build-Depends-Indep"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t987" href="#t987">987</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t988" href="#t988">988</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t989" href="#t989">989</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t990" href="#t990">990</a></span><span class="t"><span class="str"> Build-dependencies required for building the architecture independent binary packages of this source</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t991" href="#t991">991</a></span><span class="t"><span class="str"> package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t992" href="#t992">992</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t993" href="#t993">993</a></span><span class="t"><span class="str"> These build-dependencies must be satisfied when executing the **build-indep** and **binary-indep**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t994" href="#t994">994</a></span><span class="t"><span class="str"> targets either directly or indirectly in addition to those listed in **Build-Depends**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t995" href="#t995">995</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t996" href="#t996">996</a></span><span class="t"><span class="str"> Note that these dependencies are *not* available during **clean**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t997" href="#t997">997</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t998" href="#t998">998</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t999" href="#t999">999</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1000" href="#t1000">1000</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1001" href="#t1001">1001</a></span><span class="t"> <span class="str">"Build-Conflicts"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1002" href="#t1002">1002</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1003" href="#t1003">1003</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1004" href="#t1004">1004</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1005" href="#t1005">1005</a></span><span class="t"><span class="str"> Packages that must **not** be installed during **any** part of the build, including the **clean**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1006" href="#t1006">1006</a></span><span class="t"><span class="str"> target **clean**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1007" href="#t1007">1007</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1008" href="#t1008">1008</a></span><span class="t"><span class="str"> Where possible, it is often better to configure the build so that it does not react to the package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1009" href="#t1009">1009</a></span><span class="t"><span class="str"> being present in the first place. Usually this is a question of using a `--without-foo` or</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1010" href="#t1010">1010</a></span><span class="t"><span class="str"> `--disable-foo` or such to the build configuration.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1011" href="#t1011">1011</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1012" href="#t1012">1012</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1013" href="#t1013">1013</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1014" href="#t1014">1014</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1015" href="#t1015">1015</a></span><span class="t"> <span class="str">"Build-Conflicts-Arch"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1016" href="#t1016">1016</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1017" href="#t1017">1017</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1018" href="#t1018">1018</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1019" href="#t1019">1019</a></span><span class="t"><span class="str"> Packages that must **not** be installed during the **build-arch** or **binary-arch** targets.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1020" href="#t1020">1020</a></span><span class="t"><span class="str"> This also applies when these targets are run implicitly such as via the **binary** target.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1021" href="#t1021">1021</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1022" href="#t1022">1022</a></span><span class="t"><span class="str"> Where possible, it is often better to configure the build so that it does not react to the package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1023" href="#t1023">1023</a></span><span class="t"><span class="str"> being present in the first place. Usually this is a question of using a `--without-foo` or</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1024" href="#t1024">1024</a></span><span class="t"><span class="str"> `--disable-foo` or such to the build configuration.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1025" href="#t1025">1025</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1026" href="#t1026">1026</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1027" href="#t1027">1027</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1028" href="#t1028">1028</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1029" href="#t1029">1029</a></span><span class="t"> <span class="str">"Build-Conflicts-Indep"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1030" href="#t1030">1030</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1031" href="#t1031">1031</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1032" href="#t1032">1032</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1033" href="#t1033">1033</a></span><span class="t"><span class="str"> Packages that must **not** be installed during the **build-indep** or **binary-indep** targets.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1034" href="#t1034">1034</a></span><span class="t"><span class="str"> This also applies when these targets are run implicitly such as via the **binary** target.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1035" href="#t1035">1035</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1036" href="#t1036">1036</a></span><span class="t"><span class="str"> Where possible, it is often better to configure the build so that it does not react to the package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1037" href="#t1037">1037</a></span><span class="t"><span class="str"> being present in the first place. Usually this is a question of using a `--without-foo` or</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1038" href="#t1038">1038</a></span><span class="t"><span class="str"> `--disable-foo` or such to the build configuration.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1039" href="#t1039">1039</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1040" href="#t1040">1040</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1041" href="#t1041">1041</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1042" href="#t1042">1042</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1043" href="#t1043">1043</a></span><span class="t"> <span class="str">"Testsuite"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1044" href="#t1044">1044</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1045" href="#t1045">1045</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1046" href="#t1046">1046</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1047" href="#t1047">1047</a></span><span class="t"><span class="str"> Declares that this package provides or should run install time tests via `autopkgtest`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1048" href="#t1048">1048</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1049" href="#t1049">1049</a></span><span class="t"><span class="str"> This field can be used to request an automatically generated autopkgtests via the **autodep8** package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1050" href="#t1050">1050</a></span><span class="t"><span class="str"> Please refer to the documentation of the **autodep8** package for which values you can put into</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1051" href="#t1051">1051</a></span><span class="t"><span class="str"> this field and what kind of testsuite the keywords will provide.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1052" href="#t1052">1052</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1053" href="#t1053">1053</a></span><span class="t"><span class="str"> Declaring this field in `debian/control` is only necessary when you want additional tests beyond</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1054" href="#t1054">1054</a></span><span class="t"><span class="str"> those in `debian/tests/control` as **dpkg** automatically records the package provided ones from</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1055" href="#t1055">1055</a></span><span class="t"><span class="str"> `debian/tests/control`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1056" href="#t1056">1056</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1057" href="#t1057">1057</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1058" href="#t1058">1058</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1059" href="#t1059">1059</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1060" href="#t1060">1060</a></span><span class="t"> <span class="str">"Homepage"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1061" href="#t1061">1061</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1062" href="#t1062">1062</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1063" href="#t1063">1063</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1064" href="#t1064">1064</a></span><span class="t"><span class="str"> Link to the upstream homepage for this source package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1065" href="#t1065">1065</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1066" href="#t1066">1066</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1067" href="#t1067">1067</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1068" href="#t1068">1068</a></span><span class="t"><span class="str"> Homepage: https://www.janes-tools.org/frob-cleaner</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1069" href="#t1069">1069</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1070" href="#t1070">1070</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1071" href="#t1071">1071</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1072" href="#t1072">1072</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1073" href="#t1073">1073</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1074" href="#t1074">1074</a></span><span class="t"> <span class="str">"Rules-Requires-Root"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1075" href="#t1075">1075</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1076" href="#t1076">1076</a></span><span class="t"> <span class="nam">unknown_value_diagnostic_severity</span><span class="op">=</span><span class="key">None</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1077" href="#t1077">1077</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1078" href="#t1078">1078</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1079" href="#t1079">1079</a></span><span class="t"> <span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1080" href="#t1080">1080</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1081" href="#t1081">1081</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1082" href="#t1082">1082</a></span><span class="t"><span class="str"> The build process will not require root or fakeroot during any step. This enables</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1083" href="#t1083">1083</a></span><span class="t"><span class="str"> dpkg-buildpackage, debhelper or/and `debputy` to perform several optimizations during the build.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1084" href="#t1084">1084</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1085" href="#t1085">1085</a></span><span class="t"><span class="str"> This is the default with dpkg-build-api at version 1 or later.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1086" href="#t1086">1086</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1087" href="#t1087">1087</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1088" href="#t1088">1088</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1089" href="#t1089">1089</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1090" href="#t1090">1090</a></span><span class="t"> <span class="str">"binary-targets"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1091" href="#t1091">1091</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1092" href="#t1092">1092</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1093" href="#t1093">1093</a></span><span class="t"><span class="str"> The build process assumes that dpkg-buildpackage will run the relevant binary</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1094" href="#t1094">1094</a></span><span class="t"><span class="str"> target with root or fakeroot. This was the historical default behaviour.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1095" href="#t1095">1095</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1096" href="#t1096">1096</a></span><span class="t"><span class="str"> This is the default with dpkg-build-api at version 0.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1097" href="#t1097">1097</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1098" href="#t1098">1098</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1099" href="#t1099">1099</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1100" href="#t1100">1100</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1101" href="#t1101">1101</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1102" href="#t1102">1102</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1103" href="#t1103">1103</a></span><span class="t"><span class="str"> Declare if and when the package build assumes it is run as root or fakeroot.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1104" href="#t1104">1104</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1105" href="#t1105">1105</a></span><span class="t"><span class="str"> Most packages do not need to run as root or fakeroot and the legacy behaviour comes with a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1106" href="#t1106">1106</a></span><span class="t"><span class="str"> performance cost. This field can be used to explicitly declare that the legacy behaviour is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1107" href="#t1107">1107</a></span><span class="t"><span class="str"> unnecessary.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1108" href="#t1108">1108</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1109" href="#t1109">1109</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1110" href="#t1110">1110</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1111" href="#t1111">1111</a></span><span class="t"><span class="str"> Rules-Requires-Root: no</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1112" href="#t1112">1112</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1113" href="#t1113">1113</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1114" href="#t1114">1114</a></span><span class="t"><span class="str"> Setting this field to `no` *can* cause the package to stop building if it requires root.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1115" href="#t1115">1115</a></span><span class="t"><span class="str"> Depending on the situation, it might require some trivial or some complicated changes to fix that.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1116" href="#t1116">1116</a></span><span class="t"><span class="str"> If it breaks and you cannot figure out how to fix it, then reset the field to `binary-targets`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1117" href="#t1117">1117</a></span><span class="t"><span class="str"> and move on until you have time to fix it.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1118" href="#t1118">1118</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1119" href="#t1119">1119</a></span><span class="t"><span class="str"> The default value for this field depends on the `dpkg-build-api` version. If the package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1120" href="#t1120">1120</a></span><span class="t"><span class="str"> ` Build-Depends` on `dpkg-build-api (>= 1)` or later, the default is `no`. Otherwise,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1121" href="#t1121">1121</a></span><span class="t"><span class="str"> the default is `binary-target`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1122" href="#t1122">1122</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1123" href="#t1123">1123</a></span><span class="t"><span class="str"> Note it is **not** possible to require running the package as "true root".</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1124" href="#t1124">1124</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1125" href="#t1125">1125</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1126" href="#t1126">1126</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1127" href="#t1127">1127</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1128" href="#t1128">1128</a></span><span class="t"> <span class="str">"Bugs"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1129" href="#t1129">1129</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1130" href="#t1130">1130</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1131" href="#t1131">1131</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1132" href="#t1132">1132</a></span><span class="t"><span class="str"> Provide a custom bug tracker URL</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1133" href="#t1133">1133</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1134" href="#t1134">1134</a></span><span class="t"><span class="str"> This field is *not* used by packages uploaded to Debian or most derivatives as the distro tooling</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1135" href="#t1135">1135</a></span><span class="t"><span class="str"> has a default bugtracker built-in. It is primarily useful for third-party provided packages such</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1136" href="#t1136">1136</a></span><span class="t"><span class="str"> that bug reporting tooling can redirect the user to their bug tracker.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1137" href="#t1137">1137</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1138" href="#t1138">1138</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1139" href="#t1139">1139</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1140" href="#t1140">1140</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1141" href="#t1141">1141</a></span><span class="t"> <span class="str">"Origin"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1142" href="#t1142">1142</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1143" href="#t1143">1143</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1144" href="#t1144">1144</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1145" href="#t1145">1145</a></span><span class="t"><span class="str"> Declare the origin of the package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1146" href="#t1146">1146</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1147" href="#t1147">1147</a></span><span class="t"><span class="str"> This field is *not* used by packages uploaded to Debian or most derivatives as the origin would</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1148" href="#t1148">1148</a></span><span class="t"><span class="str"> be the distribution. It is primarily useful for third-party provided packages as some tools will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1149" href="#t1149">1149</a></span><span class="t"><span class="str"> detect this field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1150" href="#t1150">1150</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1151" href="#t1151">1151</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1152" href="#t1152">1152</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1153" href="#t1153">1153</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1154" href="#t1154">1154</a></span><span class="t"> <span class="str">"X-Python-Version"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1155" href="#t1155">1155</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1156" href="#t1156">1156</a></span><span class="t"> <span class="nam">replaced_by</span><span class="op">=</span><span class="str">"X-Python3-Version"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1157" href="#t1157">1157</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1158" href="#t1158">1158</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1159" href="#t1159">1159</a></span><span class="t"><span class="str"> Obsolete field for declaring the supported Python2 versions</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1160" href="#t1160">1160</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1161" href="#t1161">1161</a></span><span class="t"><span class="str"> Since Python2 is no longer supported, this field is now redundant. For Python3, the field is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1162" href="#t1162">1162</a></span><span class="t"><span class="str"> called **X-Python3-Version**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1163" href="#t1163">1163</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1164" href="#t1164">1164</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1165" href="#t1165">1165</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1166" href="#t1166">1166</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1167" href="#t1167">1167</a></span><span class="t"> <span class="str">"X-Python3-Version"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1168" href="#t1168">1168</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1169" href="#t1169">1169</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1170" href="#t1170">1170</a></span><span class="t"> <span class="com"># Too lazy to provide a better description</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1171" href="#t1171">1171</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1172" href="#t1172">1172</a></span><span class="t"><span class="str"> For declaring the supported Python3 versions</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1173" href="#t1173">1173</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1174" href="#t1174">1174</a></span><span class="t"><span class="str"> This is used by the tools from `dh-python` package. Please see the documentation of that package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1175" href="#t1175">1175</a></span><span class="t"><span class="str"> for when and how to use it.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1176" href="#t1176">1176</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1177" href="#t1177">1177</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1178" href="#t1178">1178</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1179" href="#t1179">1179</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1180" href="#t1180">1180</a></span><span class="t"> <span class="str">"XS-Autobuild"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1181" href="#t1181">1181</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1182" href="#t1182">1182</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span><span class="str">"yes"</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1183" href="#t1183">1183</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1184" href="#t1184">1184</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1185" href="#t1185">1185</a></span><span class="t"><span class="str"> Used for non-free packages to denote that they may be auto-build on the Debian build infrastructure</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1186" href="#t1186">1186</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1187" href="#t1187">1187</a></span><span class="t"><span class="str"> Note that adding this field **must** be combined with following the instructions at</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1188" href="#t1188">1188</a></span><span class="t"><span class="str"> <https://www.debian.org/doc/manuals/developers-reference/pkgs.html#non-free-buildd></span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1189" href="#t1189">1189</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1190" href="#t1190">1190</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1191" href="#t1191">1191</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1192" href="#t1192">1192</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1193" href="#t1193">1193</a></span><span class="t"> <span class="str">"Description"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1194" href="#t1194">1194</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1195" href="#t1195">1195</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1196" href="#t1196">1196</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1197" href="#t1197">1197</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1198" href="#t1198">1198</a></span><span class="t"><span class="str"> This field contains a human-readable description of the package. However, it is not used directly.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1199" href="#t1199">1199</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1200" href="#t1200">1200</a></span><span class="t"><span class="str"> Binary packages can reference parts of it via the `${source:Synopsis}` and the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1201" href="#t1201">1201</a></span><span class="t"><span class="str"> `${source:Extended-Description}` substvars. Without any of these substvars, the `Description` field</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1202" href="#t1202">1202</a></span><span class="t"><span class="str"> of the `Source` stanza remains unused.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1203" href="#t1203">1203</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1204" href="#t1204">1204</a></span><span class="t"><span class="str"> The first line immediately after the field is called the *Synopsis* and is a short "noun-phrase"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1205" href="#t1205">1205</a></span><span class="t"><span class="str"> intended to provide a one-line summary of a package. The lines after the **Synopsis** is known</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1206" href="#t1206">1206</a></span><span class="t"><span class="str"> as the **Extended Description** and is intended as a longer summary of a package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1207" href="#t1207">1207</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1208" href="#t1208">1208</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1209" href="#t1209">1209</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1210" href="#t1210">1210</a></span><span class="t"><span class="str"> Description: documentation generator for Python projects</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1211" href="#t1211">1211</a></span><span class="t"><span class="str"> Sphinx is a tool for producing documentation for Python projects, using</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1212" href="#t1212">1212</a></span><span class="t"><span class="str"> reStructuredText as markup language.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1213" href="#t1213">1213</a></span><span class="t"><span class="str"> .</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1214" href="#t1214">1214</a></span><span class="t"><span class="str"> Sphinx features:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1215" href="#t1215">1215</a></span><span class="t"><span class="str"> * HTML, CHM, LaTeX output,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1216" href="#t1216">1216</a></span><span class="t"><span class="str"> * Cross-referencing source code,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1217" href="#t1217">1217</a></span><span class="t"><span class="str"> * Automatic indices,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1218" href="#t1218">1218</a></span><span class="t"><span class="str"> * Code highlighting, using Pygments,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1219" href="#t1219">1219</a></span><span class="t"><span class="str"> * Extensibility. Existing extensions:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1220" href="#t1220">1220</a></span><span class="t"><span class="str"> - automatic testing of code snippets,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1221" href="#t1221">1221</a></span><span class="t"><span class="str"> - including docstrings from Python modules.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1222" href="#t1222">1222</a></span><span class="t"><span class="str"> .</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1223" href="#t1223">1223</a></span><span class="t"><span class="str"> Build-depend on sphinx if your package uses /usr/bin/sphinx-*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1224" href="#t1224">1224</a></span><span class="t"><span class="str"> executables. Build-depend on python3-sphinx if your package uses</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1225" href="#t1225">1225</a></span><span class="t"><span class="str"> the Python API (for instance by calling python3 -m sphinx).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1226" href="#t1226">1226</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1227" href="#t1227">1227</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1228" href="#t1228">1228</a></span><span class="t"><span class="str"> The **Synopsis** is usually displayed in cases where there is limited space such as when reviewing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1229" href="#t1229">1229</a></span><span class="t"><span class="str"> the search results from `apt search foo`. It is often a good idea to imagine that the **Synopsis**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1230" href="#t1230">1230</a></span><span class="t"><span class="str"> part is inserted into a sentence like "The package provides {{Synopsis-goes-here}}". The</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1231" href="#t1231">1231</a></span><span class="t"><span class="str"> **Extended Description** is a standalone description that should describe what the package does and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1232" href="#t1232">1232</a></span><span class="t"><span class="str"> how it relates to the rest of the system (in terms of, for example, which subsystem it is which part of).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1233" href="#t1233">1233</a></span><span class="t"><span class="str"> Please see <https://www.debian.org/doc/debian-policy/ch-controlfields.html#description> for more details</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1234" href="#t1234">1234</a></span><span class="t"><span class="str"> about the description field and suggestions for how to write it.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1235" href="#t1235">1235</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1236" href="#t1236">1236</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1237" href="#t1237">1237</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1238" href="#t1238">1238</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1239" href="#t1239">1239</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1240" href="#t1240">1240</a></span><span class="t"> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t1241" href="#t1241">1241</a></span><span class="t"><span class="nam">BINARY_FIELDS</span> <span class="op">=</span> <span class="nam">_fields</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1242" href="#t1242">1242</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1243" href="#t1243">1243</a></span><span class="t"> <span class="str">"Package"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1244" href="#t1244">1244</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1245" href="#t1245">1245</a></span><span class="t"> <span class="nam">custom_field_check</span><span class="op">=</span><span class="nam">_each_value_match_regex_validation</span><span class="op">(</span><span class="nam">PKGNAME_REGEX</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1246" href="#t1246">1246</a></span><span class="t"> <span class="nam">is_stanza_name</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1247" href="#t1247">1247</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1248" href="#t1248">1248</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"Declares the name of a binary package"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1249" href="#t1249">1249</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1250" href="#t1250">1250</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1251" href="#t1251">1251</a></span><span class="t"> <span class="str">"Package-Type"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1252" href="#t1252">1252</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1253" href="#t1253">1253</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"deb"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1254" href="#t1254">1254</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1255" href="#t1255">1255</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span><span class="str">"deb"</span><span class="op">,</span> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"The package will be built as a regular deb."</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1256" href="#t1256">1256</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1257" href="#t1257">1257</a></span><span class="t"> <span class="str">"udeb"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1258" href="#t1258">1258</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"The package will be built as a micro-deb (also known as a udeb). These are solely used by the debian-installer."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1259" href="#t1259">1259</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1260" href="#t1260">1260</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1261" href="#t1261">1261</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1262" href="#t1262">1262</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1263" href="#t1263">1263</a></span><span class="t"><span class="str"> **Special-purpose only**. *This field is a special purpose field and is rarely needed.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1264" href="#t1264">1264</a></span><span class="t"><span class="str"> *You are recommended to omit unless you know you need it or someone told you to use it.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1265" href="#t1265">1265</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1266" href="#t1266">1266</a></span><span class="t"><span class="str"> Determines the type of package. This field can be used to declare that a given package is a different</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1267" href="#t1267">1267</a></span><span class="t"><span class="str"> type of package than usual. The primary case where this is known to be useful is for building</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1268" href="#t1268">1268</a></span><span class="t"><span class="str"> micro-debs ("udeb") to be consumed by the debian-installer.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1269" href="#t1269">1269</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1270" href="#t1270">1270</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1271" href="#t1271">1271</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1272" href="#t1272">1272</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1273" href="#t1273">1273</a></span><span class="t"> <span class="str">"Architecture"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1274" href="#t1274">1274</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1275" href="#t1275">1275</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1276" href="#t1276">1276</a></span><span class="t"> <span class="nam">unknown_value_diagnostic_severity</span><span class="op">=</span><span class="key">None</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1277" href="#t1277">1277</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span><span class="op">*</span><span class="nam">dpkg_arch_and_wildcards</span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1278" href="#t1278">1278</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1279" href="#t1279">1279</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1280" href="#t1280">1280</a></span><span class="t"><span class="str"> Determines which architectures this package can be compiled for or if it is an architecture-independent</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1281" href="#t1281">1281</a></span><span class="t"><span class="str"> package. The value is a space-separated list of dpkg architecture names or wildcards.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1282" href="#t1282">1282</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1283" href="#t1283">1283</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1284" href="#t1284">1284</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1285" href="#t1285">1285</a></span><span class="t"><span class="str"> Package: architecture-specific-package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1286" href="#t1286">1286</a></span><span class="t"><span class="str"> Architecture: any</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1287" href="#t1287">1287</a></span><span class="t"><span class="str"> # ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1288" href="#t1288">1288</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1289" href="#t1289">1289</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1290" href="#t1290">1290</a></span><span class="t"><span class="str"> Package: data-only-package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1291" href="#t1291">1291</a></span><span class="t"><span class="str"> Architecture: all</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1292" href="#t1292">1292</a></span><span class="t"><span class="str"> Multi-Arch: foreign</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1293" href="#t1293">1293</a></span><span class="t"><span class="str"> # ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1294" href="#t1294">1294</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1295" href="#t1295">1295</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1296" href="#t1296">1296</a></span><span class="t"><span class="str"> Package: linux-only-package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1297" href="#t1297">1297</a></span><span class="t"><span class="str"> Architecture: linux-any</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1298" href="#t1298">1298</a></span><span class="t"><span class="str"> # ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1299" href="#t1299">1299</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1300" href="#t1300">1300</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1301" href="#t1301">1301</a></span><span class="t"><span class="str"> When in doubt, stick to the values **all** (for scripts, data or documentation, etc.) or **any**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1302" href="#t1302">1302</a></span><span class="t"><span class="str"> (for anything that can be compiled). For official Debian packages, it is often easier to attempt the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1303" href="#t1303">1303</a></span><span class="t"><span class="str"> compilation for unsupported architectures than to maintain the list of machine architectures that work.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1304" href="#t1304">1304</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1305" href="#t1305">1305</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1306" href="#t1306">1306</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1307" href="#t1307">1307</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1308" href="#t1308">1308</a></span><span class="t"> <span class="str">"Essential"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1309" href="#t1309">1309</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1310" href="#t1310">1310</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1311" href="#t1311">1311</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1312" href="#t1312">1312</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1313" href="#t1313">1313</a></span><span class="t"> <span class="str">"yes"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1314" href="#t1314">1314</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"The package is essential and uninstalling it will completely and utterly break the"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1315" href="#t1315">1315</a></span><span class="t"> <span class="str">" system beyond repair."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1316" href="#t1316">1316</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1317" href="#t1317">1317</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1318" href="#t1318">1318</a></span><span class="t"> <span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1319" href="#t1319">1319</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1320" href="#t1320">1320</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1321" href="#t1321">1321</a></span><span class="t"><span class="str"> The package is a regular package. This is the default and recommended.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1322" href="#t1322">1322</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1323" href="#t1323">1323</a></span><span class="t"><span class="str"> Note that declaring a package to be "Essential: no" is the same as not having the field except omitting</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1324" href="#t1324">1324</a></span><span class="t"><span class="str"> the field wastes fewer bytes on everyone's hard disk.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1325" href="#t1325">1325</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1326" href="#t1326">1326</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1327" href="#t1327">1327</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1328" href="#t1328">1328</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1329" href="#t1329">1329</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1330" href="#t1330">1330</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1331" href="#t1331">1331</a></span><span class="t"><span class="str"> **Special-purpose only**. *This field is a special purpose field and is rarely needed.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1332" href="#t1332">1332</a></span><span class="t"><span class="str"> *You are recommended to omit unless you know you need it or someone told you to use it.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1333" href="#t1333">1333</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1334" href="#t1334">1334</a></span><span class="t"><span class="str"> Whether the package should be considered Essential as defined by Debian Policy.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1335" href="#t1335">1335</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1336" href="#t1336">1336</a></span><span class="t"><span class="str"> Essential packages are subject to several distinct but very important rules:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1337" href="#t1337">1337</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1338" href="#t1338">1338</a></span><span class="t"><span class="str"> * Essential packages are considered essential for the system to work. The packaging system</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1339" href="#t1339">1339</a></span><span class="t"><span class="str"> (APT and dpkg) will refuse to uninstall it without some very insisting force options and warnings.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1340" href="#t1340">1340</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1341" href="#t1341">1341</a></span><span class="t"><span class="str"> * Other packages are not required to declare explicit dependencies on essential packages as a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1342" href="#t1342">1342</a></span><span class="t"><span class="str"> side-effect of the above except as to ensure a that the given essential package is upgraded</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1343" href="#t1343">1343</a></span><span class="t"><span class="str"> to a given minimum version.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1344" href="#t1344">1344</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1345" href="#t1345">1345</a></span><span class="t"><span class="str"> * Once installed, essential packages function must at all time no matter where dpkg is in its</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1346" href="#t1346">1346</a></span><span class="t"><span class="str"> installation or upgrade process. During bootstrapping or installation, this requirement is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1347" href="#t1347">1347</a></span><span class="t"><span class="str"> relaxed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1348" href="#t1348">1348</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1349" href="#t1349">1349</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1350" href="#t1350">1350</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1351" href="#t1351">1351</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1352" href="#t1352">1352</a></span><span class="t"> <span class="str">"XB-Important"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1353" href="#t1353">1353</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1354" href="#t1354">1354</a></span><span class="t"> <span class="nam">replaced_by</span><span class="op">=</span><span class="str">"Protected"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1355" href="#t1355">1355</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1356" href="#t1356">1356</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1357" href="#t1357">1357</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1358" href="#t1358">1358</a></span><span class="t"> <span class="str">"yes"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1359" href="#t1359">1359</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"The package is protected and attempts to uninstall it will cause strong warnings to the"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1360" href="#t1360">1360</a></span><span class="t"> <span class="str">" user that they might be breaking the system."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1361" href="#t1361">1361</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1362" href="#t1362">1362</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1363" href="#t1363">1363</a></span><span class="t"> <span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1364" href="#t1364">1364</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1365" href="#t1365">1365</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1366" href="#t1366">1366</a></span><span class="t"><span class="str"> The package is a regular package. This is the default and recommended.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1367" href="#t1367">1367</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1368" href="#t1368">1368</a></span><span class="t"><span class="str"> Note that declaring a package to be `XB-Important: no` is the same as not having the field</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1369" href="#t1369">1369</a></span><span class="t"><span class="str"> except omitting the field wastes fewer bytes on everyone's hard-disk.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1370" href="#t1370">1370</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1371" href="#t1371">1371</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1372" href="#t1372">1372</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1373" href="#t1373">1373</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1374" href="#t1374">1374</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1375" href="#t1375">1375</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1376" href="#t1376">1376</a></span><span class="t"> <span class="str">"Protected"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1377" href="#t1377">1377</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1378" href="#t1378">1378</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1379" href="#t1379">1379</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1380" href="#t1380">1380</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1381" href="#t1381">1381</a></span><span class="t"> <span class="str">"yes"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1382" href="#t1382">1382</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"The package is protected and attempts to uninstall it will cause strong warnings to the"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1383" href="#t1383">1383</a></span><span class="t"> <span class="str">" user that they might be breaking the system."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1384" href="#t1384">1384</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1385" href="#t1385">1385</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1386" href="#t1386">1386</a></span><span class="t"> <span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1387" href="#t1387">1387</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1388" href="#t1388">1388</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1389" href="#t1389">1389</a></span><span class="t"><span class="str"> The package is a regular package. This is the default and recommended.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1390" href="#t1390">1390</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1391" href="#t1391">1391</a></span><span class="t"><span class="str"> Note that declaring a package to be `Protected: no` is the same as not having the field</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1392" href="#t1392">1392</a></span><span class="t"><span class="str"> except omitting the field wastes fewer bytes on everyone's hard-disk.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1393" href="#t1393">1393</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1394" href="#t1394">1394</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1395" href="#t1395">1395</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1396" href="#t1396">1396</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1397" href="#t1397">1397</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1398" href="#t1398">1398</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1399" href="#t1399">1399</a></span><span class="t"> <span class="str">"Pre-Depends"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1400" href="#t1400">1400</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1401" href="#t1401">1401</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1402" href="#t1402">1402</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1403" href="#t1403">1403</a></span><span class="t"><span class="str"> **Advanced field**. *This field covers an advanced topic. If you are new to packaging, you are*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1404" href="#t1404">1404</a></span><span class="t"><span class="str"> *probably not looking for this field (except to set a **${misc:Pre-Depends}** relation. Incorrect use*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1405" href="#t1405">1405</a></span><span class="t"><span class="str"> *of this field can cause issues - among other causing issues during upgrades that users cannot work*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1406" href="#t1406">1406</a></span><span class="t"><span class="str"> *around without passing `--force-*` options to dpkg.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1407" href="#t1407">1407</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1408" href="#t1408">1408</a></span><span class="t"><span class="str"> This field is like *Depends*, except that is also forces dpkg to complete installation of the packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1409" href="#t1409">1409</a></span><span class="t"><span class="str"> named before even starting the installation of the package which declares the pre-dependency.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1410" href="#t1410">1410</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1411" href="#t1411">1411</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1412" href="#t1412">1412</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1413" href="#t1413">1413</a></span><span class="t"><span class="str"> Pre-Depends: ${misc:Pre-Depends}</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1414" href="#t1414">1414</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1415" href="#t1415">1415</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1416" href="#t1416">1416</a></span><span class="t"><span class="str"> Note this is a very strong dependency and not all packages support being a pre-dependency because it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1417" href="#t1417">1417</a></span><span class="t"><span class="str"> puts additional requirements on the package being depended on. Use of **${misc:Pre-Depends}** is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1418" href="#t1418">1418</a></span><span class="t"><span class="str"> pre-approved and recommended. Essential packages are known to support being in **Pre-Depends**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1419" href="#t1419">1419</a></span><span class="t"><span class="str"> However, careless use of **Pre-Depends** for essential packages can still cause dependency resolvers</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1420" href="#t1420">1420</a></span><span class="t"><span class="str"> problems.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1421" href="#t1421">1421</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1422" href="#t1422">1422</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1423" href="#t1423">1423</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1424" href="#t1424">1424</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1425" href="#t1425">1425</a></span><span class="t"> <span class="str">"Depends"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1426" href="#t1426">1426</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1427" href="#t1427">1427</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1428" href="#t1428">1428</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1429" href="#t1429">1429</a></span><span class="t"><span class="str"> Lists the packages that must be installed, before this package is installed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1430" href="#t1430">1430</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1431" href="#t1431">1431</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1432" href="#t1432">1432</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1433" href="#t1433">1433</a></span><span class="t"><span class="str"> Package: foo</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1434" href="#t1434">1434</a></span><span class="t"><span class="str"> Architecture: any</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1435" href="#t1435">1435</a></span><span class="t"><span class="str"> Depends: ${misc:Depends},</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1436" href="#t1436">1436</a></span><span class="t"><span class="str"> ${shlibs:Depends},</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1437" href="#t1437">1437</a></span><span class="t"><span class="str"> libfoo1 (= ${binary:Version}),</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1438" href="#t1438">1438</a></span><span class="t"><span class="str"> foo-data (= ${source:Version}),</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1439" href="#t1439">1439</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1440" href="#t1440">1440</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1441" href="#t1441">1441</a></span><span class="t"><span class="str"> This field declares an absolute dependency. Before installing the package, **dpkg** will require</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1442" href="#t1442">1442</a></span><span class="t"><span class="str"> all dependencies to be in state `configured` first. Though, if there is a circular dependency between</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1443" href="#t1443">1443</a></span><span class="t"><span class="str"> two or more packages, **dpkg** will break that circle at an arbitrary point where necessary based on</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1444" href="#t1444">1444</a></span><span class="t"><span class="str"> built-in heuristics.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1445" href="#t1445">1445</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1446" href="#t1446">1446</a></span><span class="t"><span class="str"> This field should be used if the depended-on package is required for the depending package to provide a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1447" href="#t1447">1447</a></span><span class="t"><span class="str"> *significant amount of functionality* or when it is used in the **postinst** or **prerm** maintainer</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1448" href="#t1448">1448</a></span><span class="t"><span class="str"> scripts.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1449" href="#t1449">1449</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1450" href="#t1450">1450</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1451" href="#t1451">1451</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1452" href="#t1452">1452</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1453" href="#t1453">1453</a></span><span class="t"> <span class="str">"Recommends"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1454" href="#t1454">1454</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1455" href="#t1455">1455</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1456" href="#t1456">1456</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1457" href="#t1457">1457</a></span><span class="t"><span class="str"> Lists the packages that *should* be installed when this package is installed in all but</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1458" href="#t1458">1458</a></span><span class="t"><span class="str"> *unusual installations*.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1459" href="#t1459">1459</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1460" href="#t1460">1460</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1461" href="#t1461">1461</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1462" href="#t1462">1462</a></span><span class="t"><span class="str"> Recommends: foo-optional</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1463" href="#t1463">1463</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1464" href="#t1464">1464</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1465" href="#t1465">1465</a></span><span class="t"><span class="str"> By default, APT will attempt to install recommends unless they cannot be installed or the user</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1466" href="#t1466">1466</a></span><span class="t"><span class="str"> has configured APT skip recommends. Notably, during automated package builds for the Debian</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1467" href="#t1467">1467</a></span><span class="t"><span class="str"> archive, **Recommends** are **not** installed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1468" href="#t1468">1468</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1469" href="#t1469">1469</a></span><span class="t"><span class="str"> As implied, the package must have some core functionality that works **without** the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1470" href="#t1470">1470</a></span><span class="t"><span class="str"> **Recommends** being satisfied as they are not guaranteed to be there. If the package cannot</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1471" href="#t1471">1471</a></span><span class="t"><span class="str"> provide any functionality without a given package, that package should be in **Depends**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1472" href="#t1472">1472</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1473" href="#t1473">1473</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1474" href="#t1474">1474</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1475" href="#t1475">1475</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1476" href="#t1476">1476</a></span><span class="t"> <span class="str">"Suggests"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1477" href="#t1477">1477</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1478" href="#t1478">1478</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1479" href="#t1479">1479</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1480" href="#t1480">1480</a></span><span class="t"><span class="str"> Lists the packages that may make this package more useful but not installing them is perfectly</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1481" href="#t1481">1481</a></span><span class="t"><span class="str"> reasonable as well. Suggests can also be useful for add-ons that only make sense in particular</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1482" href="#t1482">1482</a></span><span class="t"><span class="str"> corner cases like supporting a non-standard file format.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1483" href="#t1483">1483</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1484" href="#t1484">1484</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1485" href="#t1485">1485</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1486" href="#t1486">1486</a></span><span class="t"><span class="str"> Suggests: bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1487" href="#t1487">1487</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1488" href="#t1488">1488</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1489" href="#t1489">1489</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1490" href="#t1490">1490</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1491" href="#t1491">1491</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1492" href="#t1492">1492</a></span><span class="t"> <span class="str">"Enhances"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1493" href="#t1493">1493</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1494" href="#t1494">1494</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1495" href="#t1495">1495</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1496" href="#t1496">1496</a></span><span class="t"><span class="str"> This field is similar to Suggests but works in the opposite direction. It is used to declare that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1497" href="#t1497">1497</a></span><span class="t"><span class="str"> this package can enhance the functionality of another package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1498" href="#t1498">1498</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1499" href="#t1499">1499</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1500" href="#t1500">1500</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1501" href="#t1501">1501</a></span><span class="t"><span class="str"> Package: foo</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1502" href="#t1502">1502</a></span><span class="t"><span class="str"> Provide: debputy-plugin-foo</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1503" href="#t1503">1503</a></span><span class="t"><span class="str"> Enhances: debputy</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1504" href="#t1504">1504</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1505" href="#t1505">1505</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1506" href="#t1506">1506</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1507" href="#t1507">1507</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1508" href="#t1508">1508</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1509" href="#t1509">1509</a></span><span class="t"> <span class="str">"Provides"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1510" href="#t1510">1510</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1511" href="#t1511">1511</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1512" href="#t1512">1512</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1513" href="#t1513">1513</a></span><span class="t"><span class="str"> Declare this package also provide one or more other packages. This means that this package can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1514" href="#t1514">1514</a></span><span class="t"><span class="str"> substitute for the provided package in some relations.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1515" href="#t1515">1515</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1516" href="#t1516">1516</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1517" href="#t1517">1517</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1518" href="#t1518">1518</a></span><span class="t"><span class="str"> Package: foo</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1519" href="#t1519">1519</a></span><span class="t"><span class="str"> ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1520" href="#t1520">1520</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1521" href="#t1521">1521</a></span><span class="t"><span class="str"> Package: foo-plus</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1522" href="#t1522">1522</a></span><span class="t"><span class="str"> Provides: foo (= ${source:Upstream-Version})</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1523" href="#t1523">1523</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1524" href="#t1524">1524</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1525" href="#t1525">1525</a></span><span class="t"><span class="str"> If the provides relation is versioned, it must use a "strictly equals" version. If it does not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1526" href="#t1526">1526</a></span><span class="t"><span class="str"> declare a version, then it *cannot* be used to satisfy a dependency with a version restriction.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1527" href="#t1527">1527</a></span><span class="t"><span class="str"> Consider the following example:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1528" href="#t1528">1528</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1529" href="#t1529">1529</a></span><span class="t"><span class="str"> **Archive scenario**: (This is *not* a `debian/control` file, despite the resemblance)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1530" href="#t1530">1530</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1531" href="#t1531">1531</a></span><span class="t"><span class="str"> Package foo</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1532" href="#t1532">1532</a></span><span class="t"><span class="str"> Depends: bar (>= 1.0)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1533" href="#t1533">1533</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1534" href="#t1534">1534</a></span><span class="t"><span class="str"> Package: bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1535" href="#t1535">1535</a></span><span class="t"><span class="str"> Version: 0.9</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1536" href="#t1536">1536</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1537" href="#t1537">1537</a></span><span class="t"><span class="str"> Package: bar-plus</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1538" href="#t1538">1538</a></span><span class="t"><span class="str"> Provides: bar (= 1.0)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1539" href="#t1539">1539</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1540" href="#t1540">1540</a></span><span class="t"><span class="str"> Package: bar-clone</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1541" href="#t1541">1541</a></span><span class="t"><span class="str"> Provides: bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1542" href="#t1542">1542</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1543" href="#t1543">1543</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1544" href="#t1544">1544</a></span><span class="t"><span class="str"> In this archive scenario, the `bar-plus` package will satisfy the dependency of `foo` as the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1545" href="#t1545">1545</a></span><span class="t"><span class="str"> only one. The `bar` package fails because the version is only *0.9* and `bar-clone` because</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1546" href="#t1546">1546</a></span><span class="t"><span class="str"> the provides is unversioned, but the dependency clause is versioned.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1547" href="#t1547">1547</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1548" href="#t1548">1548</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1549" href="#t1549">1549</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1550" href="#t1550">1550</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1551" href="#t1551">1551</a></span><span class="t"> <span class="str">"Conflicts"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1552" href="#t1552">1552</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1553" href="#t1553">1553</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1554" href="#t1554">1554</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1555" href="#t1555">1555</a></span><span class="t"><span class="str"> **Warning**: *You may be looking for Breaks instead of Conflicts*.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1556" href="#t1556">1556</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1557" href="#t1557">1557</a></span><span class="t"><span class="str"> This package cannot be installed together with the packages listed in the Conflicts field. This</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1558" href="#t1558">1558</a></span><span class="t"><span class="str"> is a *bigger hammer* than **Breaks** and is used sparingly. Notably, if you want to do a versioned</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1559" href="#t1559">1559</a></span><span class="t"><span class="str"> **Conflicts** then you *almost certainly* want **Breaks** instead.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1560" href="#t1560">1560</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1561" href="#t1561">1561</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1562" href="#t1562">1562</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1563" href="#t1563">1563</a></span><span class="t"><span class="str"> Conflicts: bar</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1564" href="#t1564">1564</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1565" href="#t1565">1565</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1566" href="#t1566">1566</a></span><span class="t"><span class="str"> Please check the description of the **Breaks** field for when you would use **Breaks** vs.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1567" href="#t1567">1567</a></span><span class="t"><span class="str"> **Conflicts**.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1568" href="#t1568">1568</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1569" href="#t1569">1569</a></span><span class="t"><span class="str"> Note if a package conflicts with itself (indirectly or via **Provides**), then it is using a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1570" href="#t1570">1570</a></span><span class="t"><span class="str"> special rule for **Conflicts**. See section</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1571" href="#t1571">1571</a></span><span class="t"><span class="str"> 7.6.2 "[Replacing whole packages, forcing their removal]" in the Debian Policy Manual.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1572" href="#t1572">1572</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1573" href="#t1573">1573</a></span><span class="t"><span class="str"> [Replacing whole packages, forcing their removal]: https://www.debian.org/doc/debian-policy/ch-relationships.html#replacing-whole-packages-forcing-their-removal</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1574" href="#t1574">1574</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1575" href="#t1575">1575</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1576" href="#t1576">1576</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1577" href="#t1577">1577</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1578" href="#t1578">1578</a></span><span class="t"> <span class="str">"Breaks"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1579" href="#t1579">1579</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1580" href="#t1580">1580</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1581" href="#t1581">1581</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1582" href="#t1582">1582</a></span><span class="t"><span class="str"> This package cannot be installed together with the packages listed in the `Breaks` field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1583" href="#t1583">1583</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1584" href="#t1584">1584</a></span><span class="t"><span class="str"> This is often use to declare versioned issues such as "This package does not work with foo if</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1585" href="#t1585">1585</a></span><span class="t"><span class="str"> it is version 1.0 or less". In comparison, `Conflicts` is generally used to declare that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1586" href="#t1586">1586</a></span><span class="t"><span class="str"> "This package does not work at all as long as foo is installed".</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1587" href="#t1587">1587</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1588" href="#t1588">1588</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1589" href="#t1589">1589</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1590" href="#t1590">1590</a></span><span class="t"><span class="str"> Breaks: bar (<= 1.0~)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1591" href="#t1591">1591</a></span><span class="t"><span class="str"> ````</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1592" href="#t1592">1592</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1593" href="#t1593">1593</a></span><span class="t"><span class="str"> **Breaks vs. Conflicts**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1594" href="#t1594">1594</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1595" href="#t1595">1595</a></span><span class="t"><span class="str"> * I moved files from **foo** to **bar** in version X, what should I do?</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1596" href="#t1596">1596</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1597" href="#t1597">1597</a></span><span class="t"><span class="str"> Add `Breaks: foo (<< X~)` + `Replaces: foo (<< X~)` to **bar**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1598" href="#t1598">1598</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1599" href="#t1599">1599</a></span><span class="t"><span class="str"> * Upgrading **bar** while **foo** is version X or less causes problems **foo** or **bar** to break.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1600" href="#t1600">1600</a></span><span class="t"><span class="str"> How do I solve this?</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1601" href="#t1601">1601</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1602" href="#t1602">1602</a></span><span class="t"><span class="str"> Add `Breaks: foo (<< X~)` to **bar**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1603" href="#t1603">1603</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1604" href="#t1604">1604</a></span><span class="t"><span class="str"> * The **foo** and **bar** packages provide the same functionality (interface) but different</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1605" href="#t1605">1605</a></span><span class="t"><span class="str"> implementations and there can be at most one of them. What should I do?</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1606" href="#t1606">1606</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1607" href="#t1607">1607</a></span><span class="t"><span class="str"> See section 7.6.2 [Replacing whole packages, forcing their removal] in the Debian Policy Manual.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1608" href="#t1608">1608</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1609" href="#t1609">1609</a></span><span class="t"><span class="str"> * How to handle when **foo** and **bar** packages are unrelated but happen to provide the same binary?</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1610" href="#t1610">1610</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1611" href="#t1611">1611</a></span><span class="t"><span class="str"> Attempt to resolve the name conflict by renaming the clashing files in question on either (or both) sides.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1612" href="#t1612">1612</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1613" href="#t1613">1613</a></span><span class="t"><span class="str"> Note the use of *~* in version numbers in the answers are generally used to ensure this works correctly in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1614" href="#t1614">1614</a></span><span class="t"><span class="str"> case of a backports (in the Debian archive), where the package is rebuilt with the "~bpo" suffix in its</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1615" href="#t1615">1615</a></span><span class="t"><span class="str"> version.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1616" href="#t1616">1616</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1617" href="#t1617">1617</a></span><span class="t"><span class="str"> [Replacing whole packages, forcing their removal]: https://www.debian.org/doc/debian-policy/ch-relationships.html#replacing-whole-packages-forcing-their-removal</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1618" href="#t1618">1618</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1619" href="#t1619">1619</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1620" href="#t1620">1620</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1621" href="#t1621">1621</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1622" href="#t1622">1622</a></span><span class="t"> <span class="str">"Replaces"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1623" href="#t1623">1623</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1624" href="#t1624">1624</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1625" href="#t1625">1625</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1626" href="#t1626">1626</a></span><span class="t"><span class="str"> This package either replaces another package or overwrites files that used to be provided by</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1627" href="#t1627">1627</a></span><span class="t"><span class="str"> another package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1628" href="#t1628">1628</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1629" href="#t1629">1629</a></span><span class="t"><span class="str"> **Attention**: The `Replaces` field is **always** used with either `Breaks` or `Conflicts` field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1630" href="#t1630">1630</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1631" href="#t1631">1631</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1632" href="#t1632">1632</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1633" href="#t1633">1633</a></span><span class="t"><span class="str"> Package: foo</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1634" href="#t1634">1634</a></span><span class="t"><span class="str"> ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1635" href="#t1635">1635</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1636" href="#t1636">1636</a></span><span class="t"><span class="str"> # The foo package was split to move data files into foo-data in version 1.2-3</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1637" href="#t1637">1637</a></span><span class="t"><span class="str"> Package: foo-data</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1638" href="#t1638">1638</a></span><span class="t"><span class="str"> Replaces: foo (<< 1.2-3~)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1639" href="#t1639">1639</a></span><span class="t"><span class="str"> Breaks: foo (<< 1.2-3~)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1640" href="#t1640">1640</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1641" href="#t1641">1641</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1642" href="#t1642">1642</a></span><span class="t"><span class="str"> Please check the description of the `Breaks` field for when you would use `Breaks` vs. `Conflicts`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1643" href="#t1643">1643</a></span><span class="t"><span class="str"> It also covers common uses of `Replaces`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1644" href="#t1644">1644</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1645" href="#t1645">1645</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1646" href="#t1646">1646</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1647" href="#t1647">1647</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1648" href="#t1648">1648</a></span><span class="t"> <span class="str">"Build-Profiles"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1649" href="#t1649">1649</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">BUILD_PROFILES_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1650" href="#t1650">1650</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1651" href="#t1651">1651</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1652" href="#t1652">1652</a></span><span class="t"><span class="str"> **Advanced field**. *This field covers an advanced topic. If you are new to packaging, you are*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1653" href="#t1653">1653</a></span><span class="t"><span class="str"> *advised to leave it at its default until you have a working basic package or lots of time to understand*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1654" href="#t1654">1654</a></span><span class="t"><span class="str"> *this topic.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1655" href="#t1655">1655</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1656" href="#t1656">1656</a></span><span class="t"><span class="str"> Declare that the package will only built when the given build-profiles are satisfied.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1657" href="#t1657">1657</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1658" href="#t1658">1658</a></span><span class="t"><span class="str"> This field is primarily used in combination with build profiles inside the build dependency related fields</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1659" href="#t1659">1659</a></span><span class="t"><span class="str"> to reduce the number of build dependencies required during bootstrapping of a new architecture.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1660" href="#t1660">1660</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1661" href="#t1661">1661</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1662" href="#t1662">1662</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1663" href="#t1663">1663</a></span><span class="t"><span class="str"> Package: foo</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1664" href="#t1664">1664</a></span><span class="t"><span class="str"> ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1665" href="#t1665">1665</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1666" href="#t1666">1666</a></span><span class="t"><span class="str"> Package: foo-udeb</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1667" href="#t1667">1667</a></span><span class="t"><span class="str"> Package-Type: udeb</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1668" href="#t1668">1668</a></span><span class="t"><span class="str"> # Skip building foo-udeb when the build profile "noudeb" is set (e.g., via dpkg-buildpackage -Pnoudeb)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1669" href="#t1669">1669</a></span><span class="t"><span class="str"> Build-Profiles: <!noudeb></span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1670" href="#t1670">1670</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1671" href="#t1671">1671</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1672" href="#t1672">1672</a></span><span class="t"><span class="str"> Note that there is an official list of "common" build profiles with predefined purposes along with rules</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1673" href="#t1673">1673</a></span><span class="t"><span class="str"> for how and when the can be used. This list can be found at</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1674" href="#t1674">1674</a></span><span class="t"><span class="str"> <https://wiki.debian.org/BuildProfileSpec#Registered_profile_names>.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1675" href="#t1675">1675</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1676" href="#t1676">1676</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1677" href="#t1677">1677</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1678" href="#t1678">1678</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1679" href="#t1679">1679</a></span><span class="t"> <span class="str">"Section"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1680" href="#t1680">1680</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1681" href="#t1681">1681</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1682" href="#t1682">1682</a></span><span class="t"> <span class="nam">inherits_from_source</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1683" href="#t1683">1683</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">ALL_SECTIONS</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1684" href="#t1684">1684</a></span><span class="t"> <span class="nam">unknown_value_diagnostic_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1685" href="#t1685">1685</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1686" href="#t1686">1686</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1687" href="#t1687">1687</a></span><span class="t"><span class="str"> Define the section for this package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1688" href="#t1688">1688</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1689" href="#t1689">1689</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1690" href="#t1690">1690</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1691" href="#t1691">1691</a></span><span class="t"><span class="str"> Section: devel</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1692" href="#t1692">1692</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1693" href="#t1693">1693</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1694" href="#t1694">1694</a></span><span class="t"><span class="str"> Please see <https://packages.debian.org/unstable> for more details about the sections.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1695" href="#t1695">1695</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1696" href="#t1696">1696</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1697" href="#t1697">1697</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1698" href="#t1698">1698</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1699" href="#t1699">1699</a></span><span class="t"> <span class="str">"Priority"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1700" href="#t1700">1700</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1701" href="#t1701">1701</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"optional"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1702" href="#t1702">1702</a></span><span class="t"> <span class="nam">warn_if_default</span><span class="op">=</span><span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1703" href="#t1703">1703</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1704" href="#t1704">1704</a></span><span class="t"> <span class="nam">inherits_from_source</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1705" href="#t1705">1705</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">ALL_PRIORITIES</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1706" href="#t1706">1706</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1707" href="#t1707">1707</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1708" href="#t1708">1708</a></span><span class="t"><span class="str"> Define the priority this package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1709" href="#t1709">1709</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1710" href="#t1710">1710</a></span><span class="t"><span class="str"> The priority field describes how important the package is for the functionality of the system.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1711" href="#t1711">1711</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1712" href="#t1712">1712</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1713" href="#t1713">1713</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1714" href="#t1714">1714</a></span><span class="t"><span class="str"> Priority: optional</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1715" href="#t1715">1715</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1716" href="#t1716">1716</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1717" href="#t1717">1717</a></span><span class="t"><span class="str"> Unless you know you need a different value, you should choose **optional** for your packages.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1718" href="#t1718">1718</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1719" href="#t1719">1719</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1720" href="#t1720">1720</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1721" href="#t1721">1721</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1722" href="#t1722">1722</a></span><span class="t"> <span class="str">"Multi-Arch"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1723" href="#t1723">1723</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1724" href="#t1724">1724</a></span><span class="t"> <span class="com"># Explicit "no" tends to be used as "someone reviewed this and concluded no", so we do</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1725" href="#t1725">1725</a></span><span class="t"> <span class="com"># not warn about it being explicitly "no".</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1726" href="#t1726">1726</a></span><span class="t"> <span class="nam">warn_if_default</span><span class="op">=</span><span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1727" href="#t1727">1727</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1728" href="#t1728">1728</a></span><span class="t"> <span class="nam">custom_field_check</span><span class="op">=</span><span class="nam">_dctrl_ma_field_validation</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1729" href="#t1729">1729</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1730" href="#t1730">1730</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1731" href="#t1731">1731</a></span><span class="t"> <span class="str">"no"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1732" href="#t1732">1732</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1733" href="#t1733">1733</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1734" href="#t1734">1734</a></span><span class="t"><span class="str"> The default. The package can be installed for at most one architecture at the time. It can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1735" href="#t1735">1735</a></span><span class="t"><span class="str"> *only* satisfy relations for the same architecture as itself. Note that `Architecture: all`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1736" href="#t1736">1736</a></span><span class="t"><span class="str"> packages are considered as a part of the system's "primary" architecture (see output of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1737" href="#t1737">1737</a></span><span class="t"><span class="str"> `dpkg --print-architecture`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1738" href="#t1738">1738</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1739" href="#t1739">1739</a></span><span class="t"><span class="str"> Note: Despite the "no", the package *can* be installed for a foreign architecture (as an example,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1740" href="#t1740">1740</a></span><span class="t"><span class="str"> you can install a 32-bit version of a package on a 64-bit system). However, packages depending</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1741" href="#t1741">1741</a></span><span class="t"><span class="str"> on it must also be installed for the foreign architecture.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1742" href="#t1742">1742</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1743" href="#t1743">1743</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1744" href="#t1744">1744</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1745" href="#t1745">1745</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1746" href="#t1746">1746</a></span><span class="t"> <span class="str">"foreign"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1747" href="#t1747">1747</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1748" href="#t1748">1748</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1749" href="#t1749">1749</a></span><span class="t"><span class="str"> The package can be installed for at most one architecture at the time. However, it can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1750" href="#t1750">1750</a></span><span class="t"><span class="str"> satisfy relations for packages regardless of their architecture. This is often useful for packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1751" href="#t1751">1751</a></span><span class="t"><span class="str"> solely providing data or binaries that have "Multi-Arch neutral interfaces".</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1752" href="#t1752">1752</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1753" href="#t1753">1753</a></span><span class="t"><span class="str"> Sadly, describing a "Multi-Arch neutral interface" is hard and often only done by Multi-Arch</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1754" href="#t1754">1754</a></span><span class="t"><span class="str"> experts on a case-by-case basis. Some programs and scripts have "Multi-Arch dependent interfaces"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1755" href="#t1755">1755</a></span><span class="t"><span class="str"> and are not safe to declare as `Multi-Arch: foreign`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1756" href="#t1756">1756</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1757" href="#t1757">1757</a></span><span class="t"><span class="str"> The name "foreign" refers to the fact that the package can satisfy relations for native</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1758" href="#t1758">1758</a></span><span class="t"><span class="str"> *and foreign* architectures at the same time.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1759" href="#t1759">1759</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1760" href="#t1760">1760</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1761" href="#t1761">1761</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1762" href="#t1762">1762</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1763" href="#t1763">1763</a></span><span class="t"> <span class="str">"same"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1764" href="#t1764">1764</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1765" href="#t1765">1765</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1766" href="#t1766">1766</a></span><span class="t"><span class="str"> The same version of the package can be co-installed for multiple architecture. However,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1767" href="#t1767">1767</a></span><span class="t"><span class="str"> for this to work, the package *must* ship all files in architecture unique paths (usually</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1768" href="#t1768">1768</a></span><span class="t"><span class="str"> beneath `/usr/lib/<DEB_HOST_MULTIARCH>`) or have bit-for-bit identical content</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1769" href="#t1769">1769</a></span><span class="t"><span class="str"> in files that are in non-architecture unique paths (such as files beneath `/usr/share/doc`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1770" href="#t1770">1770</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1771" href="#t1771">1771</a></span><span class="t"><span class="str"> The name `same` refers to the fact that the package can satisfy relations only for the `same`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1772" href="#t1772">1772</a></span><span class="t"><span class="str"> architecture as itself. However, in this case, it is co-installable with itself as noted above.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1773" href="#t1773">1773</a></span><span class="t"><span class="str"> Note: This value **cannot** be used with `Architecture: all`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1774" href="#t1774">1774</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1775" href="#t1775">1775</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1776" href="#t1776">1776</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1777" href="#t1777">1777</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1778" href="#t1778">1778</a></span><span class="t"> <span class="str">"allowed"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1779" href="#t1779">1779</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1780" href="#t1780">1780</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1781" href="#t1781">1781</a></span><span class="t"><span class="str"> **Advanced value**. The package is *not* co-installable with itself but can satisfy Multi-Arch</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1782" href="#t1782">1782</a></span><span class="t"><span class="str"> foreign and Multi-Arch same relations at the same. This is useful for implementations of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1783" href="#t1783">1783</a></span><span class="t"><span class="str"> scripting languages (such as Perl or Python). Here the interpreter contextually need to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1784" href="#t1784">1784</a></span><span class="t"><span class="str"> satisfy some relations as `Multi-Arch: foreign` and others as `Multi-Arch: same`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1785" href="#t1785">1785</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1786" href="#t1786">1786</a></span><span class="t"><span class="str"> Typically, native extensions or plugins will need a `Multi-Arch: same`-relation as they only</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1787" href="#t1787">1787</a></span><span class="t"><span class="str"> work with the interpreter compiled for the same machine architecture as themselves whereas</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1788" href="#t1788">1788</a></span><span class="t"><span class="str"> scripts are usually less picky and can rely on the `Multi-Arch: foreign` relation. Packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1789" href="#t1789">1789</a></span><span class="t"><span class="str"> wanting to rely on the "Multi-Arch: foreign" interface must explicitly declare this adding a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1790" href="#t1790">1790</a></span><span class="t"><span class="str"> `:any` suffix to the package name in the dependency relation (e.g. `Depends: python3:any`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1791" href="#t1791">1791</a></span><span class="t"><span class="str"> However, the `:any"`suffix cannot be used unconditionally and should not be used unless you</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1792" href="#t1792">1792</a></span><span class="t"><span class="str"> know you need it.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1793" href="#t1793">1793</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1794" href="#t1794">1794</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1795" href="#t1795">1795</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1796" href="#t1796">1796</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1797" href="#t1797">1797</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1798" href="#t1798">1798</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1799" href="#t1799">1799</a></span><span class="t"><span class="str"> **Advanced field**. *This field covers an advanced topic. If you are new to packaging, you are*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1800" href="#t1800">1800</a></span><span class="t"><span class="str"> *advised to leave it at its default until you have a working basic package or lots of time to understand*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1801" href="#t1801">1801</a></span><span class="t"><span class="str"> *this topic.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1802" href="#t1802">1802</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1803" href="#t1803">1803</a></span><span class="t"><span class="str"> This field is used to declare the Multi-Arch interface of the package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1804" href="#t1804">1804</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1805" href="#t1805">1805</a></span><span class="t"><span class="str"> The `Multi-Arch` field is used to inform the installation system (APT and dpkg) about how it should handle</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1806" href="#t1806">1806</a></span><span class="t"><span class="str"> dependency relations involving this package and foreign architectures. This is useful for multiple purposes</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1807" href="#t1807">1807</a></span><span class="t"><span class="str"> such as cross-building without emulation and installing 32-bit packages on a 64-bit system. The latter is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1808" href="#t1808">1808</a></span><span class="t"><span class="str"> often done to use legacy apps or old games that was never ported to 64-bit machines.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1809" href="#t1809">1809</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1810" href="#t1810">1810</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1811" href="#t1811">1811</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1812" href="#t1812">1812</a></span><span class="t"><span class="str"> Multi-Arch: foreign</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1813" href="#t1813">1813</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1814" href="#t1814">1814</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1815" href="#t1815">1815</a></span><span class="t"><span class="str"> The rules for `Multi-Arch` can be quite complicated, but in many cases the following simple rules of thumb</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1816" href="#t1816">1816</a></span><span class="t"><span class="str"> gets you a long way:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1817" href="#t1817">1817</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1818" href="#t1818">1818</a></span><span class="t"><span class="str"> * If the [Multi-Arch hinter] comes with a hint, then it almost certainly correct. You are recommended</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1819" href="#t1819">1819</a></span><span class="t"><span class="str"> to check the hint for further details (some changes can be complicated to do). Note that the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1820" href="#t1820">1820</a></span><span class="t"><span class="str"> Multi-Arch hinter is only run for official Debian packages and may not be applicable to your case.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1821" href="#t1821">1821</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1822" href="#t1822">1822</a></span><span class="t"><span class="str"> * If you have an `Architecture: all` data-only package, then it often want to be `Multi-Arch: foreign`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1823" href="#t1823">1823</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1824" href="#t1824">1824</a></span><span class="t"><span class="str"> * If you have an architecture dependent package, where everything is installed in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1825" href="#t1825">1825</a></span><span class="t"><span class="str"> `/usr/lib/${DEB_HOST_MULTIARCH}` (plus a bit of standard documentation in `/usr/share/doc`), then</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1826" href="#t1826">1826</a></span><span class="t"><span class="str"> you *probably* want `Multi-Arch: same`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1827" href="#t1827">1827</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1828" href="#t1828">1828</a></span><span class="t"><span class="str"> * If none of the above applies, then omit the field unless you know what you are doing or you are</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1829" href="#t1829">1829</a></span><span class="t"><span class="str"> receiving advice from a Multi-Arch expert.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1830" href="#t1830">1830</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1831" href="#t1831">1831</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1832" href="#t1832">1832</a></span><span class="t"><span class="str"> There are 4 possible values for the Multi-Arch field, though not all values are applicable to all packages:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1833" href="#t1833">1833</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1834" href="#t1834">1834</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1835" href="#t1835">1835</a></span><span class="t"><span class="str"> * `no` - The default. The package can be installed for at most one architecture at the time. It can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1836" href="#t1836">1836</a></span><span class="t"><span class="str"> *only* satisfy relations for the same architecture as itself. Note that `Architecture: all` packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1837" href="#t1837">1837</a></span><span class="t"><span class="str"> are considered as a part of the system's "primary" architecture (see output of `dpkg --print-architecture`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1838" href="#t1838">1838</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1839" href="#t1839">1839</a></span><span class="t"><span class="str"> Use of an explicit `no` over omitting the field is commonly done to signal that someone took the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1840" href="#t1840">1840</a></span><span class="t"><span class="str"> effort to understand the situation and concluded `no` was the right answer.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1841" href="#t1841">1841</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1842" href="#t1842">1842</a></span><span class="t"><span class="str"> Note: Despite the `no`, the package *can* be installed for a foreign architecture (e.g. you can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1843" href="#t1843">1843</a></span><span class="t"><span class="str"> install a 32-bit version of a package on a 64-bit system). However, packages depending on it must also</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1844" href="#t1844">1844</a></span><span class="t"><span class="str"> be installed for the foreign architecture.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1845" href="#t1845">1845</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1846" href="#t1846">1846</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1847" href="#t1847">1847</a></span><span class="t"><span class="str"> * `foreign` - The package can be installed for at most one architecture at the time. However, it can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1848" href="#t1848">1848</a></span><span class="t"><span class="str"> satisfy relations for packages regardless of their architecture. This is often useful for packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1849" href="#t1849">1849</a></span><span class="t"><span class="str"> solely providing data or binaries that have "Multi-Arch neutral interfaces". Sadly, describing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1850" href="#t1850">1850</a></span><span class="t"><span class="str"> a "Multi-Arch neutral interface" is hard and often only done by Multi-Arch experts on a case-by-case</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1851" href="#t1851">1851</a></span><span class="t"><span class="str"> basis. Among other, scripts despite being the same on all architectures can still have a "non-neutral"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1852" href="#t1852">1852</a></span><span class="t"><span class="str"> "Multi-Arch" interface if their output is architecture dependent or if they dependencies force them</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1853" href="#t1853">1853</a></span><span class="t"><span class="str"> out of the `foreign` role. The dependency issue usually happens when depending indirectly on an</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1854" href="#t1854">1854</a></span><span class="t"><span class="str"> `Multi-Arch: allowed` package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1855" href="#t1855">1855</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1856" href="#t1856">1856</a></span><span class="t"><span class="str"> Some programs are have "Multi-Arch dependent interfaces" and are not safe to declare as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1857" href="#t1857">1857</a></span><span class="t"><span class="str"> `Multi-Arch: foreign`. The name `foreign` refers to the fact that the package can satisfy relations</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1858" href="#t1858">1858</a></span><span class="t"><span class="str"> for native *and foreign* architectures at the same time.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1859" href="#t1859">1859</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1860" href="#t1860">1860</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1861" href="#t1861">1861</a></span><span class="t"><span class="str"> * `same` - The same version of the package can be co-installed for multiple architecture. However,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1862" href="#t1862">1862</a></span><span class="t"><span class="str"> for this to work, the package **must** ship all files in architecture unique paths (usually</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1863" href="#t1863">1863</a></span><span class="t"><span class="str"> beneath `/usr/lib/${DEB_HOST_MULTIARCH}`) **or** have bit-for-bit identical content in files</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1864" href="#t1864">1864</a></span><span class="t"><span class="str"> that are in non-architecture unique paths (e.g. `/usr/share/doc`). Note that these packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1865" href="#t1865">1865</a></span><span class="t"><span class="str"> typically do not contain configuration files or **dpkg** `conffile`s.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1866" href="#t1866">1866</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1867" href="#t1867">1867</a></span><span class="t"><span class="str"> The name `same` refers to the fact that the package can satisfy relations only for the "same"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1868" href="#t1868">1868</a></span><span class="t"><span class="str"> architecture as itself. However, in this case, it is co-installable with itself as noted above.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1869" href="#t1869">1869</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1870" href="#t1870">1870</a></span><span class="t"><span class="str"> Note: This value **cannot** be used with `Architecture: all`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1871" href="#t1871">1871</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1872" href="#t1872">1872</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1873" href="#t1873">1873</a></span><span class="t"><span class="str"> * `allowed` - **Advanced value**. This value is for a complex use-case that most people does not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1874" href="#t1874">1874</a></span><span class="t"><span class="str"> need. Consider it only if none of the other values seem to do the trick.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1875" href="#t1875">1875</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1876" href="#t1876">1876</a></span><span class="t"><span class="str"> The package is **NOT** co-installable with itself but can satisfy Multi-Arch foreign and Multi-Arch same</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1877" href="#t1877">1877</a></span><span class="t"><span class="str"> relations at the same. This is useful for implementations of scripting languages (e.g. Perl or Python).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1878" href="#t1878">1878</a></span><span class="t"><span class="str"> Here the interpreter contextually need to satisfy some relations as `Multi-Arch: foreign` and others as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1879" href="#t1879">1879</a></span><span class="t"><span class="str"> `Multi-Arch: same` (or `Multi-Arch: no`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1880" href="#t1880">1880</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1881" href="#t1881">1881</a></span><span class="t"><span class="str"> Typically, native extensions or plugins will need a `Multi-Arch: same`-relation as they only work with</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1882" href="#t1882">1882</a></span><span class="t"><span class="str"> the interpreter compiled for the same machine architecture as themselves whereas scripts are usually</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1883" href="#t1883">1883</a></span><span class="t"><span class="str"> less picky and can rely on the `Multi-Arch: foreign` relation. Packages wanting to rely on the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1884" href="#t1884">1884</a></span><span class="t"><span class="str"> `Multi-Arch: foreign` interface must explicitly declare this adding a `:any` suffix to the package name</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1885" href="#t1885">1885</a></span><span class="t"><span class="str"> in the dependency relation (such as `Depends: python3:any`). However, the `:any` suffix cannot be used</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1886" href="#t1886">1886</a></span><span class="t"><span class="str"> unconditionally and should not be used unless you know you need it.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1887" href="#t1887">1887</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1888" href="#t1888">1888</a></span><span class="t"><span class="str"> Note that depending indirectly on a `Multi-Arch: allowed` package can require a `Architecture: all` +</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1889" href="#t1889">1889</a></span><span class="t"><span class="str"> `Multi-Arch: foreign` package to be converted to a `Architecture: any` package. This case is named</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1890" href="#t1890">1890</a></span><span class="t"><span class="str"> the "Multi-Arch interpreter problem", since it is commonly seen with script interpreters. However,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1891" href="#t1891">1891</a></span><span class="t"><span class="str"> despite the name, it can happen to any kind of package. The bug [Debian#984701] is an example of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1892" href="#t1892">1892</a></span><span class="t"><span class="str"> this happen in practice.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1893" href="#t1893">1893</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1894" href="#t1894">1894</a></span><span class="t"><span class="str"> [Multi-Arch hinter]: https://wiki.debian.org/MultiArch/Hints</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1895" href="#t1895">1895</a></span><span class="t"><span class="str"> [Debian#984701]: https://bugs.debian.org/984701</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1896" href="#t1896">1896</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1897" href="#t1897">1897</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1898" href="#t1898">1898</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1899" href="#t1899">1899</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1900" href="#t1900">1900</a></span><span class="t"> <span class="str">"XB-Installer-Menu-Item"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1901" href="#t1901">1901</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1902" href="#t1902">1902</a></span><span class="t"> <span class="nam">custom_field_check</span><span class="op">=</span><span class="nam">_combined_custom_field_check</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1903" href="#t1903">1903</a></span><span class="t"> <span class="nam">_udeb_only_field_validation</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1904" href="#t1904">1904</a></span><span class="t"> <span class="nam">_each_value_match_regex_validation</span><span class="op">(</span><span class="nam">re</span><span class="op">.</span><span class="nam">compile</span><span class="op">(</span><span class="str">r"^[1-9]\d{3,4}$"</span><span class="op">)</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1905" href="#t1905">1905</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1906" href="#t1906">1906</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1907" href="#t1907">1907</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1908" href="#t1908">1908</a></span><span class="t"><span class="str"> This field is only relevant for `udeb` packages (debian-installer).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1909" href="#t1909">1909</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1910" href="#t1910">1910</a></span><span class="t"><span class="str"> The field is used to declare where in the installer menu this package's menu item should</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1911" href="#t1911">1911</a></span><span class="t"><span class="str"> be placed (assuming it has any menu item). For packages targeting the Debian archive,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1912" href="#t1912">1912</a></span><span class="t"><span class="str"> any new package should have its menu item number aligned with the debian-installer team</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1913" href="#t1913">1913</a></span><span class="t"><span class="str"> before upload.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1914" href="#t1914">1914</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1915" href="#t1915">1915</a></span><span class="t"><span class="str"> A menu item is 4-5 digits (In the range `1000 <= X <= 99999`). In rare cases, the menu</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1916" href="#t1916">1916</a></span><span class="t"><span class="str"> item can be architecture dependent. For architecture dependent menu item values, use a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1917" href="#t1917">1917</a></span><span class="t"><span class="str"> custom substvar.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1918" href="#t1918">1918</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1919" href="#t1919">1919</a></span><span class="t"><span class="str"> See <https://d-i.debian.org/doc/internals/apa.html> for the full list of menu item ranges</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1920" href="#t1920">1920</a></span><span class="t"><span class="str"> and for how to request a number.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1921" href="#t1921">1921</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1922" href="#t1922">1922</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1923" href="#t1923">1923</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1924" href="#t1924">1924</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1925" href="#t1925">1925</a></span><span class="t"> <span class="str">"X-DH-Build-For-Type"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1926" href="#t1926">1926</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1927" href="#t1927">1927</a></span><span class="t"> <span class="nam">custom_field_check</span><span class="op">=</span><span class="nam">_arch_not_all_only_field_validation</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1928" href="#t1928">1928</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"host"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1929" href="#t1929">1929</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1930" href="#t1930">1930</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1931" href="#t1931">1931</a></span><span class="t"> <span class="str">"host"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1932" href="#t1932">1932</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"The package should be compiled for `DEB_HOST_TARGET` (the default)."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1933" href="#t1933">1933</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1934" href="#t1934">1934</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1935" href="#t1935">1935</a></span><span class="t"> <span class="str">"target"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1936" href="#t1936">1936</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"The package should be compiled for `DEB_TARGET_ARCH`."</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1937" href="#t1937">1937</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1938" href="#t1938">1938</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1939" href="#t1939">1939</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1940" href="#t1940">1940</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1941" href="#t1941">1941</a></span><span class="t"><span class="str"> **Special-purpose only**. *This field is a special purpose field and is rarely needed.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1942" href="#t1942">1942</a></span><span class="t"><span class="str"> *You are recommended to omit unless you know you need it or someone told you to use it.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1943" href="#t1943">1943</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1944" href="#t1944">1944</a></span><span class="t"><span class="str"> This field is used when building a cross-compiling C-compiler (or similar cases), some packages need</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1945" href="#t1945">1945</a></span><span class="t"><span class="str"> to be build for target (DEB_**TARGET**_ARCH) rather than the host (DEB_**HOST**_ARCH) architecture.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1946" href="#t1946">1946</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1947" href="#t1947">1947</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1948" href="#t1948">1948</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1949" href="#t1949">1949</a></span><span class="t"><span class="str"> Package: gcc</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1950" href="#t1950">1950</a></span><span class="t"><span class="str"> Architecture: any</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1951" href="#t1951">1951</a></span><span class="t"><span class="str"> # ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1952" href="#t1952">1952</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1953" href="#t1953">1953</a></span><span class="t"><span class="str"> Package: libgcc-s1</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1954" href="#t1954">1954</a></span><span class="t"><span class="str"> Architecture: any</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1955" href="#t1955">1955</a></span><span class="t"><span class="str"> # When building a cross-compiling gcc, then this library needs to be built for the target architecture</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1956" href="#t1956">1956</a></span><span class="t"><span class="str"> # as binaries compiled by gcc will link with this library.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1957" href="#t1957">1957</a></span><span class="t"><span class="str"> X-DH-Build-For-Type: target</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1958" href="#t1958">1958</a></span><span class="t"><span class="str"> # ...</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1959" href="#t1959">1959</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1960" href="#t1960">1960</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1961" href="#t1961">1961</a></span><span class="t"><span class="str"> If you are in doubt, then you probably do **not** need this field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1962" href="#t1962">1962</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1963" href="#t1963">1963</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1964" href="#t1964">1964</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1965" href="#t1965">1965</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1966" href="#t1966">1966</a></span><span class="t"> <span class="str">"X-Time64-Compat"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1967" href="#t1967">1967</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1968" href="#t1968">1968</a></span><span class="t"> <span class="nam">custom_field_check</span><span class="op">=</span><span class="nam">_each_value_match_regex_validation</span><span class="op">(</span><span class="nam">PKGNAME_REGEX</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1969" href="#t1969">1969</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1970" href="#t1970">1970</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1971" href="#t1971">1971</a></span><span class="t"><span class="str"> Special purpose field related to the 64-bit time transition.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1972" href="#t1972">1972</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1973" href="#t1973">1973</a></span><span class="t"><span class="str"> It is used to inform packaging helpers what the original (non-transitioned) package name</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1974" href="#t1974">1974</a></span><span class="t"><span class="str"> was when the auto-detection is inadequate. The non-transitioned package name is then</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1975" href="#t1975">1975</a></span><span class="t"><span class="str"> conditionally provided in the `${t64:Provides}` substitution variable.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1976" href="#t1976">1976</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1977" href="#t1977">1977</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1978" href="#t1978">1978</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1979" href="#t1979">1979</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1980" href="#t1980">1980</a></span><span class="t"> <span class="str">"Homepage"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1981" href="#t1981">1981</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1982" href="#t1982">1982</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1983" href="#t1983">1983</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1984" href="#t1984">1984</a></span><span class="t"><span class="str"> Link to the upstream homepage for this binary package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1985" href="#t1985">1985</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1986" href="#t1986">1986</a></span><span class="t"><span class="str"> This field is rarely used in Package stanzas as most binary packages should have the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1987" href="#t1987">1987</a></span><span class="t"><span class="str"> same homepage as the source package. Though, in the exceptional case where a particular</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1988" href="#t1988">1988</a></span><span class="t"><span class="str"> binary package should have a more specific homepage than the source package, you can</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1989" href="#t1989">1989</a></span><span class="t"><span class="str"> use this field to override the source package field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1990" href="#t1990">1990</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1991" href="#t1991">1991</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1992" href="#t1992">1992</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1993" href="#t1993">1993</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1994" href="#t1994">1994</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1995" href="#t1995">1995</a></span><span class="t"> <span class="str">"Description"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1996" href="#t1996">1996</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1997" href="#t1997">1997</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1998" href="#t1998">1998</a></span><span class="t"> <span class="com"># It will build just fine. But no one will know what it is for, so it probably won't be installed</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t1999" href="#t1999">1999</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2000" href="#t2000">2000</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2001" href="#t2001">2001</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2002" href="#t2002">2002</a></span><span class="t"><span class="str"> A human-readable description of the package. This field consists of two related but distinct parts.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2003" href="#t2003">2003</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2004" href="#t2004">2004</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2005" href="#t2005">2005</a></span><span class="t"><span class="str"> The first line immediately after the field is called the *Synopsis* and is a short "noun-phrase"</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2006" href="#t2006">2006</a></span><span class="t"><span class="str"> intended to provide a one-line summary of the package. The lines after the **Synopsis** is known</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2007" href="#t2007">2007</a></span><span class="t"><span class="str"> as the **Extended Description** and is intended as a longer summary of the package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2008" href="#t2008">2008</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2009" href="#t2009">2009</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2010" href="#t2010">2010</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2011" href="#t2011">2011</a></span><span class="t"><span class="str"> Description: documentation generator for Python projects</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2012" href="#t2012">2012</a></span><span class="t"><span class="str"> Sphinx is a tool for producing documentation for Python projects, using</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2013" href="#t2013">2013</a></span><span class="t"><span class="str"> reStructuredText as markup language.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2014" href="#t2014">2014</a></span><span class="t"><span class="str"> .</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2015" href="#t2015">2015</a></span><span class="t"><span class="str"> Sphinx features:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2016" href="#t2016">2016</a></span><span class="t"><span class="str"> * HTML, CHM, LaTeX output,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2017" href="#t2017">2017</a></span><span class="t"><span class="str"> * Cross-referencing source code,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2018" href="#t2018">2018</a></span><span class="t"><span class="str"> * Automatic indices,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2019" href="#t2019">2019</a></span><span class="t"><span class="str"> * Code highlighting, using Pygments,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2020" href="#t2020">2020</a></span><span class="t"><span class="str"> * Extensibility. Existing extensions:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2021" href="#t2021">2021</a></span><span class="t"><span class="str"> - automatic testing of code snippets,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2022" href="#t2022">2022</a></span><span class="t"><span class="str"> - including docstrings from Python modules.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2023" href="#t2023">2023</a></span><span class="t"><span class="str"> .</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2024" href="#t2024">2024</a></span><span class="t"><span class="str"> Build-depend on sphinx if your package uses /usr/bin/sphinx-*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2025" href="#t2025">2025</a></span><span class="t"><span class="str"> executables. Build-depend on python3-sphinx if your package uses</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2026" href="#t2026">2026</a></span><span class="t"><span class="str"> the Python API (for instance by calling python3 -m sphinx).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2027" href="#t2027">2027</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2028" href="#t2028">2028</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2029" href="#t2029">2029</a></span><span class="t"><span class="str"> The **Synopsis** is usually displayed in cases where there is limited space such as when reviewing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2030" href="#t2030">2030</a></span><span class="t"><span class="str"> the search results from `apt search foo`. It is often a good idea to imagine that the **Synopsis**</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2031" href="#t2031">2031</a></span><span class="t"><span class="str"> part is inserted into a sentence like "The package provides {{Synopsis-goes-here}}". The</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2032" href="#t2032">2032</a></span><span class="t"><span class="str"> **Extended Description** is a standalone description that should describe what the package does and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2033" href="#t2033">2033</a></span><span class="t"><span class="str"> how it relates to the rest of the system (in terms of, for example, which subsystem it is which part of).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2034" href="#t2034">2034</a></span><span class="t"><span class="str"> Please see <https://www.debian.org/doc/debian-policy/ch-controlfields.html#description> for more details</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2035" href="#t2035">2035</a></span><span class="t"><span class="str"> about the description field and suggestions for how to write it.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2036" href="#t2036">2036</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2037" href="#t2037">2037</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2038" href="#t2038">2038</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2039" href="#t2039">2039</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2040" href="#t2040">2040</a></span><span class="t"> <span class="str">"XB-Cnf-Visible-Pkgname"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2041" href="#t2041">2041</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2042" href="#t2042">2042</a></span><span class="t"> <span class="nam">custom_field_check</span><span class="op">=</span><span class="nam">_each_value_match_regex_validation</span><span class="op">(</span><span class="nam">PKGNAME_REGEX</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2043" href="#t2043">2043</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2044" href="#t2044">2044</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2045" href="#t2045">2045</a></span><span class="t"><span class="str"> **Special-case field**: *This field is only useful in very special circumstances.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2046" href="#t2046">2046</a></span><span class="t"><span class="str"> *Consider whether you truly need it before adding this field.*</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2047" href="#t2047">2047</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2048" href="#t2048">2048</a></span><span class="t"><span class="str"> This field is used by `command-not-found` and can be used to override which package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2049" href="#t2049">2049</a></span><span class="t"><span class="str"> `command-not-found` should propose the user to install.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2050" href="#t2050">2050</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2051" href="#t2051">2051</a></span><span class="t"><span class="str"> Normally, when `command-not-found` detects a missing command, it will suggest the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2052" href="#t2052">2052</a></span><span class="t"><span class="str"> user to install the package name listed in the `Package` field. In most cases, this</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2053" href="#t2053">2053</a></span><span class="t"><span class="str"> is what you want. However, in certain special-cases, the binary is provided by a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2054" href="#t2054">2054</a></span><span class="t"><span class="str"> minimal package for technical reasons (like `python3-minimal`) and the user should</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2055" href="#t2055">2055</a></span><span class="t"><span class="str"> really install a package that provides more features (such as `python3` to follow</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2056" href="#t2056">2056</a></span><span class="t"><span class="str"> the example).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2057" href="#t2057">2057</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2058" href="#t2058">2058</a></span><span class="t"><span class="str"> **Example**:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2059" href="#t2059">2059</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2060" href="#t2060">2060</a></span><span class="t"><span class="str"> Package: python3-minimal</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2061" href="#t2061">2061</a></span><span class="t"><span class="str"> XB-Cnf-Visible-Pkgname: python3</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2062" href="#t2062">2062</a></span><span class="t"><span class="str"> ```</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2063" href="#t2063">2063</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2064" href="#t2064">2064</a></span><span class="t"><span class="str"> Related bug: <https://bugs.launchpad.net/ubuntu/+source/python-defaults/+bug/1867157></span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2065" href="#t2065">2065</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2066" href="#t2066">2066</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2067" href="#t2067">2067</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2068" href="#t2068">2068</a></span><span class="t"> <span class="nam">DctrlKnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2069" href="#t2069">2069</a></span><span class="t"> <span class="str">"X-DhRuby-Root"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2070" href="#t2070">2070</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2071" href="#t2071">2071</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2072" href="#t2072">2072</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2073" href="#t2073">2073</a></span><span class="t"><span class="str"> Used by `dh_ruby` to request "multi-binary" layout and where the root for the given</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2074" href="#t2074">2074</a></span><span class="t"><span class="str"> package is.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2075" href="#t2075">2075</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2076" href="#t2076">2076</a></span><span class="t"><span class="str"> Please refer to the documentation of `dh_ruby` for more details.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2077" href="#t2077">2077</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2078" href="#t2078">2078</a></span><span class="t"><span class="str"> <https://manpages.debian.org/dh_ruby></span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2079" href="#t2079">2079</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2080" href="#t2080">2080</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2081" href="#t2081">2081</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2082" href="#t2082">2082</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2083" href="#t2083">2083</a></span><span class="t"><span class="nam">_DEP5_HEADER_FIELDS</span> <span class="op">=</span> <span class="nam">_fields</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2084" href="#t2084">2084</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2085" href="#t2085">2085</a></span><span class="t"> <span class="str">"Format"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2086" href="#t2086">2086</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SINGLE_VALUE</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2087" href="#t2087">2087</a></span><span class="t"> <span class="nam">is_stanza_name</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2088" href="#t2088">2088</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2089" href="#t2089">2089</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2090" href="#t2090">2090</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2091" href="#t2091">2091</a></span><span class="t"> <span class="str">"Upstream-Name"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2092" href="#t2092">2092</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2093" href="#t2093">2093</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2094" href="#t2094">2094</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2095" href="#t2095">2095</a></span><span class="t"> <span class="str">"Upstream-Contact"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2096" href="#t2096">2096</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2097" href="#t2097">2097</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2098" href="#t2098">2098</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2099" href="#t2099">2099</a></span><span class="t"> <span class="str">"Source"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2100" href="#t2100">2100</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2101" href="#t2101">2101</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2102" href="#t2102">2102</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2103" href="#t2103">2103</a></span><span class="t"> <span class="str">"Disclaimer"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2104" href="#t2104">2104</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2105" href="#t2105">2105</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2106" href="#t2106">2106</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2107" href="#t2107">2107</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2108" href="#t2108">2108</a></span><span class="t"> <span class="str">"Comment"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2109" href="#t2109">2109</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2110" href="#t2110">2110</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2111" href="#t2111">2111</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2112" href="#t2112">2112</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2113" href="#t2113">2113</a></span><span class="t"> <span class="str">"License"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2114" href="#t2114">2114</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2115" href="#t2115">2115</a></span><span class="t"> <span class="com"># Do not tempt people to change legal text because the spellchecker wants to do a typo fix.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2116" href="#t2116">2116</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2117" href="#t2117">2117</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2118" href="#t2118">2118</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2119" href="#t2119">2119</a></span><span class="t"><span class="nam">_DEP5_FILES_FIELDS</span> <span class="op">=</span> <span class="nam">_fields</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2120" href="#t2120">2120</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2121" href="#t2121">2121</a></span><span class="t"> <span class="str">"Files"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2122" href="#t2122">2122</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">DEP5_FILE_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2123" href="#t2123">2123</a></span><span class="t"> <span class="nam">is_stanza_name</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2124" href="#t2124">2124</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2125" href="#t2125">2125</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2126" href="#t2126">2126</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2127" href="#t2127">2127</a></span><span class="t"> <span class="str">"Copyright"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2128" href="#t2128">2128</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2129" href="#t2129">2129</a></span><span class="t"> <span class="com"># Mostly going to be names with very little free-text; high risk of false positives with low value</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2130" href="#t2130">2130</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2131" href="#t2131">2131</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2132" href="#t2132">2132</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2133" href="#t2133">2133</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2134" href="#t2134">2134</a></span><span class="t"> <span class="str">"License"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2135" href="#t2135">2135</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2136" href="#t2136">2136</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2137" href="#t2137">2137</a></span><span class="t"> <span class="com"># Do not tempt people to change legal text because the spellchecker wants to do a typo fix.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2138" href="#t2138">2138</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2139" href="#t2139">2139</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2140" href="#t2140">2140</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2141" href="#t2141">2141</a></span><span class="t"> <span class="str">"Comment"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2142" href="#t2142">2142</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2143" href="#t2143">2143</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2144" href="#t2144">2144</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2145" href="#t2145">2145</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2146" href="#t2146">2146</a></span><span class="t"><span class="nam">_DEP5_LICENSE_FIELDS</span> <span class="op">=</span> <span class="nam">_fields</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2147" href="#t2147">2147</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2148" href="#t2148">2148</a></span><span class="t"> <span class="str">"License"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2149" href="#t2149">2149</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2150" href="#t2150">2150</a></span><span class="t"> <span class="nam">is_stanza_name</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2151" href="#t2151">2151</a></span><span class="t"> <span class="com"># Do not tempt people to change legal text because the spellchecker wants to do a typo fix.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2152" href="#t2152">2152</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">False</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2153" href="#t2153">2153</a></span><span class="t"> <span class="nam">missing_field_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Error</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2154" href="#t2154">2154</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2155" href="#t2155">2155</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2156" href="#t2156">2156</a></span><span class="t"> <span class="str">"Comment"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2157" href="#t2157">2157</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2158" href="#t2158">2158</a></span><span class="t"> <span class="nam">spellcheck_value</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2159" href="#t2159">2159</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2160" href="#t2160">2160</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2161" href="#t2161">2161</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2162" href="#t2162">2162</a></span><span class="t"><span class="nam">_DTESTSCTRL_FIELDS</span> <span class="op">=</span> <span class="nam">_fields</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2163" href="#t2163">2163</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2164" href="#t2164">2164</a></span><span class="t"> <span class="str">"Architecture"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2165" href="#t2165">2165</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">SPACE_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2166" href="#t2166">2166</a></span><span class="t"> <span class="nam">unknown_value_diagnostic_severity</span><span class="op">=</span><span class="key">None</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2167" href="#t2167">2167</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span><span class="op">*</span><span class="nam">dpkg_arch_and_wildcards</span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2168" href="#t2168">2168</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2169" href="#t2169">2169</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2170" href="#t2170">2170</a></span><span class="t"><span class="str"> When package tests are only supported on a limited set of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2171" href="#t2171">2171</a></span><span class="t"><span class="str"> architectures, or are known to not work on a particular (set of)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2172" href="#t2172">2172</a></span><span class="t"><span class="str"> architecture(s), this field can be used to define the supported</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2173" href="#t2173">2173</a></span><span class="t"><span class="str"> architectures. The autopkgtest will be skipped when the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2174" href="#t2174">2174</a></span><span class="t"><span class="str"> architecture of the testbed doesn't match the content of this</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2175" href="#t2175">2175</a></span><span class="t"><span class="str"> field. The format is the same as in (Build-)Depends, with the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2176" href="#t2176">2176</a></span><span class="t"><span class="str"> understanding that `all` is not allowed, and `any` means that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2177" href="#t2177">2177</a></span><span class="t"><span class="str"> the test will be run on every architecture, which is the default</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2178" href="#t2178">2178</a></span><span class="t"><span class="str"> when not specifying this field at all.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2179" href="#t2179">2179</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2180" href="#t2180">2180</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2181" href="#t2181">2181</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2182" href="#t2182">2182</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2183" href="#t2183">2183</a></span><span class="t"> <span class="str">"Classes"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2184" href="#t2184">2184</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2185" href="#t2185">2185</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2186" href="#t2186">2186</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2187" href="#t2187">2187</a></span><span class="t"><span class="str"> Most package tests should work in a minimal environment and are</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2188" href="#t2188">2188</a></span><span class="t"><span class="str"> usually not hardware specific. However, some packages like the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2189" href="#t2189">2189</a></span><span class="t"><span class="str"> kernel, X.org, or graphics drivers should be tested on particular</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2190" href="#t2190">2190</a></span><span class="t"><span class="str"> hardware, and also run on a set of different platforms rather than</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2191" href="#t2191">2191</a></span><span class="t"><span class="str"> just a single virtual testbeds.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2192" href="#t2192">2192</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2193" href="#t2193">2193</a></span><span class="t"><span class="str"> This field can specify a list of abstract class names such as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2194" href="#t2194">2194</a></span><span class="t"><span class="str"> "desktop" or "graphics-driver". Consumers of autopkgtest can then</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2195" href="#t2195">2195</a></span><span class="t"><span class="str"> map these class names to particular machines/platforms/policies.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2196" href="#t2196">2196</a></span><span class="t"><span class="str"> Unknown class names should be ignored.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2197" href="#t2197">2197</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2198" href="#t2198">2198</a></span><span class="t"><span class="str"> This is purely an informational field for autopkgtest itself and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2199" href="#t2199">2199</a></span><span class="t"><span class="str"> will be ignored.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2200" href="#t2200">2200</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2201" href="#t2201">2201</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2202" href="#t2202">2202</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2203" href="#t2203">2203</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2204" href="#t2204">2204</a></span><span class="t"> <span class="str">"Depends"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2205" href="#t2205">2205</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2206" href="#t2206">2206</a></span><span class="t"> <span class="nam">default_value</span><span class="op">=</span><span class="str">"@"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2207" href="#t2207">2207</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2208" href="#t2208">2208</a></span><span class="t"><span class="str"> Declares that the specified packages must be installed for the test</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2209" href="#t2209">2209</a></span><span class="t"><span class="str"> to go ahead. This supports all features of dpkg dependencies, including</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2210" href="#t2210">2210</a></span><span class="t"><span class="str"> the architecture qualifiers (see</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2211" href="#t2211">2211</a></span><span class="t"><span class="str"> <https://www.debian.org/doc/debian-policy/ch-relationships.html>),</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2212" href="#t2212">2212</a></span><span class="t"><span class="str"> plus the following extensions:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2213" href="#t2213">2213</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2214" href="#t2214">2214</a></span><span class="t"><span class="str"> `@` stands for the package(s) generated by the source package</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2215" href="#t2215">2215</a></span><span class="t"><span class="str"> containing the tests; each dependency (strictly, or-clause, which</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2216" href="#t2216">2216</a></span><span class="t"><span class="str"> may contain `|`s but not commas) containing `@` is replicated</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2217" href="#t2217">2217</a></span><span class="t"><span class="str"> once for each such binary package, with the binary package name</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2218" href="#t2218">2218</a></span><span class="t"><span class="str"> substituted for each `@` (but normally `@` should occur only</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2219" href="#t2219">2219</a></span><span class="t"><span class="str"> once and without a version restriction).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2220" href="#t2220">2220</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2221" href="#t2221">2221</a></span><span class="t"><span class="str"> `@builddeps@` will be replaced by the package's</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2222" href="#t2222">2222</a></span><span class="t"><span class="str"> `Build-Depends:`, `Build-Depends-Indep:`, `Build-Depends-Arch:`, and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2223" href="#t2223">2223</a></span><span class="t"><span class="str"> `build-essential`. This is useful if you have many build</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2224" href="#t2224">2224</a></span><span class="t"><span class="str"> dependencies which are only necessary for running the test suite and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2225" href="#t2225">2225</a></span><span class="t"><span class="str"> you don't want to replicate them in the test `Depends:`. However,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2226" href="#t2226">2226</a></span><span class="t"><span class="str"> please use this sparingly, as this can easily lead to missing binary</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2227" href="#t2227">2227</a></span><span class="t"><span class="str"> package dependencies being overlooked if they get pulled in via</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2228" href="#t2228">2228</a></span><span class="t"><span class="str"> build dependencies.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2229" href="#t2229">2229</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2230" href="#t2230">2230</a></span><span class="t"><span class="str"> `@recommends@` stands for all the packages listed in the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2231" href="#t2231">2231</a></span><span class="t"><span class="str"> `Recommends:` fields of all the binary packages mentioned in the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2232" href="#t2232">2232</a></span><span class="t"><span class="str"> `debian/control` file. Please note that variables are stripped,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2233" href="#t2233">2233</a></span><span class="t"><span class="str"> so if some required test dependencies aren't explicitly mentioned,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2234" href="#t2234">2234</a></span><span class="t"><span class="str"> they may not be installed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2235" href="#t2235">2235</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2236" href="#t2236">2236</a></span><span class="t"><span class="str"> If no Depends field is present, `Depends: @` is assumed. Note that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2237" href="#t2237">2237</a></span><span class="t"><span class="str"> the source tree's Build-Dependencies are *not* necessarily</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2238" href="#t2238">2238</a></span><span class="t"><span class="str"> installed, and if you specify any Depends, no binary packages from</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2239" href="#t2239">2239</a></span><span class="t"><span class="str"> the source are installed unless explicitly requested.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2240" href="#t2240">2240</a></span><span class="t"><span class="str"> """</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2241" href="#t2241">2241</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2242" href="#t2242">2242</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2243" href="#t2243">2243</a></span><span class="t"> <span class="str">"Features"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2244" href="#t2244">2244</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_OR_SPACE_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2245" href="#t2245">2245</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2246" href="#t2246">2246</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2247" href="#t2247">2247</a></span><span class="t"><span class="str"> Declares some additional capabilities or good properties of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2248" href="#t2248">2248</a></span><span class="t"><span class="str"> tests defined in this stanza. Any unknown features declared will be</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2249" href="#t2249">2249</a></span><span class="t"><span class="str"> completely ignored. See below for the defined features.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2250" href="#t2250">2250</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2251" href="#t2251">2251</a></span><span class="t"><span class="str"> Features are separated by commas and/or whitespace.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2252" href="#t2252">2252</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2253" href="#t2253">2253</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2254" href="#t2254">2254</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2255" href="#t2255">2255</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2256" href="#t2256">2256</a></span><span class="t"> <span class="str">"Restrictions"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2257" href="#t2257">2257</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_OR_SPACE_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2258" href="#t2258">2258</a></span><span class="t"> <span class="nam">unknown_value_diagnostic_severity</span><span class="op">=</span><span class="nam">DiagnosticSeverity</span><span class="op">.</span><span class="nam">Warning</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2259" href="#t2259">2259</a></span><span class="t"> <span class="nam">known_values</span><span class="op">=</span><span class="nam">_allowed_values</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2260" href="#t2260">2260</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2261" href="#t2261">2261</a></span><span class="t"> <span class="str">"allow-stderr"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2262" href="#t2262">2262</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2263" href="#t2263">2263</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2264" href="#t2264">2264</a></span><span class="t"><span class="str"> Output to stderr is not considered a failure. This is useful for</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2265" href="#t2265">2265</a></span><span class="t"><span class="str"> tests which write e. g. lots of logging to stderr.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2266" href="#t2266">2266</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2267" href="#t2267">2267</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2268" href="#t2268">2268</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2269" href="#t2269">2269</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2270" href="#t2270">2270</a></span><span class="t"> <span class="str">"breaks-testbed"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2271" href="#t2271">2271</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2272" href="#t2272">2272</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2273" href="#t2273">2273</a></span><span class="t"><span class="str"> The test, when run, is liable to break the testbed system. This</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2274" href="#t2274">2274</a></span><span class="t"><span class="str"> includes causing data loss, causing services that the machine is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2275" href="#t2275">2275</a></span><span class="t"><span class="str"> running to malfunction, or permanently disabling services; it does</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2276" href="#t2276">2276</a></span><span class="t"><span class="str"> not include causing services on the machine to temporarily fail.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2277" href="#t2277">2277</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2278" href="#t2278">2278</a></span><span class="t"><span class="str"> When this restriction is present the test will usually be skipped</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2279" href="#t2279">2279</a></span><span class="t"><span class="str"> unless the testbed's virtualisation arrangements are sufficiently</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2280" href="#t2280">2280</a></span><span class="t"><span class="str"> powerful, or alternatively if the user explicitly requests.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2281" href="#t2281">2281</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2282" href="#t2282">2282</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2283" href="#t2283">2283</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2284" href="#t2284">2284</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2285" href="#t2285">2285</a></span><span class="t"> <span class="str">"build-needed"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2286" href="#t2286">2286</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2287" href="#t2287">2287</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2288" href="#t2288">2288</a></span><span class="t"><span class="str"> The tests need to be run from a built source tree. The test runner</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2289" href="#t2289">2289</a></span><span class="t"><span class="str"> will build the source tree (honouring the source package's build</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2290" href="#t2290">2290</a></span><span class="t"><span class="str"> dependencies), before running the tests. However, the tests are</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2291" href="#t2291">2291</a></span><span class="t"><span class="str"> *not* entitled to assume that the source package's build</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2292" href="#t2292">2292</a></span><span class="t"><span class="str"> dependencies will be installed when the test is run.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2293" href="#t2293">2293</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2294" href="#t2294">2294</a></span><span class="t"><span class="str"> Please use this considerately, as for large builds it unnecessarily</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2295" href="#t2295">2295</a></span><span class="t"><span class="str"> builds the entire project when you only need a tiny subset (like the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2296" href="#t2296">2296</a></span><span class="t"><span class="str"> `tests/` subdirectory). It is often possible to run `make -C tests`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2297" href="#t2297">2297</a></span><span class="t"><span class="str"> instead, or copy the test code to `$AUTOPKGTEST_TMP` and build it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2298" href="#t2298">2298</a></span><span class="t"><span class="str"> there with some custom commands. This cuts down the load on the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2299" href="#t2299">2299</a></span><span class="t"><span class="str"> Continuous Integration servers and also makes tests more robust as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2300" href="#t2300">2300</a></span><span class="t"><span class="str"> it prevents accidentally running them against the built source tree</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2301" href="#t2301">2301</a></span><span class="t"><span class="str"> instead of the installed packages.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2302" href="#t2302">2302</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2303" href="#t2303">2303</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2304" href="#t2304">2304</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2305" href="#t2305">2305</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2306" href="#t2306">2306</a></span><span class="t"> <span class="str">"flaky"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2307" href="#t2307">2307</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2308" href="#t2308">2308</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2309" href="#t2309">2309</a></span><span class="t"><span class="str"> The test is expected to fail intermittently, and is not suitable for</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2310" href="#t2310">2310</a></span><span class="t"><span class="str"> gating continuous integration. This indicates a bug in either the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2311" href="#t2311">2311</a></span><span class="t"><span class="str"> package under test, a dependency or the test itself, but such bugs</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2312" href="#t2312">2312</a></span><span class="t"><span class="str"> can be difficult to fix, and it is often difficult to know when the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2313" href="#t2313">2313</a></span><span class="t"><span class="str"> bug has been fixed without running the test for a while. If a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2314" href="#t2314">2314</a></span><span class="t"><span class="str"> `flaky` test succeeds, it will be treated like any other</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2315" href="#t2315">2315</a></span><span class="t"><span class="str"> successful test, but if it fails it will be treated as though it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2316" href="#t2316">2316</a></span><span class="t"><span class="str"> had been skipped.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2317" href="#t2317">2317</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2318" href="#t2318">2318</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2319" href="#t2319">2319</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2320" href="#t2320">2320</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2321" href="#t2321">2321</a></span><span class="t"> <span class="str">"hint-testsuite-triggers"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2322" href="#t2322">2322</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2323" href="#t2323">2323</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2324" href="#t2324">2324</a></span><span class="t"><span class="str"> This test exists purely as a hint to suggest when rerunning the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2325" href="#t2325">2325</a></span><span class="t"><span class="str"> tests is likely to be useful. Specifically, it exists to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2326" href="#t2326">2326</a></span><span class="t"><span class="str"> influence the way dpkg-source generates the Testsuite-Triggers</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2327" href="#t2327">2327</a></span><span class="t"><span class="str"> .dsc header from test metadata: the Depends for this test are</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2328" href="#t2328">2328</a></span><span class="t"><span class="str"> to be added to Testsuite-Triggers. (Just as they are for any other</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2329" href="#t2329">2329</a></span><span class="t"><span class="str"> test.)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2330" href="#t2330">2330</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2331" href="#t2331">2331</a></span><span class="t"><span class="str"> The test with the hint-testsuite-triggers restriction should not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2332" href="#t2332">2332</a></span><span class="t"><span class="str"> actually be run.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2333" href="#t2333">2333</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2334" href="#t2334">2334</a></span><span class="t"><span class="str"> The packages listed as Depends for this test are usually indirect</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2335" href="#t2335">2335</a></span><span class="t"><span class="str"> dependencies, updates to which are considered to pose a risk of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2336" href="#t2336">2336</a></span><span class="t"><span class="str"> regressions in other tests defined in this package.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2337" href="#t2337">2337</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2338" href="#t2338">2338</a></span><span class="t"><span class="str"> There is currently no way to specify this hint on a per-test</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2339" href="#t2339">2339</a></span><span class="t"><span class="str"> basis; but in any case the debian.org machinery is not able to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2340" href="#t2340">2340</a></span><span class="t"><span class="str"> think about triggering individual tests.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2341" href="#t2341">2341</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2342" href="#t2342">2342</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2343" href="#t2343">2343</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2344" href="#t2344">2344</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2345" href="#t2345">2345</a></span><span class="t"> <span class="str">"isolation-container"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2346" href="#t2346">2346</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2347" href="#t2347">2347</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2348" href="#t2348">2348</a></span><span class="t"><span class="str"> The test wants to start services or open network TCP ports. This</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2349" href="#t2349">2349</a></span><span class="t"><span class="str"> commonly fails in a simple chroot/schroot, so tests need to be run</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2350" href="#t2350">2350</a></span><span class="t"><span class="str"> in their own container (e. g. autopkgtest-virt-lxc) or their own</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2351" href="#t2351">2351</a></span><span class="t"><span class="str"> machine/VM (e. g. autopkgtest-virt-qemu or autopkgtest-virt-null).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2352" href="#t2352">2352</a></span><span class="t"><span class="str"> When running the test in a virtualization server which does not</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2353" href="#t2353">2353</a></span><span class="t"><span class="str"> provide this (like autopkgtest-schroot) it will be skipped.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2354" href="#t2354">2354</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2355" href="#t2355">2355</a></span><span class="t"><span class="str"> Tests may assume that this restriction implies that process 1 in the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2356" href="#t2356">2356</a></span><span class="t"><span class="str"> container's process namespace is a system service manager (init system)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2357" href="#t2357">2357</a></span><span class="t"><span class="str"> such as systemd or sysvinit + sysv-rc, and therefore system services</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2358" href="#t2358">2358</a></span><span class="t"><span class="str"> are available via the `service(8)`, `invoke-rc.d(8)` and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2359" href="#t2359">2359</a></span><span class="t"><span class="str"> `update-rc.d(8))` interfaces.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2360" href="#t2360">2360</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2361" href="#t2361">2361</a></span><span class="t"><span class="str"> Tests must not assume that a specific init system is in use: a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2362" href="#t2362">2362</a></span><span class="t"><span class="str"> dependency such as `systemd-sysv` or `sysvinit-core` does not work</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2363" href="#t2363">2363</a></span><span class="t"><span class="str"> in practice, because switching the init system often cannot be done</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2364" href="#t2364">2364</a></span><span class="t"><span class="str"> automatically. Tests that require a specific init system should use the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2365" href="#t2365">2365</a></span><span class="t"><span class="str"> `skippable` restriction, and skip the test if the required init system</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2366" href="#t2366">2366</a></span><span class="t"><span class="str"> was not detected.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2367" href="#t2367">2367</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2368" href="#t2368">2368</a></span><span class="t"><span class="str"> Many implementations of the `isolation-container` restriction will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2369" href="#t2369">2369</a></span><span class="t"><span class="str"> also provide `systemd-logind(8)` or a compatible interface, but this</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2370" href="#t2370">2370</a></span><span class="t"><span class="str"> is not guaranteed. Tests requiring a login session registered with</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2371" href="#t2371">2371</a></span><span class="t"><span class="str"> logind should declare a dependency on `default-logind | logind`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2372" href="#t2372">2372</a></span><span class="t"><span class="str"> or on a more specific implementation of `logind`, and should use the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2373" href="#t2373">2373</a></span><span class="t"><span class="str"> `skippable` restriction to exit gracefully if its functionality is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2374" href="#t2374">2374</a></span><span class="t"><span class="str"> not available at runtime.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2375" href="#t2375">2375</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2376" href="#t2376">2376</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2377" href="#t2377">2377</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2378" href="#t2378">2378</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2379" href="#t2379">2379</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2380" href="#t2380">2380</a></span><span class="t"> <span class="str">"isolation-machine"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2381" href="#t2381">2381</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2382" href="#t2382">2382</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2383" href="#t2383">2383</a></span><span class="t"><span class="str"> The test wants to interact with the kernel, reboot the machine, or</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2384" href="#t2384">2384</a></span><span class="t"><span class="str"> other things which fail in a simple schroot and even a container.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2385" href="#t2385">2385</a></span><span class="t"><span class="str"> Those tests need to be run in their own machine/VM (e. g.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2386" href="#t2386">2386</a></span><span class="t"><span class="str"> autopkgtest-virt-qemu or autopkgtest-virt-null). When running the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2387" href="#t2387">2387</a></span><span class="t"><span class="str"> test in a virtualization server which does not provide this it will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2388" href="#t2388">2388</a></span><span class="t"><span class="str"> be skipped.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2389" href="#t2389">2389</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2390" href="#t2390">2390</a></span><span class="t"><span class="str"> This restriction also provides the same facilities as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2391" href="#t2391">2391</a></span><span class="t"><span class="str"> `isolation-container`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2392" href="#t2392">2392</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2393" href="#t2393">2393</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2394" href="#t2394">2394</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2395" href="#t2395">2395</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2396" href="#t2396">2396</a></span><span class="t"> <span class="str">"needs-internet"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2397" href="#t2397">2397</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2398" href="#t2398">2398</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2399" href="#t2399">2399</a></span><span class="t"><span class="str"> The test needs unrestricted internet access, e.g. to download test data</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2400" href="#t2400">2400</a></span><span class="t"><span class="str"> that's not shipped as a package, or to test a protocol implementation</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2401" href="#t2401">2401</a></span><span class="t"><span class="str"> against a test server. Please also see the note about Network access later</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2402" href="#t2402">2402</a></span><span class="t"><span class="str"> in this document.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2403" href="#t2403">2403</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2404" href="#t2404">2404</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2405" href="#t2405">2405</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2406" href="#t2406">2406</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2407" href="#t2407">2407</a></span><span class="t"> <span class="str">"needs-reboot"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2408" href="#t2408">2408</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2409" href="#t2409">2409</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2410" href="#t2410">2410</a></span><span class="t"><span class="str"> The test wants to reboot the machine using</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2411" href="#t2411">2411</a></span><span class="t"><span class="str"> `/tmp/autopkgtest-reboot`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2412" href="#t2412">2412</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2413" href="#t2413">2413</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2414" href="#t2414">2414</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2415" href="#t2415">2415</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2416" href="#t2416">2416</a></span><span class="t"> <span class="str">"needs-recommends"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2417" href="#t2417">2417</a></span><span class="t"> <span class="nam">is_obsolete</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2418" href="#t2418">2418</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2419" href="#t2419">2419</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2420" href="#t2420">2420</a></span><span class="t"><span class="str"> Please use `@recommends@` in your test `Depends:` instead.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2421" href="#t2421">2421</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2422" href="#t2422">2422</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2423" href="#t2423">2423</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2424" href="#t2424">2424</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2425" href="#t2425">2425</a></span><span class="t"> <span class="str">"needs-root"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2426" href="#t2426">2426</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2427" href="#t2427">2427</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2428" href="#t2428">2428</a></span><span class="t"><span class="str"> The test script must be run as root.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2429" href="#t2429">2429</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2430" href="#t2430">2430</a></span><span class="t"><span class="str"> While running tests with this restriction, some test runners will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2431" href="#t2431">2431</a></span><span class="t"><span class="str"> set the `AUTOPKGTEST_NORMAL_USER` environment variable to the name</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2432" href="#t2432">2432</a></span><span class="t"><span class="str"> of an ordinary user account. If so, the test script may drop</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2433" href="#t2433">2433</a></span><span class="t"><span class="str"> privileges from root to that user, for example via the `runuser`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2434" href="#t2434">2434</a></span><span class="t"><span class="str"> command. Test scripts must not assume that this environment variable</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2435" href="#t2435">2435</a></span><span class="t"><span class="str"> will always be set.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2436" href="#t2436">2436</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2437" href="#t2437">2437</a></span><span class="t"><span class="str"> For tests that declare both the `needs-root` and `isolation-machine`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2438" href="#t2438">2438</a></span><span class="t"><span class="str"> restrictions, the test may assume that it has "global root" with full</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2439" href="#t2439">2439</a></span><span class="t"><span class="str"> control over the kernel that is running the test, and not just root</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2440" href="#t2440">2440</a></span><span class="t"><span class="str"> in a container (more formally, it has uid 0 and full capabilities in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2441" href="#t2441">2441</a></span><span class="t"><span class="str"> the initial user namespace as defined in `user_namespaces(7)`).</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2442" href="#t2442">2442</a></span><span class="t"><span class="str"> For example, it can expect that mounting block devices will succeed.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2443" href="#t2443">2443</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2444" href="#t2444">2444</a></span><span class="t"><span class="str"> For tests that declare the `needs-root` restriction but not the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2445" href="#t2445">2445</a></span><span class="t"><span class="str"> `isolation-machine` restriction, the test will be run as uid 0 in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2446" href="#t2446">2446</a></span><span class="t"><span class="str"> a user namespace with a reasonable range of system and user uids</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2447" href="#t2447">2447</a></span><span class="t"><span class="str"> available, but will not necessarily have full control over the kernel,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2448" href="#t2448">2448</a></span><span class="t"><span class="str"> and in particular it is not guaranteed to have elevated capabilities</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2449" href="#t2449">2449</a></span><span class="t"><span class="str"> in the initial user namespace as defined by `user_namespaces(7)`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2450" href="#t2450">2450</a></span><span class="t"><span class="str"> For example, it might be run in a namespace where uid 0 is mapped to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2451" href="#t2451">2451</a></span><span class="t"><span class="str"> an ordinary uid in the initial user namespace, or it might run in a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2452" href="#t2452">2452</a></span><span class="t"><span class="str"> Docker-style container where global uid 0 is used but its ability to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2453" href="#t2453">2453</a></span><span class="t"><span class="str"> carry out operations that affect the whole system is restricted by</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2454" href="#t2454">2454</a></span><span class="t"><span class="str"> capabilities and system call filtering. Tests requiring particular</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2455" href="#t2455">2455</a></span><span class="t"><span class="str"> privileges should use the `skippable` restriction to check for</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2456" href="#t2456">2456</a></span><span class="t"><span class="str"> required functionality at runtime.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2457" href="#t2457">2457</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2458" href="#t2458">2458</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2459" href="#t2459">2459</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2460" href="#t2460">2460</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2461" href="#t2461">2461</a></span><span class="t"> <span class="str">"needs-sudo"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2462" href="#t2462">2462</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2463" href="#t2463">2463</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2464" href="#t2464">2464</a></span><span class="t"><span class="str"> The test script needs to be run as a non-root user who is a member of</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2465" href="#t2465">2465</a></span><span class="t"><span class="str"> the `sudo` group, and has the ability to elevate privileges to root</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2466" href="#t2466">2466</a></span><span class="t"><span class="str"> on-demand.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2467" href="#t2467">2467</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2468" href="#t2468">2468</a></span><span class="t"><span class="str"> This is useful for testing user components which should not normally</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2469" href="#t2469">2469</a></span><span class="t"><span class="str"> be run as root, in test scenarios that require configuring a system</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2470" href="#t2470">2470</a></span><span class="t"><span class="str"> service to support the test. For example, gvfs has a test-case which</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2471" href="#t2471">2471</a></span><span class="t"><span class="str"> uses sudo for privileged configuration of a Samba server, so that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2472" href="#t2472">2472</a></span><span class="t"><span class="str"> the unprivileged gvfs service under test can communicate with that server.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2473" href="#t2473">2473</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2474" href="#t2474">2474</a></span><span class="t"><span class="str"> While running a test with this restriction, `sudo(8)` will be</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2475" href="#t2475">2475</a></span><span class="t"><span class="str"> installed and configured to allow members of the `sudo` group to run</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2476" href="#t2476">2476</a></span><span class="t"><span class="str"> any command without password authentication.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2477" href="#t2477">2477</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2478" href="#t2478">2478</a></span><span class="t"><span class="str"> Because the test user is a member of the `sudo` group, they will</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2479" href="#t2479">2479</a></span><span class="t"><span class="str"> also gain the ability to take any other privileged actions that are</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2480" href="#t2480">2480</a></span><span class="t"><span class="str"> controlled by membership in that group. In particular, several packages</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2481" href="#t2481">2481</a></span><span class="t"><span class="str"> install `polkit(8)` policies allowing members of group `sudo` to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2482" href="#t2482">2482</a></span><span class="t"><span class="str"> take administrative actions with or without authentication.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2483" href="#t2483">2483</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2484" href="#t2484">2484</a></span><span class="t"><span class="str"> If the test requires access to additional privileged actions, it may</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2485" href="#t2485">2485</a></span><span class="t"><span class="str"> use its access to `sudo(8)` to install additional configuration</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2486" href="#t2486">2486</a></span><span class="t"><span class="str"> files, for example configuring `polkit(8)` or `doas.conf(5)`</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2487" href="#t2487">2487</a></span><span class="t"><span class="str"> to allow running `pkexec(1)` or `doas(1)` without authentication.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2488" href="#t2488">2488</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2489" href="#t2489">2489</a></span><span class="t"><span class="str"> Commands run via `sudo(8)` or another privilege-elevation tool could</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2490" href="#t2490">2490</a></span><span class="t"><span class="str"> be run with either "global root" or root in a container, depending</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2491" href="#t2491">2491</a></span><span class="t"><span class="str"> on the presence or absence of the `isolation-machine` restriction,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2492" href="#t2492">2492</a></span><span class="t"><span class="str"> in the same way described for `needs-root`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2493" href="#t2493">2493</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2494" href="#t2494">2494</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2495" href="#t2495">2495</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2496" href="#t2496">2496</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2497" href="#t2497">2497</a></span><span class="t"> <span class="str">"rw-build-tree"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2498" href="#t2498">2498</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2499" href="#t2499">2499</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2500" href="#t2500">2500</a></span><span class="t"><span class="str"> The test(s) needs write access to the built source tree (so it may</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2501" href="#t2501">2501</a></span><span class="t"><span class="str"> need to be copied first). Even with this restriction, the test is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2502" href="#t2502">2502</a></span><span class="t"><span class="str"> not allowed to make any change to the built source tree which (i)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2503" href="#t2503">2503</a></span><span class="t"><span class="str"> isn't cleaned up by `debian/rules clean`, (ii) affects the future</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2504" href="#t2504">2504</a></span><span class="t"><span class="str"> results of any test, or (iii) affects binary packages produced by</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2505" href="#t2505">2505</a></span><span class="t"><span class="str"> the build tree in the future.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2506" href="#t2506">2506</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2507" href="#t2507">2507</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2508" href="#t2508">2508</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2509" href="#t2509">2509</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2510" href="#t2510">2510</a></span><span class="t"> <span class="str">"skip-not-installable"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2511" href="#t2511">2511</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2512" href="#t2512">2512</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2513" href="#t2513">2513</a></span><span class="t"><span class="str"> This restrictions may cause a test to miss a regression due to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2514" href="#t2514">2514</a></span><span class="t"><span class="str"> installability issues, so use with caution. If one only wants to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2515" href="#t2515">2515</a></span><span class="t"><span class="str"> skip certain architectures, use the `Architecture` field for</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2516" href="#t2516">2516</a></span><span class="t"><span class="str"> that.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2517" href="#t2517">2517</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2518" href="#t2518">2518</a></span><span class="t"><span class="str"> This test might have test dependencies that can't be fulfilled in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2519" href="#t2519">2519</a></span><span class="t"><span class="str"> all suites or in derivatives. Therefore, when apt-get installs the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2520" href="#t2520">2520</a></span><span class="t"><span class="str"> test dependencies, it will fail. Don't treat this as a test</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2521" href="#t2521">2521</a></span><span class="t"><span class="str"> failure, but instead treat it as if the test was skipped.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2522" href="#t2522">2522</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2523" href="#t2523">2523</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2524" href="#t2524">2524</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2525" href="#t2525">2525</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2526" href="#t2526">2526</a></span><span class="t"> <span class="str">"skippable"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2527" href="#t2527">2527</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2528" href="#t2528">2528</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2529" href="#t2529">2529</a></span><span class="t"><span class="str"> The test might need to be skipped for reasons that cannot be</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2530" href="#t2530">2530</a></span><span class="t"><span class="str"> described by an existing restriction such as isolation-machine or</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2531" href="#t2531">2531</a></span><span class="t"><span class="str"> breaks-testbed, but must instead be detected at runtime. If the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2532" href="#t2532">2532</a></span><span class="t"><span class="str"> test exits with status 77 (a convention borrowed from Automake), it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2533" href="#t2533">2533</a></span><span class="t"><span class="str"> will be treated as though it had been skipped. If it exits with any</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2534" href="#t2534">2534</a></span><span class="t"><span class="str"> other status, its success or failure will be derived from the exit</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2535" href="#t2535">2535</a></span><span class="t"><span class="str"> status and stderr as usual. Test authors must be careful to ensure</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2536" href="#t2536">2536</a></span><span class="t"><span class="str"> that `skippable` tests never exit with status 77 for reasons that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2537" href="#t2537">2537</a></span><span class="t"><span class="str"> should be treated as a failure.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2538" href="#t2538">2538</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2539" href="#t2539">2539</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2540" href="#t2540">2540</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2541" href="#t2541">2541</a></span><span class="t"> <span class="nam">Keyword</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2542" href="#t2542">2542</a></span><span class="t"> <span class="str">"superficial"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2543" href="#t2543">2543</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2544" href="#t2544">2544</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2545" href="#t2545">2545</a></span><span class="t"><span class="str"> The test does not provide significant test coverage, so if it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2546" href="#t2546">2546</a></span><span class="t"><span class="str"> passes, that does not necessarily mean that the package under test</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2547" href="#t2547">2547</a></span><span class="t"><span class="str"> is actually functional. If a `superficial` test fails, it will be</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2548" href="#t2548">2548</a></span><span class="t"><span class="str"> treated like any other failing test, but if it succeeds, this is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2549" href="#t2549">2549</a></span><span class="t"><span class="str"> only a weak indication of success. Continuous integration systems</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2550" href="#t2550">2550</a></span><span class="t"><span class="str"> should treat a package where all non-superficial tests are skipped as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2551" href="#t2551">2551</a></span><span class="t"><span class="str"> equivalent to a package where all tests are skipped.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2552" href="#t2552">2552</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2553" href="#t2553">2553</a></span><span class="t"><span class="str"> For example, a C library might have a superficial test that simply</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2554" href="#t2554">2554</a></span><span class="t"><span class="str"> compiles, links and executes a "hello world" program against the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2555" href="#t2555">2555</a></span><span class="t"><span class="str"> library under test but does not attempt to make use of the library's</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2556" href="#t2556">2556</a></span><span class="t"><span class="str"> functionality, while a Python or Perl library might have a</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2557" href="#t2557">2557</a></span><span class="t"><span class="str"> superficial test that runs `import foo` or `require Foo;` but</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2558" href="#t2558">2558</a></span><span class="t"><span class="str"> does not attempt to use the library beyond that.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2559" href="#t2559">2559</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2560" href="#t2560">2560</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2561" href="#t2561">2561</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2562" href="#t2562">2562</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2563" href="#t2563">2563</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2564" href="#t2564">2564</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2565" href="#t2565">2565</a></span><span class="t"><span class="str"> Declares some restrictions or problems with the tests defined in</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2566" href="#t2566">2566</a></span><span class="t"><span class="str"> this stanza. Depending on the test environment capabilities, user</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2567" href="#t2567">2567</a></span><span class="t"><span class="str"> requests, and so on, restrictions can cause tests to be skipped or</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2568" href="#t2568">2568</a></span><span class="t"><span class="str"> can cause the test to be run in a different manner. Tests which</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2569" href="#t2569">2569</a></span><span class="t"><span class="str"> declare unknown restrictions will be skipped. See below for the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2570" href="#t2570">2570</a></span><span class="t"><span class="str"> defined restrictions.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2571" href="#t2571">2571</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2572" href="#t2572">2572</a></span><span class="t"><span class="str"> Restrictions are separated by commas and/or whitespace.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2573" href="#t2573">2573</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2574" href="#t2574">2574</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2575" href="#t2575">2575</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2576" href="#t2576">2576</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2577" href="#t2577">2577</a></span><span class="t"> <span class="str">"Tests"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2578" href="#t2578">2578</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">COMMA_OR_SPACE_SEPARATED_LIST</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2579" href="#t2579">2579</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2580" href="#t2580">2580</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2581" href="#t2581">2581</a></span><span class="t"><span class="str"> This field names the tests which are defined by this stanza, and map</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2582" href="#t2582">2582</a></span><span class="t"><span class="str"> to executables/scripts in the test directory. All of the other</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2583" href="#t2583">2583</a></span><span class="t"><span class="str"> fields in the same stanza apply to all of the named tests. Either</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2584" href="#t2584">2584</a></span><span class="t"><span class="str"> this field or `Test-Command:` must be present.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2585" href="#t2585">2585</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2586" href="#t2586">2586</a></span><span class="t"><span class="str"> Test names are separated by comma and/or whitespace and should</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2587" href="#t2587">2587</a></span><span class="t"><span class="str"> contain only characters which are legal in package names. It is</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2588" href="#t2588">2588</a></span><span class="t"><span class="str"> permitted, but not encouraged, to use upper-case characters as well.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2589" href="#t2589">2589</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2590" href="#t2590">2590</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2591" href="#t2591">2591</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2592" href="#t2592">2592</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2593" href="#t2593">2593</a></span><span class="t"> <span class="str">"Test-Command"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2594" href="#t2594">2594</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2595" href="#t2595">2595</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2596" href="#t2596">2596</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2597" href="#t2597">2597</a></span><span class="t"><span class="str"> If your test only contains a shell command or two, or you want to</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2598" href="#t2598">2598</a></span><span class="t"><span class="str"> reuse an existing upstream test executable and just need to wrap it</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2599" href="#t2599">2599</a></span><span class="t"><span class="str"> with some command like `dbus-launch` or `env`, you can use this</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2600" href="#t2600">2600</a></span><span class="t"><span class="str"> field to specify the shell command directly. It will be run under</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2601" href="#t2601">2601</a></span><span class="t"><span class="str"> `bash -e`. This is mutually exclusive with the `Tests:` field.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2602" href="#t2602">2602</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2603" href="#t2603">2603</a></span><span class="t"><span class="str"> This is also useful for running the same script under different</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2604" href="#t2604">2604</a></span><span class="t"><span class="str"> interpreters and/or with different dependencies, such as</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2605" href="#t2605">2605</a></span><span class="t"><span class="str"> `Test-Command: python debian/tests/mytest.py` and</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2606" href="#t2606">2606</a></span><span class="t"><span class="str"> `Test-Command: python3 debian/tests/mytest.py`.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2607" href="#t2607">2607</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2608" href="#t2608">2608</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2609" href="#t2609">2609</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2610" href="#t2610">2610</a></span><span class="t"> <span class="nam">Deb822KnownField</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2611" href="#t2611">2611</a></span><span class="t"> <span class="str">"Test-Directory"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2612" href="#t2612">2612</a></span><span class="t"> <span class="nam">FieldValueClass</span><span class="op">.</span><span class="nam">FREE_TEXT_FIELD</span><span class="op">,</span> <span class="com"># TODO: Single path</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2613" href="#t2613">2613</a></span><span class="t"> <span class="nam">hover_text</span><span class="op">=</span><span class="nam">textwrap</span><span class="op">.</span><span class="nam">dedent</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2614" href="#t2614">2614</a></span><span class="t"> <span class="str">"""\</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2615" href="#t2615">2615</a></span><span class="t"><span class="str"> Replaces the path segment `debian/tests` in the filenames of the</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2616" href="#t2616">2616</a></span><span class="t"><span class="str"> test programs with `path`. I. e., the tests are run by executing</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2617" href="#t2617">2617</a></span><span class="t"><span class="str"> `built/source/tree/path/testname`. `path` must be a relative</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2618" href="#t2618">2618</a></span><span class="t"><span class="str"> path and is interpreted starting from the root of the built source</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2619" href="#t2619">2619</a></span><span class="t"><span class="str"> tree.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2620" href="#t2620">2620</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2621" href="#t2621">2621</a></span><span class="t"><span class="str"> This allows tests to live outside the `debian/` metadata area, so that</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2622" href="#t2622">2622</a></span><span class="t"><span class="str"> they can more palatably be shared with non-Debian distributions.</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2623" href="#t2623">2623</a></span><span class="t"><span class="str"> """</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2624" href="#t2624">2624</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2625" href="#t2625">2625</a></span><span class="t"> <span class="op">)</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2626" href="#t2626">2626</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2627" href="#t2627">2627</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2628" href="#t2628">2628</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2629" href="#t2629">2629</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">slots</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2630" href="#t2630">2630</a></span><span class="t"><span class="key">class</span> <span class="nam">StanzaMetadata</span><span class="op">(</span><span class="nam">Mapping</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">F</span><span class="op">]</span><span class="op">,</span> <span class="nam">Generic</span><span class="op">[</span><span class="nam">F</span><span class="op">]</span><span class="op">,</span> <span class="nam">ABC</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2631" href="#t2631">2631</a></span><span class="t"> <span class="nam">stanza_type_name</span><span class="op">:</span> <span class="nam">str</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2632" href="#t2632">2632</a></span><span class="t"> <span class="nam">stanza_fields</span><span class="op">:</span> <span class="nam">Mapping</span><span class="op">[</span><span class="nam">str</span><span class="op">,</span> <span class="nam">F</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2633" href="#t2633">2633</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2634" href="#t2634">2634</a></span><span class="t"> <span class="key">def</span> <span class="nam">stanza_diagnostics</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2635" href="#t2635">2635</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2636" href="#t2636">2636</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2637" href="#t2637">2637</a></span><span class="t"> <span class="nam">stanza_position_in_file</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2638" href="#t2638">2638</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t2639" href="#t2639">2639</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2640" href="#t2640">2640</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2641" href="#t2641">2641</a></span><span class="t"> <span class="key">def</span> <span class="nam">__getitem__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">key</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">F</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2642" href="#t2642">2642</a></span><span class="t"> <span class="nam">key_lc</span> <span class="op">=</span> <span class="nam">key</span><span class="op">.</span><span class="nam">lower</span><span class="op">(</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2643" href="#t2643">2643</a></span><span class="t"> <span class="nam">key_norm</span> <span class="op">=</span> <span class="nam">normalize_dctrl_field_name</span><span class="op">(</span><span class="nam">key_lc</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2644" href="#t2644">2644</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">stanza_fields</span><span class="op">[</span><span class="nam">key_norm</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2645" href="#t2645">2645</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2646" href="#t2646">2646</a></span><span class="t"> <span class="key">def</span> <span class="nam">__len__</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">int</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2647" href="#t2647">2647</a></span><span class="t"> <span class="key">return</span> <span class="nam">len</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">stanza_fields</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2648" href="#t2648">2648</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2649" href="#t2649">2649</a></span><span class="t"> <span class="key">def</span> <span class="nam">__iter__</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2650" href="#t2650">2650</a></span><span class="t"> <span class="key">return</span> <span class="nam">iter</span><span class="op">(</span><span class="nam">self</span><span class="op">.</span><span class="nam">stanza_fields</span><span class="op">.</span><span class="nam">keys</span><span class="op">(</span><span class="op">)</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2651" href="#t2651">2651</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2652" href="#t2652">2652</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2653" href="#t2653">2653</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">slots</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2654" href="#t2654">2654</a></span><span class="t"><span class="key">class</span> <span class="nam">Dep5StanzaMetadata</span><span class="op">(</span><span class="nam">StanzaMetadata</span><span class="op">[</span><span class="nam">Deb822KnownField</span><span class="op">]</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2655" href="#t2655">2655</a></span><span class="t"> <span class="key">def</span> <span class="nam">stanza_diagnostics</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2656" href="#t2656">2656</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2657" href="#t2657">2657</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2658" href="#t2658">2658</a></span><span class="t"> <span class="nam">stanza_position_in_file</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2659" href="#t2659">2659</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2660" href="#t2660">2660</a></span><span class="t"> <span class="key">pass</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2661" href="#t2661">2661</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2662" href="#t2662">2662</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2663" href="#t2663">2663</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">slots</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2664" href="#t2664">2664</a></span><span class="t"><span class="key">class</span> <span class="nam">DctrlStanzaMetadata</span><span class="op">(</span><span class="nam">StanzaMetadata</span><span class="op">[</span><span class="nam">DctrlKnownField</span><span class="op">]</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2665" href="#t2665">2665</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2666" href="#t2666">2666</a></span><span class="t"> <span class="key">def</span> <span class="nam">stanza_diagnostics</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2667" href="#t2667">2667</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2668" href="#t2668">2668</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2669" href="#t2669">2669</a></span><span class="t"> <span class="nam">stanza_position_in_file</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2670" href="#t2670">2670</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2671" href="#t2671">2671</a></span><span class="t"> <span class="key">pass</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2672" href="#t2672">2672</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2673" href="#t2673">2673</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2674" href="#t2674">2674</a></span><span class="t"><span class="op">@</span><span class="nam">dataclasses</span><span class="op">.</span><span class="nam">dataclass</span><span class="op">(</span><span class="nam">slots</span><span class="op">=</span><span class="key">True</span><span class="op">,</span> <span class="nam">frozen</span><span class="op">=</span><span class="key">True</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2675" href="#t2675">2675</a></span><span class="t"><span class="key">class</span> <span class="nam">DTestsCtrlStanzaMetadata</span><span class="op">(</span><span class="nam">StanzaMetadata</span><span class="op">[</span><span class="nam">Deb822KnownField</span><span class="op">]</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2676" href="#t2676">2676</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2677" href="#t2677">2677</a></span><span class="t"> <span class="key">def</span> <span class="nam">stanza_diagnostics</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2678" href="#t2678">2678</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2679" href="#t2679">2679</a></span><span class="t"> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2680" href="#t2680">2680</a></span><span class="t"> <span class="nam">stanza_position_in_file</span><span class="op">:</span> <span class="str">"TEPosition"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2681" href="#t2681">2681</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2682" href="#t2682">2682</a></span><span class="t"> <span class="key">pass</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2683" href="#t2683">2683</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2684" href="#t2684">2684</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2685" href="#t2685">2685</a></span><span class="t"><span class="key">class</span> <span class="nam">Deb822FileMetadata</span><span class="op">(</span><span class="nam">Generic</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2686" href="#t2686">2686</a></span><span class="t"> <span class="key">def</span> <span class="nam">classify_stanza</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> <span class="nam">stanza_idx</span><span class="op">:</span> <span class="nam">int</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2687" href="#t2687">2687</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">.</span><span class="nam">guess_stanza_classification_by_idx</span><span class="op">(</span><span class="nam">stanza_idx</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2688" href="#t2688">2688</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2689" href="#t2689">2689</a></span><span class="t"> <span class="key">def</span> <span class="nam">guess_stanza_classification_by_idx</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">stanza_idx</span><span class="op">:</span> <span class="nam">int</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t2690" href="#t2690">2690</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2691" href="#t2691">2691</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2692" href="#t2692">2692</a></span><span class="t"> <span class="key">def</span> <span class="nam">stanza_types</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t2693" href="#t2693">2693</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2694" href="#t2694">2694</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2695" href="#t2695">2695</a></span><span class="t"> <span class="key">def</span> <span class="nam">__getitem__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">item</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t2696" href="#t2696">2696</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2697" href="#t2697">2697</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2698" href="#t2698">2698</a></span><span class="t"> <span class="key">def</span> <span class="nam">file_diagnostics</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2699" href="#t2699">2699</a></span><span class="t"> <span class="nam">self</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2700" href="#t2700">2700</a></span><span class="t"> <span class="nam">file</span><span class="op">:</span> <span class="nam">Deb822FileElement</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2701" href="#t2701">2701</a></span><span class="t"> <span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">Diagnostic</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="exc show_exc"><span class="n"><a id="t2702" href="#t2702">2702</a></span><span class="t"> <span class="key">raise</span> <span class="nam">NotImplementedError</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2703" href="#t2703">2703</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2704" href="#t2704">2704</a></span><span class="t"> <span class="key">def</span> <span class="nam">get</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">item</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Optional</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2705" href="#t2705">2705</a></span><span class="t"> <span class="key">try</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2706" href="#t2706">2706</a></span><span class="t"> <span class="key">return</span> <span class="nam">self</span><span class="op">[</span><span class="nam">item</span><span class="op">]</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2707" href="#t2707">2707</a></span><span class="t"> <span class="key">except</span> <span class="nam">KeyError</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2708" href="#t2708">2708</a></span><span class="t"> <span class="key">return</span> <span class="key">None</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2709" href="#t2709">2709</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2710" href="#t2710">2710</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2711" href="#t2711">2711</a></span><span class="t"><span class="nam">_DCTRL_SOURCE_STANZA</span> <span class="op">=</span> <span class="nam">DctrlStanzaMetadata</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2712" href="#t2712">2712</a></span><span class="t"> <span class="str">"Source"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2713" href="#t2713">2713</a></span><span class="t"> <span class="nam">SOURCE_FIELDS</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2714" href="#t2714">2714</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2715" href="#t2715">2715</a></span><span class="t"><span class="nam">_DCTRL_PACKAGE_STANZA</span> <span class="op">=</span> <span class="nam">DctrlStanzaMetadata</span><span class="op">(</span><span class="str">"Package"</span><span class="op">,</span> <span class="nam">BINARY_FIELDS</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2716" href="#t2716">2716</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2717" href="#t2717">2717</a></span><span class="t"><span class="nam">_DEP5_HEADER_STANZA</span> <span class="op">=</span> <span class="nam">Dep5StanzaMetadata</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2718" href="#t2718">2718</a></span><span class="t"> <span class="str">"Header"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2719" href="#t2719">2719</a></span><span class="t"> <span class="nam">_DEP5_HEADER_FIELDS</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2720" href="#t2720">2720</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2721" href="#t2721">2721</a></span><span class="t"><span class="nam">_DEP5_FILES_STANZA</span> <span class="op">=</span> <span class="nam">Dep5StanzaMetadata</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2722" href="#t2722">2722</a></span><span class="t"> <span class="str">"Files"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2723" href="#t2723">2723</a></span><span class="t"> <span class="nam">_DEP5_FILES_FIELDS</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2724" href="#t2724">2724</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2725" href="#t2725">2725</a></span><span class="t"><span class="nam">_DEP5_LICENSE_STANZA</span> <span class="op">=</span> <span class="nam">Dep5StanzaMetadata</span><span class="op">(</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2726" href="#t2726">2726</a></span><span class="t"> <span class="str">"License"</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2727" href="#t2727">2727</a></span><span class="t"> <span class="nam">_DEP5_LICENSE_FIELDS</span><span class="op">,</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2728" href="#t2728">2728</a></span><span class="t"><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2729" href="#t2729">2729</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2730" href="#t2730">2730</a></span><span class="t"><span class="nam">_DTESTSCTRL_STANZA</span> <span class="op">=</span> <span class="nam">DTestsCtrlStanzaMetadata</span><span class="op">(</span><span class="str">"Tests"</span><span class="op">,</span> <span class="nam">_DTESTSCTRL_FIELDS</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2731" href="#t2731">2731</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2732" href="#t2732">2732</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2733" href="#t2733">2733</a></span><span class="t"><span class="key">class</span> <span class="nam">Dep5FileMetadata</span><span class="op">(</span><span class="nam">Deb822FileMetadata</span><span class="op">[</span><span class="nam">Dep5StanzaMetadata</span><span class="op">]</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2734" href="#t2734">2734</a></span><span class="t"> <span class="key">def</span> <span class="nam">classify_stanza</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">stanza</span><span class="op">:</span> <span class="nam">Deb822ParagraphElement</span><span class="op">,</span> <span class="nam">stanza_idx</span><span class="op">:</span> <span class="nam">int</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2735" href="#t2735">2735</a></span><span class="t"> <span class="key">if</span> <span class="nam">stanza_idx</span> <span class="op">==</span> <span class="num">0</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2736" href="#t2736">2736</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DEP5_HEADER_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2737" href="#t2737">2737</a></span><span class="t"> <span class="key">if</span> <span class="nam">stanza_idx</span> <span class="op">></span> <span class="num">0</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2738" href="#t2738">2738</a></span><span class="t"> <span class="key">if</span> <span class="str">"Files"</span> <span class="key">in</span> <span class="nam">stanza</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2739" href="#t2739">2739</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DEP5_FILES_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2740" href="#t2740">2740</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DEP5_LICENSE_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2741" href="#t2741">2741</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"The stanza_idx must be 0 or greater"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2742" href="#t2742">2742</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2743" href="#t2743">2743</a></span><span class="t"> <span class="key">def</span> <span class="nam">guess_stanza_classification_by_idx</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">stanza_idx</span><span class="op">:</span> <span class="nam">int</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2744" href="#t2744">2744</a></span><span class="t"> <span class="key">if</span> <span class="nam">stanza_idx</span> <span class="op">==</span> <span class="num">0</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2745" href="#t2745">2745</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DEP5_HEADER_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2746" href="#t2746">2746</a></span><span class="t"> <span class="key">if</span> <span class="nam">stanza_idx</span> <span class="op">></span> <span class="num">0</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2747" href="#t2747">2747</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DEP5_FILES_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2748" href="#t2748">2748</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"The stanza_idx must be 0 or greater"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2749" href="#t2749">2749</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2750" href="#t2750">2750</a></span><span class="t"> <span class="key">def</span> <span class="nam">stanza_types</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2751" href="#t2751">2751</a></span><span class="t"> <span class="key">yield</span> <span class="nam">_DEP5_HEADER_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2752" href="#t2752">2752</a></span><span class="t"> <span class="key">yield</span> <span class="nam">_DEP5_FILES_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2753" href="#t2753">2753</a></span><span class="t"> <span class="key">yield</span> <span class="nam">_DEP5_LICENSE_STANZA</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2754" href="#t2754">2754</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2755" href="#t2755">2755</a></span><span class="t"> <span class="key">def</span> <span class="nam">__getitem__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">item</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2756" href="#t2756">2756</a></span><span class="t"> <span class="key">if</span> <span class="nam">item</span> <span class="op">==</span> <span class="str">"Header"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2757" href="#t2757">2757</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DEP5_FILES_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2758" href="#t2758">2758</a></span><span class="t"> <span class="key">if</span> <span class="nam">item</span> <span class="op">==</span> <span class="str">"Files"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2759" href="#t2759">2759</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DEP5_FILES_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2760" href="#t2760">2760</a></span><span class="t"> <span class="key">if</span> <span class="nam">item</span> <span class="op">==</span> <span class="str">"License"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2761" href="#t2761">2761</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DEP5_LICENSE_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2762" href="#t2762">2762</a></span><span class="t"> <span class="key">raise</span> <span class="nam">KeyError</span><span class="op">(</span><span class="nam">item</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2763" href="#t2763">2763</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2764" href="#t2764">2764</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2765" href="#t2765">2765</a></span><span class="t"><span class="key">class</span> <span class="nam">DctrlFileMetadata</span><span class="op">(</span><span class="nam">Deb822FileMetadata</span><span class="op">[</span><span class="nam">DctrlStanzaMetadata</span><span class="op">]</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2766" href="#t2766">2766</a></span><span class="t"> <span class="key">def</span> <span class="nam">guess_stanza_classification_by_idx</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">stanza_idx</span><span class="op">:</span> <span class="nam">int</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t2767" href="#t2767">2767</a></span><span class="t"> <span class="key">if</span> <span class="nam">stanza_idx</span> <span class="op">==</span> <span class="num">0</span><span class="op">:</span> </span><span class="r"><span class="annotate short">2767 ↛ 2768</span><span class="annotate long">line 2767 didn't jump to line 2768, because the condition on line 2767 was never true</span></span></p> - <p class="mis show_mis"><span class="n"><a id="t2768" href="#t2768">2768</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DCTRL_SOURCE_STANZA</span> </span><span class="r"></span></p> - <p class="par run show_par"><span class="n"><a id="t2769" href="#t2769">2769</a></span><span class="t"> <span class="key">if</span> <span class="nam">stanza_idx</span> <span class="op">></span> <span class="num">0</span><span class="op">:</span> </span><span class="r"><span class="annotate short">2769 ↛ 2771</span><span class="annotate long">line 2769 didn't jump to line 2771, because the condition on line 2769 was never false</span></span></p> - <p class="run"><span class="n"><a id="t2770" href="#t2770">2770</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DCTRL_PACKAGE_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2771" href="#t2771">2771</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"The stanza_idx must be 0 or greater"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2772" href="#t2772">2772</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2773" href="#t2773">2773</a></span><span class="t"> <span class="key">def</span> <span class="nam">stanza_types</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2774" href="#t2774">2774</a></span><span class="t"> <span class="key">yield</span> <span class="nam">_DCTRL_SOURCE_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2775" href="#t2775">2775</a></span><span class="t"> <span class="key">yield</span> <span class="nam">_DCTRL_PACKAGE_STANZA</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2776" href="#t2776">2776</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2777" href="#t2777">2777</a></span><span class="t"> <span class="key">def</span> <span class="nam">__getitem__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">item</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2778" href="#t2778">2778</a></span><span class="t"> <span class="key">if</span> <span class="nam">item</span> <span class="op">==</span> <span class="str">"Source"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2779" href="#t2779">2779</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DCTRL_SOURCE_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2780" href="#t2780">2780</a></span><span class="t"> <span class="key">if</span> <span class="nam">item</span> <span class="op">==</span> <span class="str">"Package"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2781" href="#t2781">2781</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DCTRL_PACKAGE_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2782" href="#t2782">2782</a></span><span class="t"> <span class="key">raise</span> <span class="nam">KeyError</span><span class="op">(</span><span class="nam">item</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2783" href="#t2783">2783</a></span><span class="t"> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2784" href="#t2784">2784</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2785" href="#t2785">2785</a></span><span class="t"><span class="key">class</span> <span class="nam">DTestsCtrlFileMetadata</span><span class="op">(</span><span class="nam">Deb822FileMetadata</span><span class="op">[</span><span class="nam">DctrlStanzaMetadata</span><span class="op">]</span><span class="op">)</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2786" href="#t2786">2786</a></span><span class="t"> <span class="key">def</span> <span class="nam">guess_stanza_classification_by_idx</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">stanza_idx</span><span class="op">:</span> <span class="nam">int</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2787" href="#t2787">2787</a></span><span class="t"> <span class="key">if</span> <span class="nam">stanza_idx</span> <span class="op">>=</span> <span class="num">0</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2788" href="#t2788">2788</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DTESTSCTRL_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2789" href="#t2789">2789</a></span><span class="t"> <span class="key">raise</span> <span class="nam">ValueError</span><span class="op">(</span><span class="str">"The stanza_idx must be 0 or greater"</span><span class="op">)</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2790" href="#t2790">2790</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2791" href="#t2791">2791</a></span><span class="t"> <span class="key">def</span> <span class="nam">stanza_types</span><span class="op">(</span><span class="nam">self</span><span class="op">)</span> <span class="op">-></span> <span class="nam">Iterable</span><span class="op">[</span><span class="nam">S</span><span class="op">]</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2792" href="#t2792">2792</a></span><span class="t"> <span class="key">yield</span> <span class="nam">_DTESTSCTRL_STANZA</span> </span><span class="r"></span></p> - <p class="pln"><span class="n"><a id="t2793" href="#t2793">2793</a></span><span class="t"> </span><span class="r"></span></p> - <p class="run"><span class="n"><a id="t2794" href="#t2794">2794</a></span><span class="t"> <span class="key">def</span> <span class="nam">__getitem__</span><span class="op">(</span><span class="nam">self</span><span class="op">,</span> <span class="nam">item</span><span class="op">:</span> <span class="nam">str</span><span class="op">)</span> <span class="op">-></span> <span class="nam">S</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2795" href="#t2795">2795</a></span><span class="t"> <span class="key">if</span> <span class="nam">item</span> <span class="op">==</span> <span class="str">"Tests"</span><span class="op">:</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2796" href="#t2796">2796</a></span><span class="t"> <span class="key">return</span> <span class="nam">_DTESTSCTRL_STANZA</span> </span><span class="r"></span></p> - <p class="mis show_mis"><span class="n"><a id="t2797" href="#t2797">2797</a></span><span class="t"> <span class="key">raise</span> <span class="nam">KeyError</span><span class="op">(</span><span class="nam">item</span><span class="op">)</span> </span><span class="r"></span></p> -</main> -<footer> - <div class="content"> - <p> - <a id="prevFileLink" class="nav" href="d_5d0ec0d5422112df_lsp_debian_control_py.html">« prev</a> - <a id="indexLink" class="nav" href="index.html">^ index</a> - <a id="nextFileLink" class="nav" href="d_5d0ec0d5422112df_lsp_debian_copyright_py.html">» next</a> - - <a class="nav" href="https://coverage.readthedocs.io/en/7.2.7">coverage.py v7.2.7</a>, - created at 2024-04-07 12:14 +0200 - </p> - </div> -</footer> -</body> -</html> |