Nixpkgs/Create and debug packages - Revision history

Pandapip1: Use blobless clone instead of shallow clone for nixpkgs clone

2026-02-23T19:33:16Z

Use blobless clone instead of shallow clone for nixpkgs clone

← Older revision		Revision as of 19:33, 23 February 2026
Line 16:		Line 16:

	# Fork the repo (e.g. click the fork button on https://github.com/nixos/nixpkgs).		# Fork the repo (e.g. click the fork button on https://github.com/nixos/nixpkgs).
	# Clone your fork <code~~><nowiki~~>git clone --~~depth 1~~ https://github.com/YOURNAME/nixpkgs.git</nowiki></code>		# Clone your fork <code>git clone --filter=blob:none <nowiki>https://github.com/YOURNAME/nixpkgs.git</nowiki></code>
	# Hack hack hack		# Hack hack hack
	# Push your changes to your fork		# Push your changes to your fork

Das-g: /* Using nix-shell for package development */ Improve grammar in note about preConfigurePhase

2025-04-10T12:24:06Z

Using nix-shell for package development: Improve grammar in note about preConfigurePhase

← Older revision		Revision as of 12:24, 10 April 2025
Line 249:		Line 249:
	</syntaxhighlight>		</syntaxhighlight>

	{{Note\|~~you~~ do not need to run $preConfigurePhase explicitly as it is run, when running configurePhase ~~already~~.}}		{{Note\|You do not need to run $preConfigurePhase explicitly, as it will already be run implicitly when running configurePhase.}}

	To list all functions which are declared in '''set''':		To list all functions which are declared in '''set''':

Artturin: /* Adding custom libraries and dependencies to a package */ work ootb

2024-10-29T19:00:01Z

Adding custom libraries and dependencies to a package: work ootb

← Older revision		Revision as of 19:00, 29 October 2024
Line 396:		Line 396:
	}:		}:
	stdenv.mkDerivation {		stdenv.mkDerivation {
			pname = "something";
			version = "1";
	strictDeps = true;		strictDeps = true;
	# host/target agnostic programs		# host/target agnostic programs

Artturin: /* Adding custom libraries and dependencies to a package */ Cross improvement

2024-10-29T18:59:09Z

Adding custom libraries and dependencies to a package: Cross improvement

← Older revision		Revision as of 18:59, 29 October 2024
Line 379:		Line 379:
	Your program to test the library:		Your program to test the library:
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	{ pkgs ? import <nixpkgs> {~~} }~~:		{
	~~with pkgs;~~		pkgs ? import <nixpkgs> {
	~~let yourLibraryName~~ = callPackage /~~path/to/~~library~~/derivation~~.nix {};		overlays = [
	in		(final: prev: {
	stdenv.mkDerivation {		my-library = prev.callPackage ./my-library.nix { };
	~~nativeBuildInputs~~ = [		})
	yourLibraryName /* Add here if needed at build time */		];
	~~/* Add other dependencies if needed */~~		},
	]		}:
	~~buildInputs~~ = [		pkgs.callPackage (
	~~yourLibraryName /* Add here if needed at runtime */~~		{
	~~/* Add other dependencies if needed */~~		stdenv,
	]		hello,
	~~/* Add the other stuff as needed */~~		pkg-config,
	}		my-library,
			}:
			stdenv.mkDerivation {
			strictDeps = true;
			# host/target agnostic programs
			depsBuildBuild = [
			hello
			];
			# compilers & linkers & dependecy finding programs
			nativeBuildInputs = [
			pkg-config
			];
			# libraries
			buildInputs = [
			my-library
			];
			}
			) { }
	</syntaxhighlight>		</syntaxhighlight>

Voklen: 'show-derivation' is a deprecated alias for 'derivation show'

2024-08-27T11:09:22Z

'show-derivation' is a deprecated alias for 'derivation show'

← Older revision		Revision as of 11:09, 27 August 2024
Line 197:		Line 197:
	You would have seen the dependencies downloading, but the ''bc-build'' directory remains empty. The build system would next invoke a builder with some arguments. You can obtain the exact name of the builder (usually '''bash''') and the arguments '''args''' of the builder (typically a shell script) by checking the corresponding value in:		You would have seen the dependencies downloading, but the ''bc-build'' directory remains empty. The build system would next invoke a builder with some arguments. You can obtain the exact name of the builder (usually '''bash''') and the arguments '''args''' of the builder (typically a shell script) by checking the corresponding value in:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	$ nix show~~-derivation~~ $(nix-instantiate .)		$ nix derivation show $(nix-instantiate .)
	</syntaxhighlight>		</syntaxhighlight>

Tomodachi94: ryantm link -> canonical Nixpkgs manual

2024-06-21T06:46:17Z

ryantm link -> canonical Nixpkgs manual

← Older revision		Revision as of 06:46, 21 June 2024
Line 37:		Line 37:
	# At the top of the derivation, temporarily add <code>with import <nixpkgs> {};</code>. For now, don't worry too much about declaring every dependency as a parameter<!-- TODO clarify. "parameter of the default build function"? -->, to save time.		# At the top of the derivation, temporarily add <code>with import <nixpkgs> {};</code>. For now, don't worry too much about declaring every dependency as a parameter<!-- TODO clarify. "parameter of the default build function"? -->, to save time.
	# Build the package with <code>nix-build</code>. Iterate on tweaking the derivation and rebuilding until it succeeds.		# Build the package with <code>nix-build</code>. Iterate on tweaking the derivation and rebuilding until it succeeds.
	# For large projects with long compile times, you can use <code>nix-shell</code> instead to [https://~~ryantm~~.~~github.io~~/nixpkgs/~~stdenv/stdenv~~/#sec-building-stdenv-package-in-nix-shell run the individual phases].		# For large projects with long compile times, you can use <code>nix-shell</code> instead to [https://nixos.org/manual/nixpkgs/stable/#sec-building-stdenv-package-in-nix-shell run the individual phases].
	# At this stage, you may encounter some build quirks of the project. Compile-time errors will hopefully explain what you're missing. For example [https://github.com/NixOS/nixpkgs/blob/643ce4bd0f057bc0b90f0faebeb83a3b14f01674/pkgs/tools/package-management/micromamba/default.nix#L6-L10 micromamba needs a specialized build of libsolv].		# At this stage, you may encounter some build quirks of the project. Compile-time errors will hopefully explain what you're missing. For example [https://github.com/NixOS/nixpkgs/blob/643ce4bd0f057bc0b90f0faebeb83a3b14f01674/pkgs/tools/package-management/micromamba/default.nix#L6-L10 micromamba needs a specialized build of libsolv].
	# Read on below for further steps.		# Read on below for further steps.

0x4A6F: Use official formatter

2024-05-14T17:42:58Z

Use official formatter

← Older revision		Revision as of 17:42, 14 May 2024
Line 442:		Line 442:
	</syntaxhighlight>		</syntaxhighlight>

	== Formatting Packages with ~~nixpkgs-fmt~~ ==		== Formatting Packages with nixfmt ==
	It is "good practice" to format packages in a way that following changed will create as minimal diffs as possible. The formatter [https://github.com/~~nix-community~~/~~nixpkgs-fmt nixpkgs-fmt~~] can be used for that.		It is "good practice" to format packages in a way that following changed will create as minimal diffs as possible. The formatter [https://github.com/NixOS/nixfmt nixfmt] can be used for that.
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	~~nixpkgs~~-~~fmt~~ path/to/default.nix		nix-shell -p nixfmt-rfc-style --run 'nixfmt path/to/default.nix'
	</syntaxhighlight>		</syntaxhighlight>

imported>Jmarmstrong1207: Change method to run specific phase. runPhase was added and easier to use

2024-02-29T01:34:44Z

Change method to run specific phase. runPhase was added and easier to use

← Older revision		Revision as of 01:34, 29 February 2024
Line 222:		Line 222:
	</syntaxhighlight>		</syntaxhighlight>

	To only run some specific phases:		To only run some specific phases, use runPhase:

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	$ ~~phases="buildPhase checkPhase" genericBuild~~		# Syntax: runPhase phase
			$ runPhase unpackPhase
	</syntaxhighlight>		</syntaxhighlight>

imported>Jmarmstrong1207: Add == Adding custom libraries and dependencies to a package == section

2024-02-28T21:43:06Z

Add == Adding custom libraries and dependencies to a package == section

← Older revision		Revision as of 21:43, 28 February 2024
Line 370:		Line 370:

	Tip: A git repository can be used for snapshotting attempts at building the package. This also makes it easy to generate patches, should you need to.		Tip: A git repository can be used for snapshotting attempts at building the package. This also makes it easy to generate patches, should you need to.

			== Adding custom libraries and dependencies to a package ==
			If you are packaging a dependency, such as a library used by applications for them to compile their code, you might have found you'd like to test if the derivation file installs correctly and can be used by other software.

			In order to do this, you'll need to make a simple program that references the library, make a derivation for this program, then add the dependency. For example:

			Your program to test the library:
			<syntaxhighlight lang="nix">
			{ pkgs ? import <nixpkgs> {} }:
			with pkgs;
			let yourLibraryName = callPackage /path/to/library/derivation.nix {};
			in
			stdenv.mkDerivation {
			nativeBuildInputs = [
			yourLibraryName /* Add here if needed at build time */
			/* Add other dependencies if needed */
			]
			buildInputs = [
			yourLibraryName /* Add here if needed at runtime */
			/* Add other dependencies if needed */
			]
			/* Add the other stuff as needed */
			}
			</syntaxhighlight>


	== nix channels ==		== nix channels ==

imported>Cpick: Remove `source $stdenv/setup` since `nix-shell` runs it automatically and redundant runs can duplicate hooks

2024-01-19T22:17:32Z

Remove `source $stdenv/setup` since `nix-shell` runs it automatically and redundant runs can duplicate hooks

← Older revision		Revision as of 22:17, 19 January 2024
Line 216:		Line 216:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	$ export out=~/tmpdev/bc-build/out		$ export out=~/tmpdev/bc-build/out
	~~$ source $stdenv/setup~~
	$ set -x # Optional: it prints all commands, can be practical to debug		$ set -x # Optional: it prints all commands, can be practical to debug
	$ set +e # Optional: do not quit the shell on simple errors, Ctrl-C,...		$ set +e # Optional: do not quit the shell on simple errors, Ctrl-C,...