Refactor flakes using follows

[perso/Immae/Config/Nix.git] / DOCUMENTATION.md

diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 50eeca43fbb8e2740d58cf6cb48d3f5d1144f24c..6c68680bf891a1eaab93b482da3715fa59b7cf0f 100644 (file)
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -255,3 +255,21 @@ Nextcloud
   ```
 - Issues :
   https://docs.nextcloud.com/server/16/admin_manual/maintenance/manual_upgrade.html
+
+Flakes
+------
+
+Due to a bug in nix build, flakes that refer to relative path (input
+type "path") don't work when called via an url (nix build git+ssh://some-url).
+Relative paths (except in "flakes/private") should be renamed to
+git+https urls ideally. E.g.:
+```
+    inputs.libspf2 = {
+-    path = "../libspf2";
+-    type = "path";
++    url = "https://git.immae.eu/perso/Immae/Config/Nix.git";
++    type = "git";
++    dir = "flakes/libspf2";
+    };
+```
+