Nix Cookbook - Revision history

SigmaSquadron: /* Vulnerabilities */ Add an actual link to vulnix

2025-04-17T17:17:26Z

Vulnerabilities: Add an actual link to vulnix

← Older revision		Revision as of 17:17, 17 April 2025
Line 388:		Line 388:
	=== Vulnerabilities ===		=== Vulnerabilities ===

	See ~~Vulnix~~.		See [https://github.com/nix-community/vulnix vulnix].


	[[Category:nix]]		[[Category:nix]]
	[[Category:Cookbook]]		[[Category:Cookbook]]

Phanirithvij: update url to wayback machine url

2024-10-02T17:34:05Z

update url to wayback machine url

← Older revision		Revision as of 17:34, 2 October 2024
Line 200:		Line 200:
	After that, all sources will be locally stored!		After that, all sources will be locally stored!

	Source: ~~<nowiki>~~http://lists.science.uu.nl/pipermail/nix-dev/2013-January/010438.html~~</nowiki>~~		Source: [https://web.archive.org/web/20160829181620/http://lists.science.uu.nl/pipermail/nix-dev/2013-January/010438.html nix-dev thread]

	== Wrapping packages ==		== Wrapping packages ==

AndersonTorres: /* Bulk pre-download all dependencies of a package */

2024-09-01T15:39:57Z

Bulk pre-download all dependencies of a package

← Older revision		Revision as of 15:39, 1 September 2024
Line 184:		Line 184:
	Let's dissect this:		Let's dissect this:

	<~~syntaxHighlight~~ lang="sh">		<syntaxhighlight lang="sh" line="1">
	## instantiate bochs into `.drv` files and print the filenames;		## instantiate bochs into `.drv` files and print the filenames;
	instantiate=$(nix-instantiate '<nixpkgs>' -A bochs)		instantiate=$(nix-instantiate '<nixpkgs>' -A bochs)

	## print all references/requirements, filtering the .drv files (which is where static derivations live)		## print all references/requirements, filtering the .drv files (which is where static derivations live)
	requirements=$(nix-store -qR $~~intantiate~~ \| grep '.drv$')		requirements=$(nix-store -qR $instantiate \| grep '.drv$')

	## keep only the source derivations, since those will have a predefined hash of the output		## keep only the source derivations, since those will have a predefined hash of the output
Line 196:		Line 196:
	## realize those derivations, downloading all sources and storing them in the nix store		## realize those derivations, downloading all sources and storing them in the nix store
	nix-store -r $sources		nix-store -r $sources
	</~~syntaxHighlight~~>		</syntaxhighlight>

	After that, all sources will be locally stored!		After that, all sources will be locally stored!

AndersonTorres: /* Bulk pre-download all dependencies of a package */

2024-07-28T14:13:41Z

Bulk pre-download all dependencies of a package

← Older revision		Revision as of 14:13, 28 July 2024
Line 199:		Line 199:

	After that, all sources will be locally stored!		After that, all sources will be locally stored!

			Source: <nowiki>http://lists.science.uu.nl/pipermail/nix-dev/2013-January/010438.html</nowiki>

	== Wrapping packages ==		== Wrapping packages ==

AndersonTorres: one-liner to bulk download

2024-07-28T14:13:14Z

one-liner to bulk download

← Older revision		Revision as of 14:13, 28 July 2024
Line 167:		Line 167:

	With this warning, consumers will have time to patch their codes.		With this warning, consumers will have time to patch their codes.

			== Bulk pre-download all dependencies of a package ==


			Sometimes we need to download all source dependencies of a package.
			E.G. a long build is being planned, so we first download all needed files, so that after that we only need to worry about local (non-Internet) issues.

			Here is a one-liner for downloading all the source dependencies of a package (thanks Eelco Dolstra!):

			<syntaxHighlight lang="shell">

			$> nix-store -r $(grep -l outputHash $(nix-store -qR $(nix-instantiate '<nixpkgs>' -A bochs) \| grep '.drv$'))

			</syntaxHighlight>

			Let's dissect this:

			<syntaxHighlight lang="sh">
			## instantiate bochs into `.drv` files and print the filenames;
			instantiate=$(nix-instantiate '<nixpkgs>' -A bochs)

			## print all references/requirements, filtering the .drv files (which is where static derivations live)
			requirements=$(nix-store -qR $intantiate \| grep '.drv$')

			## keep only the source derivations, since those will have a predefined hash of the output
			sources=$(grep -l outputHash $requirements)

			## realize those derivations, downloading all sources and storing them in the nix store
			nix-store -r $sources
			</syntaxHighlight>

			After that, all sources will be locally stored!

	== Wrapping packages ==		== Wrapping packages ==

AndersonTorres at 03:22, 28 July 2024

2024-07-28T03:22:20Z

← Older revision		Revision as of 03:22, 28 July 2024
Line 156:		Line 156:
	withGui ?		withGui ?
	if (withX != null) then		if (withX != null) then
	lib.warn "withX is deprecated and will be removed in the next release; use withGui instead." withX		lib.warn ''
			withX is deprecated and will be removed in the next release;
			use withGui instead.
			'' withX
	else		else
	true		true
Line 162:		Line 165:
	}		}
	</syntaxHighlight>		</syntaxHighlight>

			With this warning, consumers will have time to patch their codes.

	== Wrapping packages ==		== Wrapping packages ==

AndersonTorres: /* Deprecating input parameters in mkDerivation-style packages */

2024-07-27T18:02:09Z

Deprecating input parameters in mkDerivation-style packages

← Older revision		Revision as of 18:02, 27 July 2024
Line 126:		Line 126:
	</syntaxHighlight>		</syntaxHighlight>

	== Deprecating input ~~parameters~~ in mkDerivation-style packages ==		== Deprecating a specific input parameter in mkDerivation-style packages ==

	Sometimes we want to rename an input parameter.		Sometimes we want to rename some input parameter in .

	E.G. an option `withX` that enables the X11 GUI for a certain app:		E.G. an option `withX` that enables the X11 GUI for a certain app:
Line 137:		Line 137:
	withX ? true,		withX ? true,
	/. . ./		/. . ./
	}		}:

			stdenv.mkDerivation { /* . . . */}
	</syntaxHighlight>		</syntaxHighlight>

	Suppose that a new version of this package features a more agnostic GUI that can be linked to X11, GTK, Qt etc.		Suppose that a new version of this package features a more agnostic GUI that can be linked to X11, GTK, Qt etc.
	Because of it, `withX` is no longer a ~~well~~ descriptive name for this functionality.		Because of it, `withX` is no longer a descriptive name for this functionality.

	~~Renaming~~ the parameter is dangerous, because other functions that call this function expect this parameter.		However, renaming the parameter is dangerous, because other functions that call this function expect this parameter.
	~~This~~ problem becomes more pronounced when in conjunction with custom, third-party overlays.		The problem becomes more pronounced when in conjunction with custom, third-party overlays.

	The solution is, roughly, emit a warning about the old parameter being used, reporting the user to the new parameter:		The solution is, roughly, to emit a warning about the old parameter being used, reporting the user to the new parameter:

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">

AndersonTorres: new recipe

2024-07-27T15:56:09Z

new recipe

← Older revision		Revision as of 15:56, 27 July 2024
Line 126:		Line 126:
	</syntaxHighlight>		</syntaxHighlight>

			== Deprecating input parameters in mkDerivation-style packages ==

			Sometimes we want to rename an input parameter.

			E.G. an option `withX` that enables the X11 GUI for a certain app:

			<syntaxHighlight lang="nix">
			{
			/. . ./
			withX ? true,
			/. . ./
			}
			</syntaxHighlight>

			Suppose that a new version of this package features a more agnostic GUI that can be linked to X11, GTK, Qt etc.
			Because of it, `withX` is no longer a well descriptive name for this functionality.

			Renaming the parameter is dangerous, because other functions that call this function expect this parameter.
			This problem becomes more pronounced when in conjunction with custom, third-party overlays.

			The solution is, roughly, emit a warning about the old parameter being used, reporting the user to the new parameter:

			<syntaxHighlight lang="nix">
			{
			/. . ./
			withX ? null,
			withGui ?
			if (withX != null) then
			lib.warn "withX is deprecated and will be removed in the next release; use withGui instead." withX
			else
			true
			/. . ./
			}
			</syntaxHighlight>

	== Wrapping packages ==		== Wrapping packages ==

Mth at 10:53, 13 July 2024

2024-07-13T10:53:49Z

← Older revision		Revision as of 10:53, 13 July 2024
Line 4:		Line 4:

	=== Reclaim space on Nix install? ===		=== Reclaim space on Nix install? ===
			{{META Box\|TL&DR:\|<code>nix-collect-garbage --delete-older-than 7d</code>}}

	==== Remove old generations ====		==== Remove old generations ====

Mth at 10:43, 13 July 2024

2024-07-13T10:43:57Z

← Older revision		Revision as of 10:43, 13 July 2024
Line 7:		Line 7:
	==== Remove old generations ====		==== Remove old generations ====

	When you make changes to your system, Nix creates a new system [[generation]]. All of the changes to the system since the previous generation are stored there. Old generations can add up and will not be removed automatically by default. You can see your generations with:		When you make changes to your system, Nix creates a new system [[generation]]. All of the changes to the system since the previous generation are stored there. Old generations can add up and will not be removed automatically by default. You can see your saved system generations with:

	<~~syntaxHighlight~~ lang=shell>		<syntaxhighlight lang="shell-session">
	$ nix-env --list-generations		# nix-env --profile /nix/var/nix/profiles/system --list-generations
	</~~syntaxHighlight~~>		</syntaxhighlight>

	To keep just your current generation and the two older than it:		To keep just your current generation and the two older than it:

	<~~syntaxHighlight~~ lang=shell>		<syntaxhighlight lang="shell-session">
	$ nix-env --delete-generations +3		# nix-env --profile … --delete-generations +3
	</~~syntaxHighlight~~>		</syntaxhighlight>

	To remove all but your current generation:		To remove all but your current generation:

	<~~syntaxHighlight~~ lang=shell>		<syntaxhighlight lang="shell-session">
	$ nix-env --delete-generations old		# nix-env --profile … --delete-generations old
	</~~syntaxHighlight~~>		</syntaxhighlight>Apart from the system profile in <code>/nix/var/nix/profiles/system</code>, every user has profiles for their user environment and channels. The operations above may be repeated for those profiles. By default, they are located at <code>~/.nix-profile</code> and <code>~/.nix-defexpr/channels</code>. For more information on profile locations, see [https://nix.dev/manual/nix/stable/command-ref/nix-env#files Nix Manual - nix-env - Files].

	===== Generation trimmer script =====		===== Generation trimmer script =====