diff options
author | Janne Heß <janne@hess.ooo> | 2024-03-27 19:10:27 +0100 |
---|---|---|
committer | Valentin Gagarin <valentin.gagarin@tweag.io> | 2024-03-28 09:28:12 +0100 |
commit | fcc95ff8172cc68a0d2d52aa1e8ef2120d2904ec (patch) | |
tree | 8de1a02f7d1624c97562c7736896a6c95c74ec04 /nixos/doc/manual/release-notes | |
parent | bc77c7a9730833c7668c92288c6af950e7270cb5 (diff) |
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.
Diffstat (limited to 'nixos/doc/manual/release-notes')
-rw-r--r-- | nixos/doc/manual/release-notes/rl-1509.section.md | 8 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-1703.section.md | 4 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-2009.section.md | 34 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-2205.section.md | 4 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-2211.section.md | 8 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-2305.section.md | 64 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-2311.section.md | 40 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-2405.section.md | 3 |
8 files changed, 94 insertions, 71 deletions
diff --git a/nixos/doc/manual/release-notes/rl-1509.section.md b/nixos/doc/manual/release-notes/rl-1509.section.md index f47d13008185e..c2ac89a095184 100644 --- a/nixos/doc/manual/release-notes/rl-1509.section.md +++ b/nixos/doc/manual/release-notes/rl-1509.section.md @@ -253,9 +253,9 @@ Installing Haskell _libraries_ this way, however, is no longer supported. See th { options = { - foo = mkOption { … }; + foo = mkOption { /* … */ }; }; - config = mkIf config.foo { … }; + config = mkIf config.foo { /* … */ }; } ``` @@ -268,9 +268,9 @@ Installing Haskell _libraries_ this way, however, is no longer supported. See th { options = { - foo = mkOption { option declaration }; + foo = mkOption { /* option declaration */ }; }; - config = mkIf config.foo { option definition }; + config = mkIf config.foo { /* option definition */ }; } ``` diff --git a/nixos/doc/manual/release-notes/rl-1703.section.md b/nixos/doc/manual/release-notes/rl-1703.section.md index b82c41e28ca34..e20d84d306e82 100644 --- a/nixos/doc/manual/release-notes/rl-1703.section.md +++ b/nixos/doc/manual/release-notes/rl-1703.section.md @@ -246,7 +246,7 @@ When upgrading from a previous release, please be aware of the following incompa let pkgs = import <nixpkgs> {}; in - pkgs.overridePackages (self: super: ...) + pkgs.overridePackages (self: super: { /* ... */ }) ``` should be replaced by: @@ -255,7 +255,7 @@ When upgrading from a previous release, please be aware of the following incompa let pkgs = import <nixpkgs> {}; in - import pkgs.path { overlays = [(self: super: ...)]; } + import pkgs.path { overlays = [(self: super: { /* ... */ })]; } ``` - Autoloading connection tracking helpers is now disabled by default. This default was also changed in the Linux kernel and is considered insecure if not configured properly in your firewall. If you need connection tracking helpers (i.e. for active FTP) please enable `networking.firewall.autoLoadConntrackHelpers` and tune `networking.firewall.connectionTrackingModules` to suit your needs. diff --git a/nixos/doc/manual/release-notes/rl-2009.section.md b/nixos/doc/manual/release-notes/rl-2009.section.md index eac02a8ff445b..900c20dbe717d 100644 --- a/nixos/doc/manual/release-notes/rl-2009.section.md +++ b/nixos/doc/manual/release-notes/rl-2009.section.md @@ -334,22 +334,18 @@ When upgrading from a previous release, please be aware of the following incompa - The remaining configuration flags can now be set directly on the `php` attribute. For example, instead of ```nix - { - php.override { - config.php.embed = true; - config.php.apxs2 = false; - } + php.override { + config.php.embed = true; + config.php.apxs2 = false; } ``` you should now write ```nix - { - php.override { - embedSupport = true; - apxs2Support = false; - } + php.override { + embedSupport = true; + apxs2Support = false; } ``` @@ -383,9 +379,10 @@ When upgrading from a previous release, please be aware of the following incompa { specialisation.example-sub-configuration = { configuration = { - ... + # ... }; - }; + }; + } ``` Replace a `nesting.children` entry with: @@ -395,9 +392,10 @@ When upgrading from a previous release, please be aware of the following incompa specialisation.example-sub-configuration = { inheritParentConfig = false; configuration = { - ... + # ... }; - }; + }; + } ``` To switch to a specialised configuration at runtime you need to run: @@ -469,7 +467,7 @@ When upgrading from a previous release, please be aware of the following incompa services.bitcoind = { enable = true; extraConfig = "..."; - ... + # ... }; } ``` @@ -483,7 +481,7 @@ When upgrading from a previous release, please be aware of the following incompa dataDir = "/var/lib/bitcoind"; user = "bitcoin"; extraConfig = "..."; - ... + # ... }; } ``` @@ -502,7 +500,7 @@ When upgrading from a previous release, please be aware of the following incompa { services.dokuwiki = { enable = true; - ... + # ... }; } ``` @@ -517,7 +515,7 @@ When upgrading from a previous release, please be aware of the following incompa forceSSL = true; enableACME = true; }; - ... + # ... }; } ``` diff --git a/nixos/doc/manual/release-notes/rl-2205.section.md b/nixos/doc/manual/release-notes/rl-2205.section.md index 6f5a807f478a2..3a2c70fb7a31b 100644 --- a/nixos/doc/manual/release-notes/rl-2205.section.md +++ b/nixos/doc/manual/release-notes/rl-2205.section.md @@ -462,6 +462,7 @@ In addition to numerous new and upgraded packages, this release has the followin Before: ```nix + { services.keycloak = { enable = true; httpPort = "8080"; @@ -471,10 +472,12 @@ In addition to numerous new and upgraded packages, this release has the followin "subsystem=undertow"."server=default-server"."http-listener=default".proxy-address-forwarding = true; }; }; + } ``` After: ```nix + { services.keycloak = { enable = true; settings = { @@ -485,6 +488,7 @@ In addition to numerous new and upgraded packages, this release has the followin }; database.passwordFile = "/run/keys/db_password"; }; + } ``` - The MoinMoin wiki engine (`services.moinmoin`) has been removed, because Python 2 is being retired from nixpkgs. diff --git a/nixos/doc/manual/release-notes/rl-2211.section.md b/nixos/doc/manual/release-notes/rl-2211.section.md index 5ad16d15c3d94..77cb6c9baadbc 100644 --- a/nixos/doc/manual/release-notes/rl-2211.section.md +++ b/nixos/doc/manual/release-notes/rl-2211.section.md @@ -255,9 +255,11 @@ In addition to numerous new and upgraded packages, this release includes the fol - `services.github-runner` and `services.github-runners.<name>` gained the option `serviceOverrides` which allows overriding the systemd `serviceConfig`. If you have been overriding the systemd service configuration (i.e., by defining `systemd.services.github-runner.serviceConfig`), you have to use the `serviceOverrides` option now. Example: ```nix - services.github-runner.serviceOverrides.SupplementaryGroups = [ - "docker" - ]; + { + services.github-runner.serviceOverrides.SupplementaryGroups = [ + "docker" + ]; + } ``` <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. --> diff --git a/nixos/doc/manual/release-notes/rl-2305.section.md b/nixos/doc/manual/release-notes/rl-2305.section.md index 21c798b3b4a46..ce874a6e0b2d6 100644 --- a/nixos/doc/manual/release-notes/rl-2305.section.md +++ b/nixos/doc/manual/release-notes/rl-2305.section.md @@ -25,7 +25,9 @@ In addition to numerous new and updated packages, this release has the following - NixOS now defaults to using [nsncd](https://github.com/twosigma/nsncd), a non-caching reimplementation of nscd in Rust, as its NSS lookup dispatcher. This replaces the buggy and deprecated nscd implementation provided through glibc. When you find problems, you can switch back by disabling it: ```nix - services.nscd.enableNsncd = false; + { + services.nscd.enableNsncd = false; + } ``` - The internal option `boot.bootspec.enable` is now enabled by default because [RFC 0125](https://github.com/NixOS/rfcs/pull/125) was merged. This means you will have a bootspec document called `boot.json` generated for each system and specialisation in the top-level. This is useful to enable advanced boot use cases in NixOS, such as Secure Boot. @@ -190,11 +192,13 @@ In addition to numerous new and updated packages, this release has the following - MAC-then-encrypt algorithms were removed from the default selection of `services.openssh.settings.Macs`. If you still require these [MACs](https://en.wikipedia.org/wiki/Message_authentication_code), for example when you are relying on libssh2 (e.g. VLC) or the SSH library shipped on the iPhone, you can re-add them like this: ```nix - services.openssh.settings.Macs = [ - "hmac-sha2-512" - "hmac-sha2-256" - "umac-128@openssh.com" - ]; + { + services.openssh.settings.Macs = [ + "hmac-sha2-512" + "hmac-sha2-256" + "umac-128@openssh.com" + ]; + } ``` - `podman` now uses the `netavark` network stack. Users will need to delete all of their local containers, images, volumes, etc, by running `podman system reset --force` once before upgrading their systems. @@ -227,21 +231,25 @@ In addition to numerous new and updated packages, this release has the following - The attributes used by `services.snapper.configs.<name>` have changed. Migrate from this: ```nix - services.snapper.configs.example = { - subvolume = "/example"; - extraConfig = '' - ALLOW_USERS="alice" - ''; - }; + { + services.snapper.configs.example = { + subvolume = "/example"; + extraConfig = '' + ALLOW_USERS="alice" + ''; + }; + } ``` to this: ```nix - services.snapper.configs.example = { - SUBVOLUME = "/example"; - ALLOW_USERS = [ "alice" ]; - }; + { + services.snapper.configs.example = { + SUBVOLUME = "/example"; + ALLOW_USERS = [ "alice" ]; + }; + } ``` - The default module options for [services.snapserver.openFirewall](#opt-services.snapserver.openFirewall), [services.tmate-ssh-server.openFirewall](#opt-services.tmate-ssh-server.openFirewall) and [services.unifi-video.openFirewall](#opt-services.unifi-video.openFirewall) have been changed from `true` to `false`. You will need to explicitly set this option to `true`, or configure your firewall. @@ -446,15 +454,17 @@ In addition to numerous new and updated packages, this release has the following - NixOS swap partitions with random encryption can now control the sector size, cipher, and key size used to set up the plain encryption device over the underlying block device rather than allowing them to be determined by `cryptsetup(8)`. One can use these features like so: ```nix - swapDevices = [ { - device = "/dev/disk/by-partlabel/swapspace"; - randomEncryption = { - enable = true; - cipher = "aes-xts-plain64"; - keySize = 512; - sectorSize = 4096; - }; - } ]; + { + swapDevices = [ { + device = "/dev/disk/by-partlabel/swapspace"; + randomEncryption = { + enable = true; + cipher = "aes-xts-plain64"; + keySize = 512; + sectorSize = 4096; + }; + } ]; + } ``` - New option `security.pam.zfs` to enable unlocking and mounting of encrypted ZFS home dataset at login. @@ -465,7 +475,9 @@ In addition to numerous new and updated packages, this release has the following - PostgreSQL has added opt-in support for [JIT compilation](https://www.postgresql.org/docs/current/jit-reason.html). It can be enabled like this: ```nix - services.postgresql.enableJIT = true; + { + services.postgresql.enableJIT = true; + } ``` - `services.netdata` offers a [`services.netdata.deadlineBeforeStopSec`](#opt-services.netdata.deadlineBeforeStopSec) option which will control the deadline (in seconds) after which systemd will consider your netdata instance as dead if it didn't start in the elapsed time. It is helpful when your netdata instance takes longer to start because of a large amount of state or upgrades. diff --git a/nixos/doc/manual/release-notes/rl-2311.section.md b/nixos/doc/manual/release-notes/rl-2311.section.md index eb6667b3fe8f0..5313f04cb7895 100644 --- a/nixos/doc/manual/release-notes/rl-2311.section.md +++ b/nixos/doc/manual/release-notes/rl-2311.section.md @@ -700,11 +700,13 @@ Make sure to also check the many updates in the [Nixpkgs library](#sec-release-2 will probably be removed eventually. ```nix - qt = { - enable = true; - platformTheme = "gnome"; - style = "adwaita"; - }; + { + qt = { + enable = true; + platformTheme = "gnome"; + style = "adwaita"; + }; + } ``` - DocBook option documentation is no longer supported, all module documentation @@ -885,11 +887,13 @@ Make sure to also check the many updates in the [Nixpkgs library](#sec-release-2 to a compatible major version, so they can move at their own pace. ```nix - python = python3.override { - packageOverrides = self: super: { - django = super.django_3; + { + python = python3.override { + packageOverrides = self: super: { + django = super.django_3; + }; }; - }; + } ``` - The `qemu-vm.nix` module by default now identifies block devices via @@ -1229,15 +1233,17 @@ Make sure to also check the many updates in the [Nixpkgs library](#sec-release-2 overriding `externalPlugins` and `vendorHash` arguments like this: ```nix - services.coredns = { - enable = true; - package = pkgs.coredns.override { - externalPlugins = [ - {name = "fanout"; repo = "github.com/networkservicemesh/fanout"; version = "v1.9.1";} - ]; - vendorHash = "<SRI hash>"; + { + services.coredns = { + enable = true; + package = pkgs.coredns.override { + externalPlugins = [ + {name = "fanout"; repo = "github.com/networkservicemesh/fanout"; version = "v1.9.1";} + ]; + vendorHash = "<SRI hash>"; + }; }; - }; + } ``` To get the necessary SRI hash, set `vendorHash = "";`. The build will fail diff --git a/nixos/doc/manual/release-notes/rl-2405.section.md b/nixos/doc/manual/release-notes/rl-2405.section.md index 0218621ae1c04..88d9ee646fd54 100644 --- a/nixos/doc/manual/release-notes/rl-2405.section.md +++ b/nixos/doc/manual/release-notes/rl-2405.section.md @@ -223,13 +223,14 @@ The pre-existing [services.ankisyncd](#opt-services.ankisyncd.enable) has been m Example: ```nix + { locations."/".extraConfig = '' add_header Alt-Svc 'h3=":$server_port"; ma=86400'; ''; locations."^~ /assets/".extraConfig = '' add_header Alt-Svc 'h3=":$server_port"; ma=86400'; ''; - + } ``` - The package `optparse-bash` is now dropped due to upstream inactivity. Alternatives available in Nixpkgs include [`argc`](https://github.com/sigoden/argc), [`argbash`](https://github.com/matejak/argbash), [`bashly`](https://github.com/DannyBen/bashly) and [`gum`](https://github.com/charmbracelet/gum), to name a few. |