fabianhjr/nixos-module
0
0
Fork 0
forked from lix-project/nixos-module
Code Pull requests Activity
Catfooding NixOS module
110 commits 10 branches 3 tags 286 KiB
Nix 70.4%
Python 29.6%
Find a file
jade b0e6f35950 overlay: clean up 2.18 stuff 
Since Nix 2.24 is now the default in nixpkgs, we should remove the stuff
that assumes it's 2.18. Nothing breaks with this change, unless someone
is specifically depending on nixVersions.nix_2_18 being Lix.
2024-09-17 20:47:29 -07:00
nix-doc nix-doc: disable plugin since it is broken by Lix API changes 2024-03-16 16:30:31 -07:00
.gitignore Add gitignore 2024-03-25 13:57:03 +11:00
flake.lock overlay: clean up 2.18 stuff 2024-09-17 20:47:29 -07:00
flake.nix fix: use the official-release bit from the Lix sources to skip versionSuffix 2024-08-12 18:01:18 -07:00
LICENSE Add LICENSE 2024-04-02 13:21:56 -07:00
module.nix Add lixFromNixpkgs, document the module 2024-07-30 15:13:25 -07:00
overlay.nix overlay: clean up 2.18 stuff 2024-09-17 20:47:29 -07:00
pins.json update nix-eval-jobs for 2.91-dev 2024-06-26 00:18:57 +02:00
pins.nix Show revision of n-e-j better 2024-05-27 13:03:12 -06:00
README.md Clarify readme wording a little 2024-07-31 14:14:21 -07:00
system-profile.nix Update lix and add system profile 2024-03-24 17:17:53 -07:00
test-nixos.nix Warn on mismatched Lix module version 2024-07-30 15:13:24 -07:00
update_pins.py Return Lix module to main, with fixes from release-2.90 work 2024-06-18 23:32:31 -07:00
version.json Update version to 2.92 2024-08-12 18:11:20 -07:00

README.md

Lix NixOS module

See the official installation guide for details on usage of release versions.

See the beta guide for a setup guide on how to use HEAD:

What does this do?

This is an overlay wrapped in a NixOS module that will replace CppNix with Lix in nixpkgs. This is useful so that nixos-rebuild, nix-direnv and similar will use Lix.

Optionally, it can build Lix from source.

Versioning with Lix

The version of this overlay should match the major Lix version, and if running HEAD, it should be the latest available version of the overlay. Changes breaking the overlay are shamelessly done on HEAD, and we expect people doing such changes to have prepared corresponding fix commits to make to the overlay immediately after submitting their changes. If your build randomly broke when updating HEAD, try updating your overlay.

The version of Lix pinned in this flake's flake.lock is a version of Lix that is expected to work, however if running HEAD, it can be assumed to work with HEAD as well if both lix-nixos-module and lix are the latest version.

Common pitfalls

Various flake frameworks such as flake-parts and snowfall (and possibly Colmena in the future if they do a similar optimization) manage overlays separately from NixOS, since they provide pkgs pre-imported to NixOS. This saves a couple of seconds of evaluation time and resources, but it means that the NixOS option nixpkgs.overlays is completely ignored on these frameworks.

If you are using such a framework, add overlays.default to the overlays list for said framework.

Flake structure and usage

The flake here has two inputs of note:

  • nixpkgs, which is unused for most people. It is purely used for checks in developing lix-nixos-module itself.

    The installation instructions make it follows to make flake.lock less confusing, but it is nonetheless unused.

  • lix, which determines the version of Lix to do source builds for, if doing source builds.

These are the most relevant outputs for most people:

  • nixosModules.lixFromNixpkgs - uses Lix from nixpkgs and installs the overlay to use Lix on a NixOS system. This is only useful for a stable version of Lix, and cannot be used for running HEAD.
  • nixosModules.default - uses Lix from source and installs the overlay to use Lix on a NixOS system.
  • overlays.lixFromNixpkgs - overlay to use Lix from nixpkgs in place of Nix.
  • overlays.default - overlay to use Lix from source in place of Nix.

Non-flake usage

Import module.nix or overlay.nix as desired, with the arguments lix (derivation-like attribute set with the Lix sources, or null to use Lix from nixpkgs) and versionSuffix (optional string).

It's desirable to also include a versionSuffix like the following while building HEAD from source, to have nix --version include date and commit information. To get such metadata, it depends on which pinning system is in use, but builtins.fetchGit will provide the necessary metadata for the following to work:

versionSuffix = "pre${builtins.substring 0 8 lix.lastModifiedDate}-${lix.shortRev or lix.dirtyShortRev}";