Commit graph

19 commits

Author SHA1 Message Date
Ben Siraphob cc5b731ed3
doc: fix typos 2025-08-27 11:46:26 -07:00
Wolfgang Walther 62fe016519
treewide: run treefmt with mdcr/nixfmt 2025-07-24 13:52:31 +02:00
Niklas Hambüchen ee6c2bd2eb doc: Fix missing pre/post hooks everywhere 2025-05-24 13:22:41 +00:00
Pol Dellaiera ac04a5c492 doc: replace rev with tag 2025-04-21 07:02:49 +02:00
Pol Dellaiera bcea0cf344 doc: update Nix code snippets format
Command: `mdcr --config doc/tests/mdcr-config.toml doc/`
2025-04-17 01:30:34 +02:00
Janne Heß fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Janne Heß bc77c7a973 treewide: Mark Nix blocks in markdown as Nix
This should help us with highlighting and future formatting.
2024-03-28 09:28:12 +01:00
Anthony Roussel e30f48be94
treewide: fix redirected and broken URLs
Using the script in maintainers/scripts/update-redirected-urls.sh
2023-11-11 10:49:01 +01:00
Arnout Engelen 97b0ae26f7
doc: avoid 'simply' (#266434)
While the word 'simply' is usually added to encourage readers, it often has the
opposite effect and may even appear condescending, especially when the reader
runs into trouble trying to apply the suggestions from the documentation. It is
almost always an improvement to simply drop the word from the sentence.

(there are more possible improvements like this, we can apply those in separate
PRs)
2023-11-09 21:48:05 +01:00
Kasper Gałkowski 827b70a9b4 doc/lisp: document arguments of buildASDFSystem 2023-08-25 22:20:46 +02:00
Kasper Gałkowski 9ce6e34ddf doc/lisp: add links to sections and upstream websites
Also clean up complex paragraphs and fix section on building wrappers
2023-08-25 21:35:34 +02:00
Kasper Gałkowski b991ea8385 doc/lisp: clarify section on importing from Quicklisp
1. Clarify what is the reason for importing and to where it saves
2. Clarify that packages.sqlite is a temporary file
3. Link to section about native dependencies from first mention of ql.nix
2023-08-25 21:00:39 +02:00
Kasper Gałkowski 952781729f doc/lisp: minor changes to manual 2023-08-23 19:01:16 +02:00
Kasper Gałkowski fdabf61974 lisp-modules: manual: add self links 2023-03-21 19:38:26 +01:00
Kasper Gałkowski dae0dca5d1 lisp-modules: second version of wrapLisp
The previous approach of trying to make both the `override` mechanism from
`mkDerivation` and the `overrideScope'` mechanism from `newScope` work together
resulted in hard to understand code, and there was a bug where once overridden
packages would lose the changes on next override with `packageOverrides`.

It's not ideal still, because Lisps created by `mkDerivation` will lose their
`pkgs` after using `override`.
2023-03-11 19:09:25 +01:00
Kasper Gałkowski 84eea85ad9 lisp-modules: use wrapLisp to wrap Lisps
The previous approach of manually repeating a complex pattern inside Common Lisp
implementation package declarations was fragile and hard to change. After
reading python and lua modules code in Nixpkgs, I was able to come up with
something better.

The function `wrapLisp` doesn't need to be inside package declarations so all
the code for wrapping Lisps can be in `all-packages.nix`.

This works by wrapping the `override` function created from `mkDerivation` to
accept a new argument `packageOverrides`.

One problem with this is that `override.__functionArgs` disappears. But one can
look at the source code of a package to discover what can be overridden.
2023-03-11 15:11:38 +01:00
Kasper Gałkowski a0bdaf345b lisp-modules: replace "_" in package names with "__" for reversibility 2023-03-10 20:10:39 +01:00
Kasper Gałkowski 092acca8b3 lisp-modules: make ql-import.lisp automatically pull the latest Quicklisp dist 2023-03-02 19:04:47 +01:00
Kasper Gałkowski 7a1ccaa997 lisp-modules: Add manual section 2023-03-02 19:04:41 +01:00