From 6b67fc0e53e223a24e475d875baa883d327f7c27 Mon Sep 17 00:00:00 2001 From: Kivi Kaitaniemi Date: Thu, 18 Dec 2025 06:20:58 +0200 Subject: [PATCH] Add migration steps --- docs/README.md | 2 +- docs/migrate-to-v1.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index e64fd46..392fe52 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Decman documentation -This contains the documentation for decman. Each plugin has its own documentation. For a quick overview of decman, see the [README](/README.md). +This contains the documentation for decman. Each plugin has its own documentation. For a quick overview of decman, see the [README](/README.md). For a tutorial, see the [example](/example/README.md). - [pacman](/docs/pacman.md) - [systemd](/docs/systemd.md) diff --git a/docs/migrate-to-v1.md b/docs/migrate-to-v1.md index 229d3d2..7498653 100644 --- a/docs/migrate-to-v1.md +++ b/docs/migrate-to-v1.md @@ -15,6 +15,15 @@ This change is mostly architectural and doesn't change decman's behavior, but th Since there are changes in the internal logic, it is possible that there are more breaking changes, but I haven't thought about them yet. +## After upgrading decman + +After upgrading decman, the store and cache must be deleted. This will cause some `on_enable` -hooks to run again, but the store has had many internal changes, and should be recreated. + +```sh +sudo rm /var/lib/decman/store.json +sudo rm -r /var/cache/decman/ +``` + ## Changes One notable change is replacing lists with sets. Sets make more sense for most things decman manages since duplicates and order are meaningless. With Python you'll want to use `|=` when adding two sets together instead of `+=` which is for lists.