Skip to content

Commit

Permalink
refresh some documents for readability manually
Browse files Browse the repository at this point in the history
  • Loading branch information
@superm1
superm1 committed Jan 7, 2024
1 parent 321af41 commit ef350b1
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 44 deletions.
75 changes: 42 additions & 33 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,19 @@ <h2><a href="index.html">fwupd documentation</a></h2>
</div>
</div>
<section id="main" style="max-width: 100%" class="content">
<header>
<h1>End user documentation</h1>
</header>

<header>
<h1>Manual pages</h1>
<h2>Manual pages</h2>
<div class="description">
<p>Manual pages for interacting with fwupd</p>
<p>Manual pages for interacting with fwupd.</p>
</div>
</header>
<ul>
<li><a href="libfwupdplugin/fwupd-refresh.service.html">fwupd-refresh.service</a></li>
</ul>
<ul>
<li><a href="libfwupdplugin/dbxtool.html">dbxtool</a></li>
</ul>
Expand All @@ -47,7 +53,37 @@ <h1>Manual pages</h1>
<li><a href="libfwupdplugin/fwupd-remotes.d.html">fwupd-remotes.d</a></li>
</ul>
<header>
<h1>Building fwupd</h1>
<h2>Host Security ID</h2>
<div class="description">
<p>The fwupd HSI specification.</p>
</div>
</header>
<ul>
<li><a href="libfwupdplugin/hsi.html">Public specification</a></li>
</ul>
<header>
<h1>BIOS Settings</h2>
<div class="description">
<p>The fwupd BIOS settings interface</p>
</div>
</header>
<ul>
<li><a href="libfwupdplugin/bios-settings.html">User documentation</a></li>
</ul>
<header>
<h2>Supermicro BMC license issue</h2>
<div class="description">
<p>Fixing the missing license issue when updating Supermicro boards</p>
</div>
</header>
<ul>
<li><a href="libfwupdplugin/supermicro-license.html">Issue</a></li>
</ul>
<header>
<h1>Developer documentation</h1>
</header>
<header>
<h2>Building fwupd</h2>
<div class="description">
<p>Building using the fwupd development environment</p>
</div>
Expand All @@ -56,7 +92,7 @@ <h1>Building fwupd</h1>
<li><a href="libfwupdplugin/building.html">Building and debugging</a></li>
</ul>
<header>
<h1>libfwupd</h1>
<h2>libfwupd</h2>
<div class="description">
<p>Functionality exported by libfwupd for client applications.</p>
</div>
Expand All @@ -65,7 +101,7 @@ <h1>libfwupd</h1>
<li><a href="libfwupd/index.html">Developer documentation</a></li>
</ul>
<header>
<h1>libfwupdplugin</h1>
<h2>libfwupdplugin</h2>
<div class="description">
<p>Functionality available to fwupd plugins.</p>
</div>
Expand All @@ -86,41 +122,14 @@ <h1>libfwupdplugin</h1>
<li><a href="libfwupdplugin/env.html">Environment variables</a></li>
</ul>
<header>
<h1>Host Security ID</h1>
<div class="description">
<p>The fwupd HSI specification.</p>
</div>
</header>
<ul>
<li><a href="libfwupdplugin/hsi.html">Public specification</a></li>
</ul>
<header>
<h1>BIOS Settings</h1>
<div class="description">
<p>The fwupd BIOS settings interface</p>
</div>
</header>
<ul>
<li><a href="libfwupdplugin/bios-settings.html">User documentation</a></li>
</ul>
<header>
<h1>BOS DS20 Specification</h1>
<h2>BOS DS20 Specification</h2>
<div class="description">
<p>The fwupd Binary Object Store descriptor specification</p>
</div>
</header>
<ul>
<li><a href="libfwupdplugin/ds20.html">Documentation</a></li>
</ul>
<header>
<h1>Supermicro BMC license issue</h1>
<div class="description">
<p>Fixing the missing license issue when updating Supermicro boards</p>
</div>
</header>
<ul>
<li><a href="libfwupdplugin/supermicro-license.html">Issue</a></li>
</ul>
</section>
</body>
</html>
29 changes: 18 additions & 11 deletions libfwupdplugin/building.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>FwupdPlugin &ndash; 1.0: Unknown document</title>
<title>FwupdPlugin &ndash; 1.0: Building &amp; Debugging fwupd</title>
<meta name="viewport" content="width=device-width, initial-scale=1">

<meta charset="utf-8" />
Expand All @@ -23,10 +23,10 @@



<meta property="og:title" content="FwupdPlugin: Unknown document"/>
<meta property="og:description" content="Reference for FwupdPlugin-1.0: Unknown document"/>
<meta name="twitter:title" content="FwupdPlugin: Unknown document"/>
<meta name="twitter:description" content="Reference for FwupdPlugin-1.0: Unknown document"/>
<meta property="og:title" content="FwupdPlugin: Building &amp; Debugging fwupd"/>
<meta property="og:description" content="Reference for FwupdPlugin-1.0: Building &amp; Debugging fwupd"/>
<meta name="twitter:title" content="FwupdPlugin: Building &amp; Debugging fwupd"/>
<meta name="twitter:description" content="Reference for FwupdPlugin-1.0: Building &amp; Debugging fwupd"/>



Expand Down Expand Up @@ -87,15 +87,14 @@ <h3><a href="index.html">FwupdPlugin</a></h3>
<section id="main" class="content">

<h4 id="title" style="display:flex;">
Unknown document
Building &amp; Debugging fwupd
<a href="#title" class="anchor"></a>

</h4>

<section>
<div class="docblock">
<h1 id="building-fwupd">Building fwupd<a class="md-anchor" href="#building-fwupd" title="Permanent link"></a></h1>
<p>These instructons below can either be used by the silicon vendor, or the consulting company to debug existing and new plugins. Sometimes new hardware is only supported in the development version of fwupd which may not even be available as a Snap or Flatpak&nbsp;yet.</p>
<p>These instructons below can either be used by the silicon vendor, or the consulting company to debug existing and new plugins. Sometimes new hardware is only supported in the development version of fwupd which may not even be available as a Snap or Flatpak&nbsp;yet.</p>
<h2 id="prerequisites">Prerequisites<a class="md-anchor" href="#prerequisites" title="Permanent link"></a></h2>
<ul>
<li>
Expand All @@ -105,7 +104,7 @@ <h2 id="prerequisites">Prerequisites<a class="md-anchor" href="#prerequisites" t
<p>Working access to the&nbsp;internet</p>
</li>
<li>
<p>A user account (we’ll use emily as the example here) with administrator&nbsp;permissions</p>
<p>A user account (we’ll use <code>u</code> as the example here) with administrator&nbsp;permissions</p>
</li>
</ul>
<h2 id="setup-fwupd-development-environment">Setup fwupd development environment<a class="md-anchor" href="#setup-fwupd-development-environment" title="Permanent link"></a></h2>
Expand Down Expand Up @@ -147,7 +146,7 @@ <h2 id="running-binaries">Running binaries<a class="md-anchor" href="#running-bi
<p><strong>fwupdtool</strong>: The debugging tool developers use to find problems and to run new code, as&nbsp;root</p>
</li>
</ol>
<p>The <code>fwupdtool</code> binary does most of the things that <code>fwupdmgr</code> does, but without talking to the system fwupd instance. It is a lot easier to run <code>fwupdtool</code> with just one plugin (e.g. <code>--plugin-whitelist vli</code>) than running the daemon and all the plugins. You might have to wait 5 seconds and then read thousands of lines of debugging to see the <code>printf()</code> you added in a new plugin with the daemon, but with <code>fwupdtool --plugin-whitelist vli --verbose get-devices</code> it’ll be in a few lines, and&nbsp;instant.</p>
<p>The <code>fwupdtool</code> binary does most of the things that <code>fwupdmgr</code> does, but without talking to the system fwupd instance. It is a lot easier to run <code>fwupdtool</code> with just one plugin (e.g. <code>--plugins vli</code>) than running the daemon and all the plugins. You might have to wait 5 seconds and then read thousands of lines of debugging to see the <code>printf()</code> you added in a new plugin with the daemon, but with <code>fwupdtool --plugins vli --verbose get-devices</code> it’ll be in a few lines, and&nbsp;instant.</p>
<p>Within the development environment wrappers have been setup to allow launching <code>fwupd</code>, <code>fwupdtool</code> or <code>fwupdmgr</code> very similar to a host&nbsp;system.</p>
<p>There are 3 main differences to&nbsp;note:</p>
<ol>
Expand Down Expand Up @@ -193,7 +192,7 @@ <h2 id="using-fwupdtool">Using fwupdtool<a class="md-anchor" href="#using-fwupdt

<p>Using fwupdtool raw firmware blob (i.e. not the cabinet archive with metadata) can be installed on the device&nbsp;using:</p>
<div class="codehilite"><pre><span></span><code>fwupdtool<span class="w"> </span>--verbose<span class="w"> </span>--plugins<span class="w"> </span>vli<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>install-blob<span class="w"> </span>/home/emily/the-firmware.bin<span class="w"> </span>73ef80b60058b4f18549921520bfd94eaf18710a
<span class="w"> </span>install-blob<span class="w"> </span>/home/u/the-firmware.bin<span class="w"> </span>73ef80b60058b4f18549921520bfd94eaf18710a
</code></pre></div>

<h2 id="firmware-parsing">Firmware Parsing<a class="md-anchor" href="#firmware-parsing" title="Permanent link"></a></h2>
Expand Down Expand Up @@ -262,20 +261,28 @@ <h2 id="debugging-fwupd">Debugging fwupd<a class="md-anchor" href="#debugging-fw


<li class="toc-list-item"><a href="#prerequisites"><span class="link-text">Prerequisites</span></a></li>


<li class="toc-list-item"><a href="#setup-fwupd-development-environment"><span class="link-text">Setup fwupd development environment</span></a></li>


<li class="toc-list-item"><a href="#building"><span class="link-text">Building</span></a></li>


<li class="toc-list-item"><a href="#running-binaries"><span class="link-text">Running binaries</span></a></li>


<li class="toc-list-item"><a href="#using-fwupdtool"><span class="link-text">Using fwupdtool</span></a></li>


<li class="toc-list-item"><a href="#firmware-parsing"><span class="link-text">Firmware Parsing</span></a></li>


<li class="toc-list-item"><a href="#using-fwupdmgr"><span class="link-text">Using fwupdmgr</span></a></li>


<li class="toc-list-item"><a href="#debugging-fwupd"><span class="link-text">Debugging fwupd</span></a></li>



</ul>
Expand Down

0 comments on commit ef350b1

Please sign in to comment.