proxmox-mirrors/fwupd
1
0
Fork 0
mirror of https://git.proxmox.com/git/fwupd synced 2025-08-15 22:55:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add missing documentation from the plugin interface

Browse Source 
Also update the structure as the documentation doesn't only describe
libfwupd.
This commit is contained in:
Mario Limonciello 2019-11-25 19:54:31 -06:00 committed by Richard Hughes
parent 4a7bb8d98a
commit f1a4d87063
7 changed files with 31 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
contrib/ci/ubuntu.sh
View File

@ -15,7 +15,7 @@ ninja -C build test -v
#make docs available outside of docker
ninja -C build install -v
mkdir -p dist/docs
cp build/docs/libfwupd/* dist/docs -R
cp build/docs/* dist/docs -R
#run static analysis (these mostly won't be critical)
ninja -C build scan-build -v

2
contrib/fwupd.spec.in
View File

@ -370,7 +370,7 @@ rm ${RPM_BUILD_ROOT}%{_sbindir}/flashrom
%files devel
%{_datadir}/gir-1.0/Fwupd-2.0.gir
%{_datadir}/gtk-doc/html/libfwupd
%{_datadir}/gtk-doc/html/fwupd
%{_datadir}/vala/vapi
%{_includedir}/fwupd-1
%{_libdir}/libfwupd*.so

18
docs/libfwupd/libfwupd-docs.xml → docs/fwupd-docs.xml
View File

@ -41,13 +41,31 @@
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-firmware-common.xml"/>
<xi:include href="xml/fu-firmware-image.xml"/>
<xi:include href="xml/fu-firmware.xml"/>
<xi:include href="xml/fu-history.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-progressbar.xml"/>
<xi:include href="xml/fu-quirks.xml"/>
<xi:include href="xml/fu-smbios.xml"/>
<xi:include href="xml/fu-test.xml"/>
<xi:include href="xml/fu-udev-device.xml"/>
<xi:include href="xml/fu-usb-device.xml"/>
</reference>

5
docs/libfwupd/clean.sh
View File

@ -1,5 +0,0 @@
rm -f *.txt
rm -rf html/
rm -rf xml/
rm -rf tmpl/
rm -f *.stamp

6
docs/libfwupd/libfwupd.types
View File

@ -1,6 +0,0 @@
fwupd_client_get_type
fwupd_device_get_type
fwupd_quirks_get_type
fwupd_release_get_type
fwupd_remote_get_type
fwupd_result_get_type

11
docs/libfwupd/meson.build
View File

@ -1,11 +0,0 @@
gnome.gtkdoc(
'libfwupd',
src_dir : [
join_paths(meson.source_root(), 'libfwupd'),
join_paths(meson.source_root(), 'src'),
join_paths(meson.build_root(), 'libfwupd'),
join_paths(meson.build_root(), 'src'),
],
main_xml : 'libfwupd-docs.xml',
install : true
)

12
docs/meson.build
View File

@ -1 +1,11 @@
subdir('libfwupd')
gnome.gtkdoc(
'fwupd',
src_dir : [
join_paths(meson.source_root(), 'libfwupd'),
join_paths(meson.source_root(), 'src'),
join_paths(meson.build_root(), 'libfwupd'),
join_paths(meson.build_root(), 'src'),
],
main_xml : 'fwupd-docs.xml',
install : true
)