aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRebecca Turner <rbt@sent.as>2024-09-08 18:37:28 -0700
committerRebecca Turner <rbt@sent.as>2024-09-16 10:48:20 -0700
commit7ae0409989187d44044c4cd6f274f0a02ec5f826 (patch)
treea8c0d1e6f64687204776118c90a0dfa713b710bd /doc
parente9505dcc5a0ff259b9e284e9e617486e81a1ff6f (diff)
Remove readline support
Lix cannot be built with GNU readline, and we would "rather not" be GPL. Change-Id: I0e86f0f10dab966ab1d1d467fb61fd2de50c00de
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/rl-next/readline-support-removed.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/manual/rl-next/readline-support-removed.md b/doc/manual/rl-next/readline-support-removed.md
new file mode 100644
index 000000000..6e4faeb67
--- /dev/null
+++ b/doc/manual/rl-next/readline-support-removed.md
@@ -0,0 +1,17 @@
+---
+synopsis: readline support removed
+cls: [1885]
+category: Packaging
+credits: [9999years]
+---
+
+Support for building Lix with [`readline`][readline] instead of
+[`editline`][editline] has been removed. `readline` support hasn't worked for a
+long time (attempting to use it would lead to build errors) and would make Lix
+subject to the GPL if it did work. In the future, we're hoping to replace
+`editline` with [`rustyline`][rustyline] for improved ergonomics in the `nix
+repl`.
+
+[readline]: https://en.wikipedia.org/wiki/GNU_Readline
+[editline]: https://github.com/troglobit/editline
+[rustyline]: https://github.com/kkawakam/rustyline