movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-12 04:35:41 +03:00
Code Issues Projects Releases Packages Wiki Activity

doc/lisp: document arguments of buildASDFSystem

Browse source
This commit is contained in:
Kasper Gałkowski 2023-08-25 21:43:09 +02:00
parent 9ce6e34ddf
commit 827b70a9b4
1 changed files with 19 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

26
doc/languages-frameworks/lisp.section.md
View file

@ -16,10 +16,10 @@ The `pkgs` attribute set contains packages that were automatically
other [manually defined](#lisp-defining-packages-inside) ones. Not every package other [manually defined](#lisp-defining-packages-inside) ones. Not every package
works for all the CL implementations (e.g. `nyxt` only makes sense for `sbcl`). works for all the CL implementations (e.g. `nyxt` only makes sense for `sbcl`).
The `withPackages` function is of primary utility. It is used to build The `withPackages` function is of primary utility. It is used to build
[runnable wrappers](#lisp-building-wrappers), with a pinned and pre-built [runnable wrappers](#lisp-building-wrappers), with a pinned and pre-built
[ASDF FASL](#lisp-loading-asdf) available in the `ASDF` environment variable, [ASDF FASL](#lisp-loading-asdf) available in the `ASDF` environment variable,
and `CL_SOURCE_REGISTRY`/`ASDF_OUTPUT_TRANSLATIONS` configured to and `CL_SOURCE_REGISTRY`/`ASDF_OUTPUT_TRANSLATIONS` configured to
[find the desired systems on runtime](#lisp-loading-systems). [find the desired systems on runtime](#lisp-loading-systems).
In addition, Lisps have the `withOverrides` function, which can be used to In addition, Lisps have the `withOverrides` function, which can be used to
@ -144,8 +144,9 @@ In that file, use the `build-asdf-system` function, which is a wrapper around
as `build-with-compile-into-pwd` for systems which create files during as `build-with-compile-into-pwd` for systems which create files during
compilation (such as cl-unicode). compilation (such as cl-unicode).
The `build-asdf-system` function is documented with comments in The `build-asdf-system` function is documented
`nix-cl.nix`. Also, `packages.nix` is full of examples of how to use it. [here](#lisp-defining-packages-outside). Also, `packages.nix` is full of
examples of how to use it.
## Defining packages manually outside Nixpkgs {#lisp-defining-packages-outside} ## Defining packages manually outside Nixpkgs {#lisp-defining-packages-outside}
@ -153,8 +154,19 @@ Lisp derivations (`abcl`, `sbcl` etc.) also export the `buildASDFSystem`
function, which is similar to `build-asdf-system` from `packages.nix`, but is function, which is similar to `build-asdf-system` from `packages.nix`, but is
part of the public API. part of the public API.
It takes the following arguments:
- `pname`: the package name
- `version`: the package version
- `src`: the package source
- `patches`: patches to apply to the source before build
- `nativeLibs`: native libraries used by CFFI and grovelling
- `javaLibs`: Java libraries for ABCL
- `lispLibs`: dependencies on other packages build with `buildASDFSystem`
- `systems`: list of systems to build
It can be used to define packages outside Nixpkgs, and, for example, add them It can be used to define packages outside Nixpkgs, and, for example, add them
into the package scope with `withOverrides` which will be discussed later. into the package scope with `withOverrides`.
### Including an external package in scope {#lisp-including-external-pkg-in-scope} ### Including an external package in scope {#lisp-including-external-pkg-in-scope}