Commit Graph

11 Commits

Author SHA1 Message Date
Atemu
eb538d1047 nixos/doc: remove section on latestCompatibleLinuxPackages 2024-09-26 15:06:45 +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
Alyssa Ross
7abc6d260b nixos/doc: add missing anchor for Linux Rust
Fixes: ec2016dda4 ("doc: explain how to enable Rust support in the Linux kernel")
2024-01-16 23:17:13 +01:00
Julian Stecklina
ec2016dda4
doc: explain how to enable Rust support in the Linux kernel 2024-01-12 20:29:07 +01:00
DS
1d7ee9ff09 doc: consolidate info on manual linux kernel configs
The Nixpkgs documentation on the linux kernel builders focused on
using and extending kernels that were already packaged, but never
mentioned that it's possible to also build a kernel almost "from
scratch".
The NixOS documentation went a bit deeper on manual linux kernel
configs, but that information wasn't particularly NixOS-specific.

This commit consolidates the information related to building the
kernel on Nixpkgs's documentation, while keeping any additional
NixOS-specific information on NixOS's documentation.

An additional README.md was created for contributor-facing
documentation.
2023-11-23 08:50:16 -08:00
Naïm Favier
a8fd50b79c
nixos/doc: update custom kernel instructions
Document the `linux.override` way first, then `linuxManualConfig`.

Add a `linux.configEnv` passthru attribute for quickly getting a
`make nconfig`-ready shell.
2022-12-22 01:42:15 +01:00
Maximilian Bosch
8476b02749
nixos/doc: suggest using the latest longterm kernel for ZFS 2022-12-09 11:34:05 +01:00
Maximilian Bosch
fcf0e540b1
nixos/manual: document kernel backporting policy and implications of it
I'm well aware that this issue is currently under discussion[1] and that
these things may change. Also, please don't misinterpret this as an
attempt to end the discussion.

This topic made it obvious that people are surprised by the way this
issue is handled and only finding out about this unwritten rule because
of asking is not a good state IMHO, so I decided to document the
following things:

* Right now we drop kernels as soon as they get out of maintenance (LTS
  kernels even before the next stable NixOS that will exceed their
  lifespan).
* The `latestCompatibleLinuxPackages` attribute from ZFS isn't
  monotonic since latest only refers to the latest supported kernel.
* In fact `latestCompatibleLinuxPackages` doesn't seem to be documented
  at all in the manual, so I also did that.

[1] https://discourse.nixos.org/t/aggressive-kernel-removal-on-eol-in-nixos/23097
2022-12-06 14:04:13 +01:00
Bobby Rong
90354922c2
nixos/doc: adjust to the new structure of kernel packages 2021-09-07 16:13:15 +08:00
Bobby Rong
ad393d5f63 nixos: use only URI fragment in manual options links 2021-07-04 08:24:44 +08:00
Bobby Rong
747c61066c nixos: nixos/doc/manual/configuration/linux-kernel.xml to CommonMark 2021-07-03 19:40:22 +08:00