From cd68c073ed1beb2a7378f965f7732c1d3ef81ffb Mon Sep 17 00:00:00 2001 From: Marien Zwart Date: Thu, 25 Apr 2024 22:49:42 +1000 Subject: [PATCH] Add some more documentation --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 53f91de..8af3a0d 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,12 @@ TODO Emacs >=29. It probably still has some problems already solved by `nix-doom-emacs`, and it is too soon to tell how robust it is. -## Known problems +## Bugs + +*Do not report bugs upstream*. If you think it's a bug in Doom, reproduce it +without Unstraightened first, or report it here first. + +There are a few known current bugs and likely future bugs in Unstraightened: ### Pins can break @@ -81,6 +86,11 @@ fundamental limitation: Doom assumes its pins are applied to `straight.el` build recipes, while we use nixpkgs / emacs-overlay. If these diverge, our build breaks. +Another possible problem is a package failing to build or run because one of its +dependencies is missing. Unstraightened currently uses dependencies from the +original (emacs-overlay) package. This is largely a performance optimization, +that can be revisited if it breaks too frequently. + ### Saving Custom changes fails Saving changes through Custom will not work, because `custom-file` is read-only.