Packaging/Tutorial - Revision history

Arminius-smh: fix formatting

2024-10-04T09:39:31Z

fix formatting

← Older revision		Revision as of 09:39, 4 October 2024
Line 6:		Line 6:


	~~===== NOTE 0: ===== If you have time, read [https://unix.stackexchange.com/questions/717168/how-to-package-my-software-in-nix-or-write-my-own-package-derivation-for-nixpkgs this tutorial] first~~

	~~===== NOTE1~~: ~~=====~~ If you have time, [https://~~nixos~~.~~org~~/~~nixos~~/nix-~~pills/ read Nix Pills~~] first		NOTE 0: If you have time, read [https://unix.stackexchange.com/questions/717168/how-to-package-my-software-in-nix-or-write-my-own-package-derivation-for-nixpkgs this tutorial] first

	~~===== NOTE2~~: ~~=====~~ If you have ~~even more~~ time, [https://nixos.org/~~nix/manual~~/~~#chap-writing-~~nix-~~expressions~~ read Nix ~~manual~~] ~~to get familiar with Nix syntax~~		NOTE 1: If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first

	~~===== NOTE3~~: ~~=====~~ If you definitely have lots of time, then [https://nixos.org/nixpkgs/manual read Nixpkgs manual]		NOTE 2: If you have even more time, [https://nixos.org/nix/manual/#chap-writing-nix-expressions read Nix manual] to get familiar with Nix syntax

			NOTE 3: If you definitely have lots of time, then [https://nixos.org/nixpkgs/manual read Nixpkgs manual]

	<ol style="list-style-type: decimal;">		<ol style="list-style-type: decimal;">

Arminius-smh: make links clickable

2024-10-04T09:38:12Z

make links clickable

← Older revision		Revision as of 09:38, 4 October 2024
Line 6:		Line 6:


	===== NOTE 0: If you have time, read [https://unix.stackexchange.com/questions/717168/how-to-package-my-software-in-nix-or-write-my-own-package-derivation-for-nixpkgs this tutorial] first ~~=====~~		===== NOTE 0: ===== If you have time, read [https://unix.stackexchange.com/questions/717168/how-to-package-my-software-in-nix-or-write-my-own-package-derivation-for-nixpkgs this tutorial] first
	~~===== NOTE1: If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first =====~~

	===== ~~NOTE2~~: If you have ~~even more~~ time, [https://nixos.org/~~nix/manual~~/~~#chap-writing-~~nix-~~expressions~~ read Nix ~~manual~~] ~~to get familiar with Nix syntax =====~~		===== NOTE1: ===== If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first

	===== NOTE3: If you definitely have lots of time, then [https://nixos.org/nixpkgs/manual read Nixpkgs manual] ~~=====~~		===== NOTE2: ===== If you have even more time, [https://nixos.org/nix/manual/#chap-writing-nix-expressions read Nix manual] to get familiar with Nix syntax

			===== NOTE3: ===== If you definitely have lots of time, then [https://nixos.org/nixpkgs/manual read Nixpkgs manual]

	<ol style="list-style-type: decimal;">		<ol style="list-style-type: decimal;">

imported>Jmarmstrong1207: Add tip about the "Create and debug packages" page existing, and that there is a discussion whether to deprecate this one.

2024-02-28T21:54:26Z

Add tip about the "Create and debug packages" page existing, and that there is a discussion whether to deprecate this one.

← Older revision		Revision as of 21:54, 28 February 2024
Line 1:		Line 1:
			{{ outdated \| This page has duplicate info from [[Create and debug nix packages\|with this other wiki page here]]. That page has much more info that might be of more help for you. This page currently has a discussion if it should be deprecated, but at the meantime it still might be useful until a decision is made to migrate over. }}

	If you are a new Nix adept and want to package some new software, you will benefit from reading existing Nix package descriptions. The more you read, the faster you'll be able to build your package. I've even based a "Generic Algorithm on Doing Packaging Using Existing Knowledge" on this fact.		If you are a new Nix adept and want to package some new software, you will benefit from reading existing Nix package descriptions. The more you read, the faster you'll be able to build your package. I've even based a "Generic Algorithm on Doing Packaging Using Existing Knowledge" on this fact.

imported>Poelzi: add breakpointhook note

2024-02-17T12:03:49Z

add breakpointhook note

← Older revision		Revision as of 12:03, 17 February 2024
Line 28:		Line 28:

	<p>It most likely will fail.</p>		<p>It most likely will fail.</p>

			<p>NOTE: You can use the [https://nixos.org/manual/nixpkgs/stable/#breakpointhook breakpointHook] to attach into the build environment when an error happens.</p>

	</li></ol>		</li></ol>

imported>Tobias.bora at 22:15, 9 December 2022

2022-12-09T22:15:06Z

← Older revision		Revision as of 22:15, 9 December 2022
Line 3:		Line 3:
	The nixpkgs manual describes the [https://nixos.org/nixpkgs/manual/#chap-quick-start standard workflow to adding packages to nixpkgs]. Be sure to read this one first.		The nixpkgs manual describes the [https://nixos.org/nixpkgs/manual/#chap-quick-start standard workflow to adding packages to nixpkgs]. Be sure to read this one first.


			===== NOTE 0: If you have time, read [https://unix.stackexchange.com/questions/717168/how-to-package-my-software-in-nix-or-write-my-own-package-derivation-for-nixpkgs this tutorial] first =====
	===== NOTE1: If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first =====		===== NOTE1: If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first =====

imported>TheKK: Update path to cd after unpack phase

2021-04-20T05:08:01Z

Update path to cd after unpack phase

← Older revision		Revision as of 05:08, 20 April 2021
Line 17:		Line 17:
	<syntaxhighlight lang="console">		<syntaxhighlight lang="console">
	$ unpackPhase		$ unpackPhase
	$ cd ~~DIR_AFTER_UNPACK~~		$ cd $sourceRoot # $sourceRoot is created in unpack phase, see https://nixos.org/manual/nixpkgs/stable/#ssec-unpack-phase for details.
	$ patchPhase		$ patchPhase
	$ configurePhase		$ configurePhase

imported>Makefu: add link to nixpkgs manual

2020-07-27T11:57:51Z

add link to nixpkgs manual

← Older revision		Revision as of 11:57, 27 July 2020
Line 1:		Line 1:
	If you are a new Nix adept and want to package some new software, you will benefit from reading existing Nix package descriptions. The more you read, the faster you'll be able to build your package. I've even based a "Generic Algorithm on Doing Packaging Using Existing Knowledge" on this fact.		If you are a new Nix adept and want to package some new software, you will benefit from reading existing Nix package descriptions. The more you read, the faster you'll be able to build your package. I've even based a "Generic Algorithm on Doing Packaging Using Existing Knowledge" on this fact.

			The nixpkgs manual describes the [https://nixos.org/nixpkgs/manual/#chap-quick-start standard workflow to adding packages to nixpkgs]. Be sure to read this one first.

	===== NOTE1: If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first =====		===== NOTE1: If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first =====

imported>Bcaccia: grammar fixes

2020-01-15T12:17:26Z

grammar fixes

← Older revision		Revision as of 12:17, 15 January 2020
Line 1:		Line 1:
	If you are a new Nix adept and want to package some new software, you will benefit from reading existing Nix package descriptions. The more you read, the faster you'll do your package. I've even based a "Generic Algorithm on Doing Packaging Using Existing Knowledge" on this fact.		If you are a new Nix adept and want to package some new software, you will benefit from reading existing Nix package descriptions. The more you read, the faster you'll be able to build your package. I've even based a "Generic Algorithm on Doing Packaging Using Existing Knowledge" on this fact.

	===== NOTE1: If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first =====		===== NOTE1: If you have time, [https://nixos.org/nixos/nix-pills/ read Nix Pills] first =====

imported>Bcaccia: minor grammar corrections

2020-01-15T12:16:19Z

minor grammar corrections

imported>Akavel: fix indentation of lists

2018-08-12T22:06:03Z

fix indentation of lists

← Older revision		Revision as of 22:06, 12 August 2018
Line 19:		Line 19:
	$ configurePhase		$ configurePhase
	$ buildPhase</syntaxhighlight>		$ buildPhase</syntaxhighlight>
	<p>(visit [https://nixos.org/nixpkgs/manual/#sec-stdenv-phases stdenv-phases] chapter to learn more about phases)</p~~></li></ol~~>		<p>(visit [https://nixos.org/nixpkgs/manual/#sec-stdenv-phases stdenv-phases] chapter to learn more about phases)</p>

	You may need to run <syntaxhighlight lang="console" inline>$ eval "$configurePhase"</syntaxhighlight> sometimes if build expression overrides that phase.		<p>You may need to run <syntaxhighlight lang="console" inline>$ eval "$configurePhase"</syntaxhighlight> sometimes if build expression overrides that phase.</p>

	It most likely will fail.		<p>It most likely will fail.</p>
			</li></ol>

	<ol start="6" style="list-style-type: decimal;">		<ol start="6" style="list-style-type: decimal;">
	<li>Try to find failure category. It may be headers not found, library not found, executable not found, compiler not found, wrong build system, empty result, and many many more... But solutions to these problems are a bit more controllable:~~</li></ol>~~		<li>Try to find failure category. It may be headers not found, library not found, executable not found, compiler not found, wrong build system, empty result, and many many more... But solutions to these problems are a bit more controllable:

	~~<ul>~~		<ol style="list-style-type: lower-alpha;">
	~~<li>~~<ol style="list-style-type: lower-alpha;">		<li><code>buildInput</code> dependency missing</li>
	<li><code>buildInput</code> dependency missing</li~~></ol>~~		<li>source requires patching</li>
	~~</li>~~		<li>you should enter a subdir first</li>
	~~<li><ol start="2" style="list-style-type: lower-alpha;"~~>		<li>you should specify correct build parameters</li>
	<li>source requires patching~~</li></ol>~~		<li><code>patchShebangs</code> should be run first</li>
	</li>		<li>....</li>
	~~<li><ol start="3" style="list-style-type: lower-alpha;"~~>		</ol>
	<li>you should enter a subdir first~~</li></ol>~~
	</li>
	~~<li><ol start="4" style="list-style-type: lower-alpha;"~~>
	<li>you should specify correct build parameters~~</li></ol>~~
	</li>
	~~<li><ol start="5" style="list-style-type: lower-alpha;"~~>
	<li><code>patchShebangs</code> should be run first~~</li></ol>~~
	</li>
	<li>....</li></ul>

	Don't hesitate to learn from other package manager expressions, like AUR.		Don't hesitate to learn from other package manager expressions, like AUR.
			</li>

	~~<ol start="7" style="list-style-type: decimal;">~~
	<li><p>Apply a fix, [https://unix.stackexchange.com/questions/191885/quickly-reload-nix-expression-in-nix-shell exit nix-shell and enter it again]. Do steps 6-7 while there are problems.</p></li>		<li><p>Apply a fix, [https://unix.stackexchange.com/questions/191885/quickly-reload-nix-expression-in-nix-shell exit nix-shell and enter it again]. Do steps 6-7 while there are problems.</p></li>
	<li><p>After you got <code>buildPhase</code> to pass and produce correct binaries/libraries, time to <code>installPhase</code>. There are two ways: either you do package developement under root and have write access to Nix store inside nix-shell, or you simply run <code>nix-build</code> on you expression, so Nix will perform it's <code>installPhase</code>.</p~~></li></ol~~>		<li><p>After you got <code>buildPhase</code> to pass and produce correct binaries/libraries, time to <code>installPhase</code>. There are two ways: either you do package developement under root and have write access to Nix store inside nix-shell, or you simply run <code>nix-build</code> on you expression, so Nix will perform it's <code>installPhase</code>.</p>

	In first case, you can run		<p>In first case, you can run</p>

	<syntaxhighlight lang="console">		<syntaxhighlight lang="console">
	$ installPhase		$ installPhase
	</syntaxhighlight>		</syntaxhighlight>
	directly and examine using <code>tree $out</code> your package files. If something is missing or too many, fix the <code>postInstallPhase</code> or <code>preInstallPhase</code> or <code>installPhase</code> in your expression.
			<p>directly and examine using <code>tree $out</code> your package files. If something is missing or too many, fix the <code>postInstallPhase</code> or <code>preInstallPhase</code> or <code>installPhase</code> in your expression.</p>
			</li></ol>

	<ol start="9" style="list-style-type: decimal;">		<ol start="9" style="list-style-type: decimal;">
	<li><p>At this point you should have something that is both buildable and packageable. It still may not be runnable. Run the binaries to find out hidden dependencies, or patches required, or wrapper required, or patchelf required, or ... In general, I use Google and search in Nixpkgs issue tracker related problems.</p></li>		<li><p>At this point you should have something that is both buildable and packageable. It still may not be runnable. Run the binaries to find out hidden dependencies, or patches required, or wrapper required, or patchelf required, or ... In general, I use Google and search in Nixpkgs issue tracker related problems.</p></li>
	<li><p>After all the modifications, package should be buildable, runnable and should be self-sufficient. You may add <code>meta</code> section, but it isn't strictly required if you don't plan to publish your result.</p></li></ol>		<li><p>After all the modifications, package should be buildable, runnable and should be self-sufficient. You may add <code>meta</code> section, but it isn't strictly required if you don't plan to publish your result.</p></li></ol>

← Older revision		Revision as of 12:16, 15 January 2020
Line 9:		Line 9:
	<ol style="list-style-type: decimal;">		<ol style="list-style-type: decimal;">
	<li><p>Detect package building category. It may be something simple, that requires <code>gcc</code> and <code>make</code> only, or it may be a python library, or it may be a python application, or it may be [https://nixos.org/nixpkgs/manual/#chap-language-support any other LANGUAGE library/application], or it may be Qt applications, or it may be a Gnome application, or it does uses Mono/wine under a hood, or it vendors it's dependencies, or it is closed source/binary redistributable, or it uses CMake/any other alternative build tool, or it actually is a compiler, ... There are lots of such build categories, and it often isn't reflected at hierarchy level in Nixpkgs source tree.</p></li>		<li><p>Detect package building category. It may be something simple, that requires <code>gcc</code> and <code>make</code> only, or it may be a python library, or it may be a python application, or it may be [https://nixos.org/nixpkgs/manual/#chap-language-support any other LANGUAGE library/application], or it may be Qt applications, or it may be a Gnome application, or it does uses Mono/wine under a hood, or it vendors it's dependencies, or it is closed source/binary redistributable, or it uses CMake/any other alternative build tool, or it actually is a compiler, ... There are lots of such build categories, and it often isn't reflected at hierarchy level in Nixpkgs source tree.</p></li>
	<li><p>Try <code>grep</code>ping for building category keywords in Nixpkgs source. Find some example packages, review them and copy one of them as a new expression for your package. Too bad if you didn't find anything, then you should read Nix Pills first and skim through several package expressions in Nixpkgs source to be able to write own ~~one~~.</p></li>		<li><p>Try <code>grep</code>ping for building category keywords in Nixpkgs source. Find some example packages, review them and copy one of them as a new expression for your package. Too bad if you didn't find anything, then you should read Nix Pills first and skim through several package expressions in Nixpkgs source to be able to write your own.</p></li>
	<li><p>Build it without changes, just to test it builds</p></li>		<li><p>Build it without changes, just to test if it builds</p></li>
	<li><p>Modify source URL and sha256. Don't forget about that sha256 stuff! What I do, I change last symbol of sha256, let the package fail, and then paste correct sha256 again into expression. There are also various prefetch techniques</p></li>		<li><p>Modify source URL and sha256. Don't forget about that sha256 stuff! What I do, I change the last symbol of the sha256, let the package fail, and then paste the correct sha256 again into expression. There are also various prefetch techniques</p></li>
	<li><p>Run <code>nix-shell</code> on this expression (for example: <syntaxhighlight lang="bash" inline>nix-shell '<nixpkgs>' -A hello</syntaxhighlight>). Then run in order:</p>		<li><p>Run <code>nix-shell</code> on this expression (for example: <syntaxhighlight lang="bash" inline>nix-shell '<nixpkgs>' -A hello</syntaxhighlight>). Then run in order:</p>
	<syntaxhighlight lang="console">		<syntaxhighlight lang="console">
Line 21:		Line 21:
	<p>(visit [https://nixos.org/nixpkgs/manual/#sec-stdenv-phases stdenv-phases] chapter to learn more about phases)</p>		<p>(visit [https://nixos.org/nixpkgs/manual/#sec-stdenv-phases stdenv-phases] chapter to learn more about phases)</p>

	<p>You may need to run <syntaxhighlight lang="console" inline>$ eval "$configurePhase"</syntaxhighlight> sometimes if build expression overrides that phase.</p>		<p>You may need to run <syntaxhighlight lang="console" inline>$ eval "$configurePhase"</syntaxhighlight> sometimes if the build expression overrides that phase.</p>

	<p>It most likely will fail.</p>		<p>It most likely will fail.</p>
Line 27:		Line 27:

	<ol start="6" style="list-style-type: decimal;">		<ol start="6" style="list-style-type: decimal;">
	<li>Try to find failure category. It may be headers not found, library not found, executable not found, compiler not found, wrong build system, empty result, and many many more... But solutions to these problems are a bit more controllable:		<li>Try to find the failure category. It may be headers not found, library not found, executable not found, compiler not found, wrong build system, empty result, and many many more... But solutions to these problems are a bit more controllable:

	<ol style="list-style-type: lower-alpha;">		<ol style="list-style-type: lower-alpha;">
Line 42:		Line 42:

	<li><p>Apply a fix, [https://unix.stackexchange.com/questions/191885/quickly-reload-nix-expression-in-nix-shell exit nix-shell and enter it again]. Do steps 6-7 while there are problems.</p></li>		<li><p>Apply a fix, [https://unix.stackexchange.com/questions/191885/quickly-reload-nix-expression-in-nix-shell exit nix-shell and enter it again]. Do steps 6-7 while there are problems.</p></li>
	<li><p>After you ~~got~~ <code>buildPhase</code> to pass and produce correct binaries/libraries, time to <code>installPhase</code>. There are two ways: either you do package ~~developement~~ under root and have write access to Nix store inside nix-shell, or you simply run <code>nix-build</code> on you expression, so Nix will perform it's <code>installPhase</code>.</p>		<li><p>After you get the <code>buildPhase</code> to pass and produce correct binaries/libraries, it's time for the<code>installPhase</code>. There are two ways: either you do package development under root and have write access to Nix store inside nix-shell, or you simply run <code>nix-build</code> on you expression, so Nix will perform it's <code>installPhase</code>.</p>

	<p>In first case, you can run</p>		<p>In the first case, you can run</p>

	<syntaxhighlight lang="console">		<syntaxhighlight lang="console">
Line 50:		Line 50:
	</syntaxhighlight>		</syntaxhighlight>

	<p>directly and examine using <code>tree $out</code> your package files. If something is missing or too many, fix the <code>postInstallPhase</code> or <code>preInstallPhase</code> or <code>installPhase</code> in your expression.</p>		<p>directly and examine using <code>tree $out</code> in your package files. If something is missing or too many, fix the <code>postInstallPhase</code> or <code>preInstallPhase</code> or <code>installPhase</code> in your expression.</p>
	</li></ol>		</li></ol>

	<ol start="9" style="list-style-type: decimal;">		<ol start="9" style="list-style-type: decimal;">
	<li><p>At this point you should have something that is both buildable and packageable. It still may not be runnable. Run the binaries to find ~~out~~ hidden dependencies, or patches required, or wrapper required, or patchelf required, or ... In general, I use Google and search in Nixpkgs issue tracker related problems.</p></li>		<li><p>At this point you should have something that is both buildable and packageable. It still may not be runnable. Run the binaries to find any hidden dependencies, or patches required, or wrapper required, or patchelf required, or ... In general, I use Google and search in Nixpkgs issue tracker related problems.</p></li>
	<li><p>After all the modifications, package should be buildable, runnable and should be self-sufficient. You may add <code>meta</code> section, but it isn't strictly required if you don't plan to publish your result.</p></li></ol>		<li><p>After all the modifications, package should be buildable, runnable and should be self-sufficient. You may add <code>meta</code> section, but it isn't strictly required if you don't plan to publish your result.</p></li></ol>