mirror of
https://git.proxmox.com/git/fwupd
synced 2025-05-10 00:00:11 +00:00
1981c63d58
This allows us to 'nest' firmware formats, and removes a ton of duplication. The aim here is to deprecate FuFirmwareImage -- it's almost always acting as a 'child' FuFirmware instance, and even copies most of the vfuncs to allow custom types. If I'm struggling to work out what should be a FuFirmware and what should be a FuFirmwareImage then a plugin author has no hope. For simple payloads we were adding bytes into an image and then the image into a firmware. This gets really messy when most plugins are treating the FuFirmware *as* the binary firmware file. The GBytes saved in the FuFirmware would be considered the payload with the aim of not using FuFirmwareImage in the single-image case.
89 lines
2.9 KiB
XML
89 lines
2.9 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
|
|
[
|
|
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
|
|
]>
|
|
<book id="index">
|
|
<bookinfo>
|
|
<title>fwupd Reference Manual</title>
|
|
</bookinfo>
|
|
|
|
<reference id="intro">
|
|
<title>About fwupd</title>
|
|
<partintro>
|
|
<para>
|
|
fwupd is a daemon for updating firmware.
|
|
</para>
|
|
</partintro>
|
|
</reference>
|
|
|
|
<reference id="libfwupd">
|
|
<title>libfwupd</title>
|
|
<partintro>
|
|
<para>
|
|
Functionality exported by libfwupd for client applications.
|
|
</para>
|
|
</partintro>
|
|
<xi:include href="xml/fwupd-client.xml"/>
|
|
<xi:include href="xml/fwupd-client-sync.xml"/>
|
|
<xi:include href="xml/fwupd-device.xml"/>
|
|
<xi:include href="xml/fwupd-release.xml"/>
|
|
<xi:include href="xml/fwupd-plugin.xml"/>
|
|
<xi:include href="xml/fwupd-remote.xml"/>
|
|
<xi:include href="xml/fwupd-error.xml"/>
|
|
<xi:include href="xml/fwupd-enums.xml"/>
|
|
<xi:include href="xml/fwupd-version.xml"/>
|
|
</reference>
|
|
|
|
<reference id="plugin-reference">
|
|
<title>Plugin Reference</title>
|
|
<partintro>
|
|
<para>
|
|
Functionality available to plugins.
|
|
</para>
|
|
</partintro>
|
|
<xi:include href="xml/fu-archive.xml"/>
|
|
<xi:include href="xml/fu-chunk.xml"/>
|
|
<xi:include href="xml/fu-common-cab.xml"/>
|
|
<xi:include href="xml/fu-common-guid.xml"/>
|
|
<xi:include href="xml/fu-common-version.xml"/>
|
|
<xi:include href="xml/fu-common.xml"/>
|
|
<xi:include href="xml/fu-device-locker.xml"/>
|
|
<xi:include href="xml/fu-device-metadata.xml"/>
|
|
<xi:include href="xml/fu-device.xml"/>
|
|
<xi:include href="xml/fu-dfu-firmware.xml"/>
|
|
<xi:include href="xml/fu-efi-signature.xml"/>
|
|
<xi:include href="xml/fu-efi-signature-list.xml"/>
|
|
<xi:include href="xml/fu-firmware-common.xml"/>
|
|
<xi:include href="xml/fu-firmware.xml"/>
|
|
<xi:include href="xml/fu-hwids.xml"/>
|
|
<xi:include href="xml/fu-ihex-firmware.xml"/>
|
|
<xi:include href="xml/fu-srec-firmware.xml"/>
|
|
<xi:include href="xml/fu-io-channel.xml"/>
|
|
<xi:include href="xml/fu-mutex.xml"/>
|
|
<xi:include href="xml/fu-plugin-vfuncs.xml"/>
|
|
<xi:include href="xml/fu-plugin.xml"/>
|
|
<xi:include href="xml/fu-quirks.xml"/>
|
|
<xi:include href="xml/fu-smbios.xml"/>
|
|
<xi:include href="xml/fu-udev-device.xml"/>
|
|
<xi:include href="xml/fu-usb-device.xml"/>
|
|
</reference>
|
|
|
|
<xi:include href="tutorial.xml"/>
|
|
<!--
|
|
<xi:include href="hsi.xml"/>
|
|
-->
|
|
|
|
<index id="api-index-full">
|
|
<title>API Index</title>
|
|
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
|
|
<index id="deprecated-api-index" role="deprecated">
|
|
<title>Index of deprecated API</title>
|
|
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
|
|
</index>
|
|
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
|
|
</book>
|