proxmox-mirrors/fwupd
1
0
Fork 0
mirror of https://git.proxmox.com/git/fwupd synced 2025-06-02 08:20:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
8,330 Commits 1 Branch 0 Tags 24 MiB
ae80ba6d16
Commit Graph

33 Commits

Author SHA1 Message Date
Richard Hughes
058dc2301a Include the plugin README text in the generated docs 2023-01-10 14:58:30 +00:00
Richard Hughes
542014ebe3 Use 'check' when calling run_command() to avoid a warning 
New versions of meson [correctly] warn when this parameter is not specified.
 2022-12-29 15:49:02 +00:00
Richard Hughes
85495b5bb2 Generate OVAL rules 2022-11-24 10:22:27 +00:00
Jan Tojnar
716f41b7b2 build: Do not check markdown version for gi-docgen 2022 
There is no guarantee that Python environment used for the build contains
the same `markdown` version as the one used for running `gi-docgen`.
For example, Nixpkgs uses a self-contained Python environment for the latter,
so `markdown` package is not even available in fwupd build environment.
Fortunately, gi-docgen 2022.2 already checks for `markdown` version
so we can omit our own check for newer gi-docgen versions.
 2022-11-16 12:32:57 -06:00
Richard Hughes
da6928fe76 Do not use globs when building docs 
If we use an explicit file lists then the docs are regenerated when the source
files change.
 2022-11-02 13:54:23 +00:00
Richard Hughes
820e42143d Make the HSI specification machine readable 
This allows us to convert it to other forms, e.g. OPAL.
 2022-10-24 16:24:25 +01:00
Richard Hughes
49af1667bd trivial: Install the devhelp symlinks relative 
We want /usr/share/docs/fwupd/libfwupd for the docs that can be referenced from
index.html, and a symlink of /usr/share/docs/libfwupd for devhelp.

This fixes the rpmbuild warning:

    # absolute symlink: /usr/share/doc/fwupd/libfwupd -> /usr/share/doc/libfwupd
    # absolute symlink: /usr/share/doc/fwupd/libfwupdplugin -> /usr/share/doc/libfwupdplugin
 2022-09-22 16:24:56 +01:00
Richard Hughes
0ea9f4cea3 Install the symlink the other way around 
RPM based distros cannot replace a directory with a symlink without a giant hack.
 2022-08-31 08:26:41 +01:00
Mario Limonciello
e26be40490 trivial: disable security arg when HSI disabled 
There is no point to offering the security argument to the tools if HSI was disabled
at compile time.
 2022-08-30 11:42:58 -05:00
Mario Limonciello
72f19f2a12 trivial: fix documentation deployement 2022-08-29 18:20:46 -05:00
Richard Hughes
34ff01fdf5 trivial: Continue to install the index page to fix the docs deployment 2022-07-11 16:44:12 +01:00
Mario Limonciello
9b30739d76 trivial: change docs to a meson feature (Fixes: #4791) 2022-07-01 10:56:12 +01:00
Gaël PORTAY
299b42fe96 trivial: Make meson.build indentation consistent 2022-06-21 03:27:38 -04:00
Richard Hughes
422d8cfa17 trivial: Fix FreeBSD CI build 2022-06-12 08:42:46 +01:00
Richard Hughes
06a2dcf62b Remove gtkdoc build option 
We've seen that gi-docgen is active and other projects are switching to
it. Remove the legacy (and slow) gtk-doc build support.
 2022-06-11 21:26:46 +01:00
Mario Limonciello
6896e0ab52 trivial: switch from meson.source_root to meson.project_source_root 
The former is deprecated in meson 0.56 or later.
 2022-02-28 08:34:48 -06:00
Richard Hughes
b3b5542246 Redirect the old HSI links to the correct place 
Fixes https://github.com/fwupd/fwupd/issues/3893, harder
 2021-10-27 12:49:27 +01:00
Mario Limonciello
9d113822c9 trivial: create urlmap for each gi-docgen target rather than sharing 2021-09-07 21:54:40 -05:00
Mario Limonciello
f1db89ff35 trivial: set the version string for source code links properly 2021-06-15 07:03:05 -05:00
Mario Limonciello
0d0dfa6da0 trivial: set up links between libfwupd and libfwupdplugin 2021-06-14 09:25:07 +01:00
Richard Hughes
7df6368038 trivial: Add an index page to link to both sets of docs 2021-06-11 14:14:53 +01:00
Mario Limonciello
1e17457b16 Allow building the documentation with gi-docgen and gtk-doc 
Until gi-docgen is declared stable support either of them.
This effectively means that hand builds and CI builds will use
gi-docgen, but distro builds use gtk-doc-tools.
 2021-06-09 22:21:53 +01:00
Richard Hughes
bc84f0d98e Switch some documentation from docbook to markdown 2021-06-04 15:09:44 -05:00
Richard Hughes
fd0ee5153e Add some of the HSI specification to the generated documentation 2020-08-17 20:23:49 +01:00
Richard Hughes
e031774a8b Split out the fwupd tutorial into a new file 
No content changes.
 2020-07-28 09:22:07 +01:00
Mario Limonciello
6b0e66354b Convert libfwupdprivate to a shared library libfwupdplugin 2019-11-27 11:32:43 +00:00
Mario Limonciello
f1a4d87063 Add missing documentation from the plugin interface 
Also update the structure as the documentation doesn't only describe
libfwupd.
 2019-11-26 06:31:57 +00:00
Mario Limonciello
db419f066c trivial: Make gtkdoc-scan a build dependency when docs are on 
Fixes #575
 2018-06-28 08:54:22 -05:00
Richard Hughes
d0cff7caec Remove autoconf-isms from the meson configure options 
See https://wiki.gnome.org/Initiatives/GnomeGoals/MesonPorting
 2017-11-27 18:07:53 +00:00
Richard Hughes
cd0d72abbe trivial: Move the man pages to the source locations 
This should make it easier to keep them in sync.
 2017-10-09 09:59:52 +01:00
Richard Hughes
4022700bc8 Do not install the libdfu helper library 
In reality fwupd is the only user and we don't want to hold this library to the
same kind of API and ABI guarantees of libfwupd.
 2017-09-06 16:21:32 +01:00
Chris Mayo
f358837685 Make documentation and man pages optional 
Reduce the minimum build-time dependencies.
 2017-05-31 20:00:59 +01:00
Richard Hughes
57746cb839 Add the Meson build system as an alternate to autotools 
Automake and autoconf are impossible to fully understand and Meson now provides
everything we need for a much smaller, faster, and more understandable build.

See http://mesonbuild.com/ for more information.
 2017-04-12 16:35:18 +01:00