doc: update Nix code snippets format (bcea0cf3) · Commits · nix / nixpkgs

doc/build-helpers/dev-shell-tools.chapter.md

+12 −3

Original line number	Diff line number	Diff line
		@@ -42,9 +42,15 @@ This function does not support `__structuredAttrs`, but does support `passAsFile
		devShellTools.unstructuredDerivationInputEnv {
		drvAttrs = {
		name = "foo";
		buildInputs = [ hello figlet ];
		buildInputs = [
		hello
		figlet
		];
		builder = bash;
		args = [ "-c" "${./builder.sh}" ];
		args = [
		"-c"
		"${./builder.sh}"
		];
		};
		}
		# => {
		@@ -69,7 +75,10 @@ Takes the relevant parts of a derivation and returns a set of environment variab
		let
		pkg = hello;
		in
		devShellTools.derivationOutputEnv { outputList = pkg.outputs; outputMap = pkg; }
		devShellTools.derivationOutputEnv {
		outputList = pkg.outputs;
		outputMap = pkg;
		}
		```

		:::

doc/build-helpers/fetchers.chapter.md

+12 −5

Original line number	Diff line number	Diff line
		@@ -491,7 +491,11 @@ It might be useful to manipulate the content downloaded by `fetchurl` directly i
		In this example, we'll adapt [](#ex-fetchers-fetchurl-nixpkgs-version) to append the result of running the `hello` package to the contents we download, purely to illustrate how to manipulate the content.

		```nix
		{ fetchurl, hello, lib }:
		{
		fetchurl,
		hello,
		lib,
		}:
		fetchurl {
		url = "https://raw.githubusercontent.com/NixOS/nixpkgs/23.11/.version";

		@@ -714,9 +718,10 @@ A wrapper around `fetchpatch`, which takes:
		Here is an example of `fetchDebianPatch` in action:

		```nix
		{ lib
		, fetchDebianPatch
		, buildPythonPackage
		{
		lib,
		fetchDebianPatch,
		buildPythonPackage,
		}:

		buildPythonPackage rec {
		@@ -914,7 +919,9 @@ It produces packages that cannot be built automatically.
		{ fetchtorrent }:

		fetchtorrent {
		config = { peer-limit-global = 100; };
		config = {
		peer-limit-global = 100;
		};
		url = "magnet:?xt=urn:btih:dd8255ecdc7ca55fb0bbf81323d87062db1f6d1c";
		hash = "";
		}

doc/build-helpers/images/appimagetools.section.md

+6 −3

Original line number	Diff line number	Diff line
		@@ -66,7 +66,8 @@ let
		url = "https://github.com/irccloud/irccloud-desktop/releases/download/v${version}/IRCCloud-${version}-linux-x86_64.AppImage";
		hash = "sha256-/hMPvYdnVB1XjKgU2v47HnVvW4+uC3rhRjbucqin4iI=";
		};
		in appimageTools.wrapType2 {
		in
		appimageTools.wrapType2 {
		inherit pname version src;
		extraPkgs = pkgs: [ pkgs.at-spi2-core ];
		}
		@@ -106,7 +107,8 @@ let
		appimageContents = appimageTools.extract {
		inherit pname version src;
		};
		in appimageTools.wrapType2 {
		in
		appimageTools.wrapType2 {
		inherit pname version src;

		extraPkgs = pkgs: [ pkgs.at-spi2-core ];
		@@ -150,7 +152,8 @@ let
		substituteInPlace $out/irccloud.desktop --replace-fail 'Exec=AppRun' 'Exec=${pname}'
		'';
		};
		in appimageTools.wrapType2 {
		in
		appimageTools.wrapType2 {
		inherit pname version src;

		extraPkgs = pkgs: [ pkgs.at-spi2-core ];

doc/build-helpers/images/dockertools.section.md

+34 −8

Original line number	Diff line number	Diff line
		@@ -235,7 +235,11 @@ The following package builds a Docker image that runs the `redis-server` executa
		The Docker image will have name `redis` and tag `latest`.

		```nix
		{ dockerTools, buildEnv, redis }:
		{
		dockerTools,
		buildEnv,
		redis,
		}:
		dockerTools.buildImage {
		name = "redis";
		tag = "latest";
		@@ -253,7 +257,9 @@ dockerTools.buildImage {
		config = {
		Cmd = [ "/bin/redis-server" ];
		WorkingDir = "/data";
		Volumes = { "/data" = { }; };
		Volumes = {
		"/data" = { };
		};
		};
		}
		```
		@@ -286,7 +292,11 @@ It uses `runAsRoot` to create a directory and a file inside the image.
		This works the same as [](#ex-dockerTools-buildImage-extraCommands), but uses `runAsRoot` instead of `extraCommands`.

		```nix
		{ dockerTools, buildEnv, hello }:
		{
		dockerTools,
		buildEnv,
		hello,
		}:
		dockerTools.buildImage {
		name = "hello";
		tag = "latest";
		@@ -320,7 +330,11 @@ This works the same as [](#ex-dockerTools-buildImage-runAsRoot), but uses `extra
		Note that with `extraCommands`, we can't directly reference `/` and must create files and directories as if we were already on `/`.

		```nix
		{ dockerTools, buildEnv, hello }:
		{
		dockerTools,
		buildEnv,
		hello,
		}:
		dockerTools.buildImage {
		name = "hello";
		tag = "latest";
		@@ -350,7 +364,11 @@ dockerTools.buildImage {
		Note that using a value of `"now"` in the `created` attribute will break reproducibility.

		```nix
		{ dockerTools, buildEnv, hello }:
		{
		dockerTools,
		buildEnv,
		hello,
		}:
		dockerTools.buildImage {
		name = "hello";
		tag = "latest";
		@@ -766,7 +784,11 @@ The closure of `config` is automatically included in the generated image.
		The following package shows a more compact way to create the same output generated in [](#ex-dockerTools-streamLayeredImage-hello).

		```nix
		{ dockerTools, hello, lib }:
		{
		dockerTools,
		hello,
		lib,
		}:
		dockerTools.streamLayeredImage {
		name = "hello";
		tag = "latest";
		@@ -1547,7 +1569,11 @@ The Docker image generated will have a name like `hello-<version>-env` and tag `
		This example uses [](#ex-dockerTools-streamNixShellImage-hello) as a starting point.

		```nix
		{ dockerTools, cowsay, hello }:
		{
		dockerTools,
		cowsay,
		hello,
		}:
		dockerTools.streamNixShellImage {
		tag = "latest";
		drv = hello.overrideAttrs (old: {

doc/build-helpers/images/makediskimage.section.md

+37 −30

Original line number	Diff line number	Diff line
		@@ -85,14 +85,21 @@ let
		in
		make-disk-image {
		inherit pkgs lib;
		inherit (evalConfig {
		inherit
		(evalConfig {
		modules = [
		{
		fileSystems."/" = { device = "/dev/vda"; fsType = "ext4"; autoFormat = true; };
		fileSystems."/" = {
		device = "/dev/vda";
		fsType = "ext4";
		autoFormat = true;
		};
		boot.grub.device = "/dev/vda";
		}
		];
		}) config;
		})
		config
		;
		format = "qcow2";
		onlyNixStore = false;
		partitionTableType = "legacy+gpt";

Admin message