logistic-bot/nix-doom-emacs-unstraightened
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add some more documentation

Browse source
This commit is contained in:
Marien Zwart 2024-04-25 22:49:42 +10:00
parent 300ccb8da3
commit cd68c073ed
No known key found for this signature in database
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -63,7 +63,12 @@ TODO
Emacs >=29. It probably still has some problems already solved by 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. `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 ### 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 recipes, while we use nixpkgs / emacs-overlay. If these diverge, our build
breaks. 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 Custom changes fails
Saving changes through Custom will not work, because `custom-file` is read-only. Saving changes through Custom will not work, because `custom-file` is read-only.