Commit graph

376 commits

Author SHA1 Message Date
Naïm Favier fb613a3a41
nixos/nvidia: update manual
Remove the `nvidiaLegacy*` video drivers from the manual: not only are
they deprecated, their deprecation notice was removed in
https://github.com/NixOS/nixpkgs/pull/244060.
2024-03-25 16:56:11 +01:00
Soenke Klinger d0a888c315
doc: added nvidiaLegacy driver version 470 to available options in nixos manual (#290231)
Its possible to install the nvidiaLegacy470 driver for the slightly outdated GPUs, but the documentation only has the hints how to install the drivers for the even older GPUs.
2024-03-07 22:29:13 +01:00
nikstur 1407ec7420 nixos/filesystems: add overlayfs docs 2024-02-07 22:13:00 +01:00
github-actions[bot] a4b5a14b07
Merge master into staging-next 2024-01-25 00:02:13 +00:00
Lassulus 65f1d64303
Merge pull request #279923 from jopejoe1/sshfs
nixos/filesystems: set `system.fsPackages` for sshfs
2024-01-24 22:04:41 +01:00
github-actions[bot] 3a8094730e
Merge master into staging-next 2024-01-22 12:01:10 +00:00
nikstur 3df9c5ef3e nixos/profiles/perlless: add manual section 2024-01-22 00:54:14 +01:00
nikstur d4a8fe24c2 nixos/systemd-sysusers: add manual section 2024-01-18 23:08:14 +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
jopejoe1 8967ac726c nixos/manual: update sshfs section 2024-01-10 00:24:48 +01:00
Sergei Trofimovich 337036cffa beignet: remove the package
`beignet` saw no development since 2018 and was never ported from
`llvmPackages_6`. Is it's a library to support `OpenCL` on older GPUs
let's drop it from `nixpkgs`.
2024-01-08 10:33:46 +00:00
Janik 5380b3c73a
Merge pull request #259773 from dadada/dadada/luks-fido2-systemd 2023-12-03 07:19:00 +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
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
Paul Meyer 143680787e nixos/x11: move extraLayouts into xkb attrset
[Motivation](NixOS#257817 (comment))

`extraLayouts` was missed in #259891, so moving it to the other xkb
options with this PR.

Signed-off-by: Paul Meyer <49727155+katexochen@users.noreply.github.com>
2023-11-01 11:55:25 +01:00
Victor Engmark 3a6c79cff6 nixos/x11: refactor XKB options into a single attrset
[Motivation](https://github.com/NixOS/nixpkgs/issues/257817#issuecomment-1741705042):

- Having all the XKB options in the same attribute set clarifies their
  relation better than using a common option name prefix ("xkb").
- `services.xserver.layout` is an XKB option, but this is not obvious
  from its name. Putting it with the other XKB options clarifies this.

Co-authored-by: Michele Guerini Rocco <rnhmjoj@users.noreply.github.com>
2023-10-11 09:46:37 +03:00
Madoura 6f39d63688
nixos/doc: rocm-opencl-icd -> rocmPackages.clr.icd 2023-10-09 16:38:54 -05:00
dadada 0f8084ba6b
nixos/doc: add documentation on using FIDO2 tokens in systemd stage1 2023-10-08 17:38:25 +02:00
K900 018f62a151 nixos/doc: remove reference to long removed option 2023-09-26 18:02:01 +03:00
nicoo fe138d36c9 doc: Replace sha256 with hash where appropriate 2023-09-13 17:24:49 +00:00
Molly Miller f13c890b59 nixos/manual: rename references to services.udev.initrdRules
This option was renamed to boot.initrd.services.udev.rules.
2023-06-27 14:36:49 +02:00
Franz Pletz 5224f298f0
Merge pull request #235202 from SuperSandro2000/intel-vaapi-driver 2023-06-21 20:15:17 +02:00
x10an14 dc7d4dece5
Document how to use packages with extensions. (#145011)
Co-authored-by: Artturi <Artturin@artturin.com>
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-06-06 22:37:42 +02:00
Sandro Jäckel fdb8f4994a
vaapiIntel: rename to intel-vaapi-driver
I tripped over this way to often and a package attr matching the pname
is way nicer, anyway.
2023-05-31 15:05:32 +02:00
Atemu f63a12f296 tree-wide: buildFHSUserEnv -> buildFHSEnv 2023-04-16 10:15:13 +02:00
pennae 1229e735ac nixos-render-docs: add structural includes, use for manual
this adds support for structural includes to nixos-render-docs.
structural includes provide a way to denote the (sub)structure of the
nixos manual in the markdown source files, very similar to how we used
literal docbook blocks before, and are processed by nixos-render-docs
without involvement of xml tooling. this will ultimately allow us to
emit the nixos manual in other formats as well, e.g. html, without going
through docbook at all.

alternatives to this source layout were also considered:

a parallel structure using e.g. toml files that describe the document
tree and links to each part is possible, but much more complicated to
implement than the solution chosen here and makes it harder to follow
which files have what substructure. it also makes it much harder to
include a substructure in the middle of a file.

much the same goes for command-line arguments to the converter, only
that command-lined arguments are even harder to specify correctly and
cannot be reasonably pulled together from many places without involving
another layer of tooling. cli arguments would also mean that the manual
structure would be fixed in default.nix, which is also not ideal.
2023-02-12 13:02:42 +01:00
pennae 65d749c80b nixos/manual: inline the single footnote
this is a lot easier than adding footnote support for just the one
instance. if a use case for footnotes appears in the future (e.g. if we
wanted to render the nixpkgs manual with nixos-render-docs as well) this
decision should be reevaluated.
2023-02-10 06:40:01 +01:00
pennae 2ad93ab199 nixos/manual: remove remaining docbook tags
there's one remaining instance of literal docbook tags in the manual.
replace it with a literal (as has been done for package tags everywhere else).
2023-02-10 06:40:01 +01:00
pennae 2e3d9e8d74 nixos/manual: remove .unnumbered section attributes
pandoc would drop these when converting to docbook, just like it dropped
.title block classes.
2023-02-10 06:40:01 +01:00
Tim Fenney fab09085df
doc/nixos: prefer the verb 'log in' (#214616)
* doc/nixos: prefer the term 'login'

Change "re-log" to "login again."

* Update nixos/doc/manual/configuration/xfce.chapter.md

Co-authored-by: Naïm Favier <n@monade.li>

* Change also xml.

---------

Co-authored-by: Naïm Favier <n@monade.li>
2023-02-07 10:48:31 +01:00
Timothy Fenney e60870a807 doc/nixos:
Bump the postgres version in the manual text to match the version in the above Nix expression.
2023-01-30 17:57:02 -07:00
Matthieu Coudron cf10d7aef8
services.openssh: support freeform settings (#193757)
* services.openssh: support freeform settings

Keep "extraConfig" but introduces "settings".

Also renames several options

(mkRenamedOptionModule [ "services" "openssh" "kbdInteractiveAuthentication" ] [  "services" "openssh" "settings" "KbdInteractiveAuthentication" ])
(mkRenamedOptionModule [ "services" "openssh" "passwordAuthentication" ] [  "services" "openssh" "settings" "PasswordAuthentication" ])
(mkRenamedOptionModule [ "services" "openssh" "useDns" ] [  "services" "openssh" "settings" "UseDns" ])
(mkRenamedOptionModule [ "services" "openssh" "permitRootLogin" ] [  "services" "openssh" "settings" "PermitRootLogin" ])

* updated doc
* regen doc
2023-01-15 16:32:46 +01:00
linsui a2e21c76c7 rename config.qt5 -> config.qt 2023-01-10 20:50:15 +08:00
Naïm Favier 3f6fed2e59
doc,nixos/doc: unescape ellipses
Leftovers from the CommonMark conversion.
2022-12-27 17:13:49 +01:00
Naïm Favier e9e65810ac
doc,nixos/doc: unescape double quotes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:49 +01:00
Naïm Favier d11832fd96
doc,nixos/doc: unescape apostrophes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:47 +01: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
figsoda 6bb0dbf91f nixos: fix typos 2022-12-17 19:31:14 -05:00
Jörg Thalheim 2b7fb2fe8e
Merge pull request #204785 from corngood/vaapi-docs
nixos/doc/manual: add chapter on VA-API
2022-12-17 08:53:27 +00:00
Mike Dalrymple 495b71906c
docs: added missing semicolon in example 2022-12-12 12:07:15 -08:00
Maximilian Bosch 8476b02749
nixos/doc: suggest using the latest longterm kernel for ZFS 2022-12-09 11:34:05 +01:00
David McFarland 7df3e9ec5b nixos/doc/manual: add chapter on VA-API 2022-12-06 10:05:01 -04: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
Martin Weinelt 55ab131ee2
nixos/manual: Don't recommend mkpasswd methods
Instead rely on the default, which at this time is yescrypt.
2022-11-19 14:07:59 +01:00
Sergei Trofimovich 00d016a2f5
Merge pull request #186764 from fricklerhandwerk/remove-syntax-overview
remove Nix language syntax summary
2022-11-18 22:41:54 +00:00
github-actions[bot] e648107a22
Merge master into staging-next 2022-10-16 06:06:19 +00:00
Johan Thomsen 38ea9bc083 nixos/manual/kubernetes: re-enabling of insecure ports is no longer possible 2022-10-16 10:13:05 +10:00
Mario Rodas 405db07799
Merge pull request #167047 from helsinki-systems/drop/postgresql10
postgresql: remove 10.x
2022-10-06 21:32:46 -05:00
Thiago Kenji Okada ae0cfe80c4 nixos/xserver: remove useGlamor option
This option is based on a recommendation from a page last updated in
2014 (see https://www.freedesktop.org/wiki/Software/Glamor/), and it
is not necessary anymore.

Also, it did the wrong thing: it forced DRI2, but Glamor should also
work with DRI3, that is a better option most of the time. So let's
remove this option, folks that still want to force this manually can do
so in other ways.
2022-08-23 18:14:00 +01:00
ajs124 817ca3699e treewide: change postgresql_10 in documentation and examples to postgresql_14 2022-08-15 22:36:32 +02:00
Valentin Gagarin db5e8a7141 remove Nix language syntax summary
this belongs to the Nix package manager manual
2022-08-15 10:24:45 +02:00
olaf 5a6853b3bf use consistently user alice for examples 2022-08-05 13:13:24 +02:00
Guillaume Girol dbc86c1be8
Merge pull request #176595 from symphorien/appimage-run-doc
nixos/doc: explain how to run appimages
2022-07-03 20:36:21 +00:00
José Romildo bb5ec4625a nixos/thunar: init
- Add a module for the thunar file manager, which depends on the xfconf dbus service, and also has a dbus service and a systemd unit.

- Renames the option services.xserver.desktopManager.xfce.thunarPlugins to programs.thunar.plugins.
2022-06-26 12:22:07 -03:00
Guillaume Girol fd3fc309f4 nixos/doc: explain how to run appimages 2022-06-06 12:00:00 +00:00
Andrew Kvalheim 12bab91d3b nixos/doc: improve example of renaming network interfaces
For reliably identifying network interfaces, `PermanentMACAddress` is
likely to be preferable to `MACAddress`. NetworkManager in particular
commonly changes the MAC address of wireless interfaces.

Reference:

  - https://www.freedesktop.org/software/systemd/man/systemd.link.html#PermanentMACAddress=
2021-11-21 20:12:31 -08:00
github-actions[bot] 45de5d0c9a
Merge master into staging-next 2021-09-12 06:01:00 +00:00
Bobby Rong 785d40d4d8
nixos: nixos/doc/manual/configuration/profiles.xml to CommonMark 2021-09-08 16:35:17 +08:00
Bobby Rong 2e808c8144
nixos: nixos/doc/manual/configuration/networking.xml to CommonMark 2021-09-08 16:35:16 +08:00
Bobby Rong 4c10e0ff9d
nixos: nixos/doc/manual/configuration/file-systems.xml to CommonMark 2021-09-08 16:35:16 +08:00
Bobby Rong 7d7d2a4455
nixos: nixos/doc/manual/configuration/package-mgmt.xml to CommonMark 2021-09-08 16:35:16 +08:00
Bobby Rong 45c1d8f4aa
nixos: nixos/doc/manual/configuration/config-syntax.xml to CommonMark 2021-09-08 15:47:16 +08:00
Bobby Rong 8ce611b9fb
nixos: nixos/doc/manual/configuration/declarative-packages.xml to CommonMark 2021-09-08 15:47:05 +08:00
Bobby Rong 90354922c2
nixos/doc: adjust to the new structure of kernel packages 2021-09-07 16:13:15 +08:00
Jörg Thalheim 4015c275ca
Merge pull request #129121 from bobby285271/pr13
nixos/doc: convert Chapter 7, 9, 10, 11, 12, 14, 15, 48 to CommonMark
2021-09-07 06:29:45 +01:00
Jörg Thalheim 929f0156cc
Merge pull request #128933 from bobby285271/pr5
nixos/doc: convert "8.1. LUKS-Encrypted File Systems" to CommonMark
2021-09-07 06:28:37 +01:00
Jörg Thalheim 2a55504a99
Merge pull request #128934 from bobby285271/pr6
nixos/doc: convert "6.2. Ad-Hoc Package Management" to CommonMark
2021-09-07 06:20:26 +01:00
Jörg Thalheim 96c98af211
Merge pull request #128892 from bobby285271/pr4
nixos/doc: convert "Chapter 13. Networking" to CommonMark
2021-09-07 06:20:04 +01:00
Jörg Thalheim 6e17c53b98
Merge pull request #128885 from bobby285271/pr3
nixos/doc: convert "Chapter 5. Configuration Syntax" to CommonMark
2021-09-07 03:56:34 +01:00
Jörg Thalheim b9ed8cbaff
Merge pull request #128878 from bobby285271/pr2
nixos/doc: convert "6.1. Declarative Package Management" to CommonMark
2021-09-07 03:55:22 +01:00
Bobby Rong 45a5a6815c nixos: use only URI fragment in manual options links 2021-07-04 10:12:05 +08:00
Bobby Rong 69bf2d1ed5 nixos: use only URI fragment in manual options links 2021-07-04 09:56:26 +08:00
Bobby Rong ef37170c6d nixos: use only URI fragment in manual options links 2021-07-04 09:11:53 +08:00
Bobby Rong 227811ac97 nixos: use only URI fragment in manual options links 2021-07-04 08:42:44 +08:00
Bobby Rong 2d466c7adc nixos: improve indentation in nixos/doc/manual/configuration/gpu-accel.chapter.md 2021-07-04 08:29:41 +08:00
Bobby Rong ad393d5f63 nixos: use only URI fragment in manual options links 2021-07-04 08:24:44 +08:00
Bobby Rong f8bdee0054 nixos: nixos/doc/manual/configuration/kubernetes.xml to CommonMark 2021-07-03 19:41:27 +08:00
Bobby Rong ee807a30cf nixos: nixos/doc/manual/configuration/subversion.xml to CommonMark 2021-07-03 19:40:53 +08:00
Bobby Rong 747c61066c nixos: nixos/doc/manual/configuration/linux-kernel.xml to CommonMark 2021-07-03 19:40:22 +08:00
Bobby Rong 35f476e8b9 nixos: nixos/doc/manual/configuration/xfce.xml to CommonMark 2021-07-03 19:39:37 +08:00
Bobby Rong 5ad28f4197 nixos: nixos/doc/manual/configuration/gpu-accel.xml to CommonMark 2021-07-03 19:38:53 +08:00
Bobby Rong f04b9023e3 nixos: nixos/doc/manual/configuration/wayland.xml to CommonMark 2021-07-03 19:38:06 +08:00
Bobby Rong 361056334d nixos: nixos/doc/manual/configuration/x-windows.xml to CommonMark 2021-07-03 19:37:18 +08:00
Bobby Rong a55f0640b0 nixos: nixos/doc/manual/configuration/user-mgmt.xml to CommonMark 2021-07-03 19:36:14 +08:00
Bobby Rong 865b3918f2 nixos: nixos/doc/manual/configuration/ad-hoc-packages.xml to CommonMark 2021-07-02 10:08:04 +08:00
Bobby Rong 79134b77aa nixos: nixos/doc/manual/configuration/luks-file-systems.xml to CommonMark 2021-07-02 09:27:20 +08:00
Bobby Rong e602771722 nixos: nixos/doc/manual/configuration/renaming-interfaces.xml to CommonMark 2021-07-01 23:21:22 +08:00
Bobby Rong 55aa106c0b nixos: nixos/doc/manual/configuration/ad-hoc-network-config.xml to CommonMark 2021-07-01 23:15:04 +08:00
Bobby Rong 54419f6e59 nixos: nixos/doc/manual/configuration/wireless.xml to CommonMark 2021-07-01 23:14:20 +08:00
Bobby Rong 97bfa927fa nixos: nixos/doc/manual/configuration/firewall.xml to CommonMark 2021-07-01 23:13:41 +08:00
Bobby Rong dbd2d379da nixos: nixos/doc/manual/configuration/ipv6-config.xml to CommonMark 2021-07-01 23:12:39 +08:00
Bobby Rong 3d423e2b15 nixos: nixos/doc/manual/configuration/ipv4-config.xml to CommonMark 2021-07-01 23:11:54 +08:00
Bobby Rong 83fc29ffb9 nixos: nixos/doc/manual/configuration/ssh.xml to CommonMark 2021-07-01 23:10:48 +08:00
Bobby Rong c10ad53007 nixos: nixos/doc/manual/configuration/network-manager.xml to CommonMark 2021-07-01 23:09:53 +08:00
Bobby Rong 800c1f15a3 nixos: nixos/doc/manual/configuration/summary.xml to CommonMark 2021-07-01 21:15:28 +08:00
Bobby Rong 6122fb4123 nixos: nixos/doc/manual/configuration/modularity.xml to CommonMark 2021-07-01 21:15:27 +08:00
Bobby Rong 07ca0e237e nixos: nixos/doc/manual/configuration/config-file.xml to CommonMark 2021-07-01 21:15:20 +08:00
Bobby Rong 9f4535ff16 nixos: nixos/doc/manual/configuration/customizing-packages.xml to CommonMark 2021-07-01 19:38:15 +08:00