nathanwilliams-ct opened a new issue, #2197: URL: https://github.com/apache/buildstream/issues/2197
bst_docs project provides a rendered view of a Buildstream project. For rendering the `project.conf` it might be nice if it contained a short description of the project. e.g. something to go between the title and other content: example: ------ <h1>freedesktop-sdk</h1> <p>Some description of freedesktop-sdk could go here before we jump into project options.</p> <h2>Project Options</h2> <p>Options can be configured by users to build the project in different ways.</p> <p>These are all the options that are available for freedesktop-sdk</p> <h3>bootstrap_build_arch</h3> <p>Architecture</p> <p>The option maps to the variable: <code>bootstrap_build_arch</code></p> <p>The option is of type architecture</p> <p>The option defaults to the result of <code>uname -m</code> and the following architectures are supported: </p> <ul> <li><code>aarch64</code></li> <li><code>x86_64</code></li> <li><code>ppc64le</code></li> <li><code>riscv64</code></li> <li><code>loongarch64</code></li> </ul> <h3>target_arch</h3> <p>Architecture</p> <p>The option maps to the variable: <code>target_arch</code></p> <p>The option is of type architecture</p> <p>The option defaults to the result of <code>uname -m</code> and the following architectures are supported: </p> <ul> <li><code>aarch64</code></li> <li><code>i686</code></li> <li><code>x86_64</code></li> <li><code>ppc64le</code></li> <li><code>ppc64</code></li> <li><code>riscv64</code></li> <li><code>loongarch64</code></li> </ul> <h3>minimal_vm</h3> <p>Parts to include in minimal vm builds (firmware, locale).</p> <p>This option is not mapped to a variable.</p> <p>The option is of type flags.</p> <p>The flags that are set by default are ['locale']</p> <p>The following flags are available:</p> <ul> <li><code>firmware</code></li> <li><code>locale</code></li> </ul> <h3>full_abi_diff</h3> <p>Forces full ABI diff on</p> <p>The option maps to the variable: <code>full_abi_diff</code></p> <p>The option is of type boolean.</p> <p>The default value is <code>False</code>, and it can be either <code>True</code> or <code>False</code></p> <h3>x86_64_v3</h3> <p>Enable x86_64-v3 (EXPERIMENTAL)</p> <p>This option is not mapped to a variable.</p> <p>The option is of type boolean.</p> <p>The default value is <code>False</code>, and it can be either <code>True</code> or <code>False</code></p> <h3>prod_keys</h3> <p>Use production boot keys</p> <p>This option is not mapped to a variable.</p> <p>The option is of type boolean.</p> <p>The default value is <code>False</code>, and it can be either <code>True</code> or <code>False</code></p> <h2>Config</h2> --- (from https://gitlab.com/BuildStream/bst-docs/-/merge_requests/13#note_3971925980) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
