Skip to content

Commit c9af3e2

Browse files
committed
kb/fwupd.md: typos, wording, consistent formatting, improvements
Various small corrections after reading the page top to bottom. The most substantial changes are in two "QubesOS" tabs. Signed-off-by: Sergii Dmytruk <sergii.dmytruk@3mdeb.com>
1 parent 072f56a commit c9af3e2

File tree

1 file changed

+33
-35
lines changed

1 file changed

+33
-35
lines changed

docs/kb/fwupd.md

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The `fwupd` daemon relies on the Linux Vendor Firmware Service (LVFS)
1111
for distributing and managing the firmware binaries to the users.
1212

1313
!!! note
14-
`fwupd` depends on
14+
The use of `fwupd` for firmware updates depends on
1515
[Capsule Updates](../guides/capsule-update.md)
1616
support. Check that your device and its firmware are listed in the
1717
["Supported devices" section](../guides/capsule-update.md#supported-devices)
@@ -21,17 +21,17 @@ for distributing and managing the firmware binaries to the users.
2121

2222
### Intel ME
2323

24-
This only applies to devices with an Intel Management Engine that are not fused
24+
This only applies to devices with the Intel Management Engine that are not fused
2525
using the [Dasharo Trust Root](../glossary.md#dasharo-trustroot) technology and
2626
don't yet use Capsules V2.
2727

2828
Intel Management Engine needs to be disabled manually to successfully perform an
2929
fwupd update. Failing to do so won't do any harm to the system, but the update
3030
will be rejected.
3131

32-
Intel ME needs to be switched to the `Disabled (HAP)` state using the Setup Menu
33-
to perform the update. It cannot be done automatically by fwupd. Afterwards,
34-
Intel ME needs to be manually turned back on if desired.
32+
Intel ME needs to be switched to the `Disabled (HAP)` state in the Setup Menu
33+
to perform the update. This step cannot be done automatically by fwupd.
34+
Afterwards, Intel ME needs to be manually turned back on if desired.
3535

3636
Check [Intel Management Engine Options](../dasharo-menu-docs/dasharo-system-features.md#intel-management-engine-options)
3737
documentation for details on how to set ME mode to `Disabled (HAP)`.
@@ -42,7 +42,7 @@ for more context.
4242
### Charger connected
4343

4444
On battery-powered devices (laptops), the AC charger must be connected
45-
before running fwupdmgr to start the update. It must be connected
45+
before running `fwupdmgr` to start the update. It must be connected
4646
for the whole duration of the update, until the device boots back up normally.
4747

4848
## Usage
@@ -63,21 +63,21 @@ are met.
6363
### CLI
6464

6565
For more advanced users or in a more lightweight
66-
DEs/WMs `fwupdmgr` can be used in the terminal.
66+
DEs/WMs `fwupdmgr` command can be used in the terminal.
6767

6868
#### Installation
6969

7070
Most Operating Systems come with fwupd preinstalled and use
7171
it to perform firmware updates.
7272

7373
=== "Windows"
74-
Dasharo Capsule Updates using fwupdmgr are not currently supported on
74+
Dasharo Capsule Updates using `fwupdmgr` are not currently supported on
7575
Windows. If that is the only Operating System you wish to use, other update
7676
methods need to be considered.
7777

7878
=== "Ubuntu"
79-
Check if fwupdmgr is installed. Executing the command should
80-
print the versions of all fwupdmgr components:
79+
Check if `fwupdmgr` is installed. Executing the command should
80+
print the versions of all `fwupdmgr` components:
8181

8282
```bash
8383
$ fwupdmgr --version
@@ -108,8 +108,8 @@ it to perform firmware updates.
108108
```
109109

110110
=== "Fedora"
111-
Check if fwupdmgr is installed. Executing the command should
112-
print the versions of all fwupdmgr components:
111+
Check if `fwupdmgr` is installed. Executing the command should
112+
print the versions of all `fwupdmgr` components:
113113

114114
```bash
115115
$ fwupdmgr --version
@@ -139,12 +139,12 @@ it to perform firmware updates.
139139

140140
=== "QubesOS"
141141

142-
To use fwupdmgr on QubesOS, the program needs to be run on
142+
To use `fwupdmgr` on QubesOS, the program needs to be run on
143143
the `dom0` qube, and it requires an internet connection.
144-
For that reason, a fwupdmgr wrapper for QubesOS exists,
144+
For that reason, a `fwupdmgr` wrapper for QubesOS exists,
145145
that sets up the network tunnels for the firmware update
146-
downloads to be possible from dom0.
147-
The qubes-fwupdmgr package should be installed out of the box.
146+
downloads to be possible from `dom0`.
147+
The `qubes-fwupdmgr` package should be installed out of the box.
148148
Executing the command should print the help screen:
149149

150150
```bash
@@ -212,7 +212,7 @@ it to perform firmware updates.
212212
</details>
213213

214214
=== "QubesOS"
215-
To check for available updates for your device, run the following command
215+
To check the currently used firmware version, run the following command
216216

217217
```bash
218218
$ sudo qubes-fwupdmgr get-devices
@@ -246,7 +246,7 @@ it to perform firmware updates.
246246
UpdateState 2
247247
```
248248
As of QubesOS R4.2.3, the firmware version is not interpreted correctly
249-
by fwupdmgr.
249+
by `fwupdmgr`.
250250
As a fallback on Dasharo firmware, use `dmidecode` to verify the firmware version.
251251
Run:
252252
```bash
@@ -330,7 +330,7 @@ it to perform firmware updates.
330330
```
331331

332332
!!! warning
333-
As of QubesOS R4.3 on 02-2026, qubes-fwupdmgr might not work correctly
333+
As of QubesOS R4.3 on 02-2026, `qubes-fwupdmgr` might not work correctly
334334
and the updates on LVFS may not be found using this tool. Refer to
335335
[troubleshooting](#no-updates-available-qubesos).
336336

@@ -398,18 +398,18 @@ are met.
398398
```
399399

400400
!!! warning
401-
As of QubesOS R4.3 on 02-2026, qubes-fwupdmgr might not work correctly
401+
As of QubesOS R4.3 on 02-2026, `qubes-fwupdmgr` might not work correctly
402402
and the updates on LVFS may not be found using this tool. Refer to
403403
[troubleshooting](#no-updates-available-qubesos).
404404

405405
!!! warning
406-
After the command finishes, fwupd will instruct the device to reboot.
406+
After the command finishes, a reboot is necessary to apply the update.
407407
The fwupd UEFI application that performs the update will be booted
408-
automatically after a reboot, unless there's user interaction
408+
automatically after a reboot, unless there is a user interaction.
409409
Entering the Setup Menu, Boot Manager, or interfering in any other way will
410410
abort the update.
411411
Allow the device to reboot freely, and do not press any buttons until the
412-
update finishes.
412+
update finishes unless there is a dialog related to the update.
413413

414414
Devices that have an Embedded Controller
415415
[might stay powered off after the update][dts-ec-update] and need to be
@@ -442,7 +442,7 @@ source. We will use `novacustom_v54x_mtl_igpu_v1.0.1_btg_prod.cab` downloaded fr
442442

443443
##### No output from fwupdmgr update
444444

445-
Depending on the version of fwupdmgr, issues like the AC being disconnected on
445+
Depending on the version of `fwupdmgr`, issues like the AC being disconnected on
446446
battery-powered devices might not be printed explicitly right away after
447447
trying to perform an update. In such a case, try running the `get-devices` command
448448
and look for the `Problems` header and red text under device entries.
@@ -538,12 +538,12 @@ The check for an AC charger being connected in Linux fails when the firmware
538538
configures a [charging threshold](http://127.0.0.1:8000/unified/novacustom/features/#charge-thresholds)
539539
for the battery that disconnects the charger once the battery reaches the threshold.
540540
If the battery is considered full and not charging at the moment, the check in
541-
fwupdmgr will think the charger is disconnected.
541+
`fwupdmgr` will think the charger is disconnected.
542542

543543
There are two options to work around this issue:
544544

545545
- Deplete battery charge a couple of percent, so that it
546-
doesn't stop charging for the duration of fwupdmgr running the checks.
546+
doesn't stop charging for the duration of `fwupdmgr` running the checks.
547547
- Disable battery charging thresholds in the firmware.
548548

549549
##### No updates available (QubesOS)
@@ -602,16 +602,14 @@ manually from fwupd.org.
602602
</details>
603603

604604
This output means the firmware version has changed to the expected one.
605-
To manually verify this has really happened, refer to
606-
[Checking The Current Firmware Version](#checking-the-current-firmware-version).
607605

608606
=== "QubesOS"
609-
To update your firmware, run the following commands:
607+
`qubes-fwupdmgr` doesn't currently support `get-results` command of
608+
`fwupdmgr`.
610609

611-
```bash
612-
$ sudo qubes-fwupdmgr refresh
613-
$ sudo qubes-fwupdmgr update
614-
```
610+
611+
For another way to verify an update has really happened refer to
612+
[Checking The Current Firmware Version](#checking-the-current-firmware-version).
615613

616614
#### Update result troubleshooting
617615

@@ -651,14 +649,14 @@ Device Flags: • Internal device
651649
```
652650
</details>
653651

654-
When that happens after rebooting, instead of am update
652+
When that happens after rebooting, instead of an update
655653
progress bar, a message like this will appear on top of the screen:
656654

657655
```txt
658656
[FIRMWARE WARNING] Capsule Updates are only supported while Intel ME is in HAP mode!
659657
```
660658

661-
Make sure the Intel ME mode in the Setup menu is `Disabled (HAP)`. Refer to the
659+
Make sure the Intel ME mode in the Setup Menu is `Disabled (HAP)`. Refer to the
662660
[prerequisites section](#firmware-update-prerequisites) and try again.
663661

664662
## References

0 commit comments

Comments
 (0)