From e30e6978b61abed7f6f665eff55dc74835c9de85 Mon Sep 17 00:00:00 2001 From: Phil Elwell <8911409+pelwell@users.noreply.github.com> Date: Tue, 16 Dec 2025 11:51:24 +0000 Subject: [PATCH] Add Caveats section to README.md Add a list of caveats to the README, with the intention of linking to it from any suggestion to run rpi-update. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 76bd9ff..ce13f76 100644 --- a/README.md +++ b/README.md @@ -182,6 +182,12 @@ To reboot after successfully update, run: You can use it to automate updates. +## Caveats + +1. Only use `rpi-update` if you are happy to lose the data on your filesystem. Catastrophic failures are extremely rare, but still possible. +2. Back up important data before updating (or take responsibility for not doing so). +3. Updating an image that requires initramfs in order to boot is not supported. If your system relies on drivers provided by the initramfs (e.g. custom filesystem options or USB network drivers), it is likely to not boot without regenerating the initramfs - a step that `rpi-update` _will not do_. If you are unsure, test if your system boots with the initramfs options (`auto_initramfs`, `initramfs`, `ramfsfile`) commented out in `config.txt`. + ## Troubleshooting There are two possible problems related to SSL certificates that may prevent