lix-project/lix
20
57
Fork 31
Code Issues 347 Code Review (Gerrit) Projects 3 Releases Wiki Activity

Merge "doc/hacking: fix up some outdated info about cross, hydra links" into main

Browse source
This commit is contained in:
jade 2024-06-26 22:11:36 +00:00 committed by Gerrit Code Review
parent 3dd7d023f4 85c1241201
commit 77c5364596
2 changed files with 27 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
doc/manual/src/contributing/hacking.md
View file

@ -168,8 +168,26 @@ or for Nix with the [`flakes`] and [`nix-command`] experimental features enabled
$ nix build .#packages.aarch64-linux.default $ nix build .#packages.aarch64-linux.default
``` ```
Cross-compiled builds are available for ARMv6 (`armv6l-linux`) and ARMv7 (`armv7l-linux`). ### Cross compiling using the Lix flake
Add more [system types](#system-type) to `crossSystems` in `flake.nix` to bootstrap Nix on unsupported platforms.
Lix can also be easily cross compiled to the following arbitrarily-chosen system doubles, which can be useful for bootstrapping Lix on new platforms.
These are specified in `crossSystems` in `flake.nix`; feel free to submit changes to add new ones if they are useful to you.
- `armv6l-linux`
- `armv7l-linux`
- `riscv64-linux`
For example, to cross-compile Lix for `armv6l-linux` from another Linux, use the following:
```console
$ nix build .#nix-armv6l-linux
```
It's also possible to cross-compile a tarball of binaries suitable for the Lix installer, for example, for `riscv64-linux`:
```console
$ nix build .#nix-riscv64-linux.passthru.binaryTarball
```
### Building for multiple platforms at once ### Building for multiple platforms at once
@ -282,7 +300,7 @@ Regular markdown files used for the manual have a base path of their own and the
## API documentation ## API documentation
Doxygen API documentation will be available online [in the future](https://git.lix.systems/lix-project/lix/issues/422). Doxygen API documentation will be available online in the future ([tracking issue](https://git.lix.systems/lix-project/lix/issues/422)).
You can also build and view it yourself: You can also build and view it yourself:
```console ```console
@ -300,23 +318,22 @@ $ xdg-open ./outputs/doc/share/doc/nix/internal-api/html/index.html
## Coverage analysis ## Coverage analysis
A coverage analysis report is [available A coverage analysis report will be available online in the future (FIXME(lix-hydra)).
online](https://hydra.nixos.org/job/nix/master/coverage/latest/download-by-type/report/coverage). You You can build it yourself:
can build it yourself:
``` ```
# nix build .#hydraJobs.coverage # nix build .#hydraJobs.coverage
# xdg-open ./result/coverage/index.html # xdg-open ./result/coverage/index.html
``` ```
Metrics about the change in line/function coverage over time are also Metrics about the change in line/function coverage over time will be available in the future (FIXME(lix-hydra)).
[available](https://hydra.nixos.org/job/nix/master/coverage#tabs-charts).
## Add a release note ## Add a release note
`doc/manual/rl-next` contains release notes entries for all unreleased changes. `doc/manual/rl-next` contains release notes entries for all unreleased changes.
User-visible changes should come with a release note. User-visible changes should come with a release note.
Developer-facing changes should have a release note in the Development category if they are significant and if developers should know about them.
### Add an entry ### Add an entry

2
flake.nix
View file

@ -84,6 +84,8 @@
]; ];
systems = linuxSystems ++ darwinSystems; systems = linuxSystems ++ darwinSystems;
# If you add something here, please update the list in doc/manual/src/contributing/hacking.md.
# Thanks~
crossSystems = [ crossSystems = [
"armv6l-linux" "armv6l-linux"
"armv7l-linux" "armv7l-linux"