From 98f9b5d7cedfd6a538fd6d5f41d55e474e9e9581 Mon Sep 17 00:00:00 2001 From: Gabriele Modena Date: Wed, 3 Jan 2024 21:30:38 +0100 Subject: [PATCH 1/2] README: inform of hm import bug. Add a known issues section. Inform of infinite recursion import bug reported in #25. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index a7952eb..906e2e5 100644 --- a/README.md +++ b/README.md @@ -127,3 +127,16 @@ YMMV. If you need generational builds, [declarative-flatpak](https://github.com/GermanBread/declarative-flatpak) might be a better fit. + +# Known issues + +A couple of things to be aware of when working with `nix-flatpak`. + +## Infinte recusion in home-manager imports + +Users have reported an infinite recursion stacktrace when an home-manager module outside of where home-manager +itself was imported. + +To work around this issue, you should avoid nesting home-manager modules. This means that when you are structuring your configuration, make sure that you do not have home-manager modules imported within each other in a way that could lead to infinite recursion. + +You can follow the discussions and updates on issue [#25](https://github.com/gmodena/nix-flatpak/issues/25) to stay informed about any resolutions or workarounds. From 4e89ffe5aad3794830a5e49753709cb0d06d0f4c Mon Sep 17 00:00:00 2001 From: Gabriele Modena Date: Wed, 3 Jan 2024 21:35:02 +0100 Subject: [PATCH 2/2] README: fix wording --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 906e2e5..472765e 100644 --- a/README.md +++ b/README.md @@ -134,9 +134,9 @@ A couple of things to be aware of when working with `nix-flatpak`. ## Infinte recusion in home-manager imports -Users have reported an infinite recursion stacktrace when an home-manager module outside of where home-manager +Users have reported an infinite recursion stacktrace when importing an home-manager module outside of where home-manager itself was imported. -To work around this issue, you should avoid nesting home-manager modules. This means that when you are structuring your configuration, make sure that you do not have home-manager modules imported within each other in a way that could lead to infinite recursion. +To work around this issue, you should avoid nesting home-manager modules. This means that when you are structuring your configuration, make sure that you do not have home-manager modules imported within each other in a way that could lead to circular imports. You can follow the discussions and updates on issue [#25](https://github.com/gmodena/nix-flatpak/issues/25) to stay informed about any resolutions or workarounds.