Packaging/Quirks and Caveats: Difference between revisions

(12 intermediate revisions by 6 users not shown)

Line 8:

== Build software with Autotools ==

Add <code>autoreconfHook</code> to <code>~~buildInputs~~</code> to automatically build software which uses <code>automake</code> and <code>autoconf</code>:

Add <code>autoreconfHook</code> to <code>nativeBuildInputs</code> to automatically build software which uses <code>automake</code> and <code>autoconf</code>:

~~buildInputs~~ = [ ... autoreconfHook ];

nativeBuildInputs = [ ... autoreconfHook ];

</syntaxhighlight>

Examples in nixpkgs: * [https://github.com/NixOS/nixpkgs/blob/f4c253ff2f68fbe3e302f944e8347233d9dc8c9d/pkgs/tools/networking/samplicator/default.nix samplicator]

Examples in nixpkgs:

* [https://github.com/NixOS/nixpkgs/blob/f4c253ff2f68fbe3e302f944e8347233d9dc8c9d/pkgs/tools/networking/samplicator/default.nix samplicator]

== Configure Scripts that are using pkg-config ==

Some configure scripts are using <code>pkg-config</code> to determine the location of libraries and headers. Nixpkgs supports this by adding <code>pkg-config</code> to <code>nativeBuildInputs</code>

nativeBuildInputs = [ ... pkg-config ];

</syntaxhighlight>

Examples in nixpkgs:

* [https://github.com/NixOS/nixpkgs/blob/96d41e393da3ca27fbcc7c82b7221a5c923460c0/pkgs/development/libraries/libmms/default.nix#L13 libmms]

One typical error when <code>pkg-config</code> is required but not in the <code>nativeBuildInputs</code> is the following during the configure phase:

./configure: line 20832: syntax error near unexpected token `nss,'

./configure: line 20832: ` PKG_CHECK_MODULES(nss, nss)'

</syntaxhighlight>

== Package simple python scripts ==

For scripts like a single Python file, it is not necessary to specify <code>src</code> in <code>mkDerivation</code>. When you want to use <code>buildPythonPackage</code> the sources need to provide a <code>setup.py</code> file which also is overkill for a lot of projects. The default <code>mkDerivation</code> will attempt to unpack your source code. This can be prevented ~~that~~ by applying <code>unpackPhase = ":";</code> (<code>:</code> is a no-op in shell scripts).

For scripts like a single Python file, it is not necessary to specify <code>src</code> in <code>mkDerivation</code>. When you want to use <code>buildPythonPackage</code> the sources need to provide a <code>setup.py</code> file which also is overkill for a lot of projects. The default <code>mkDerivation</code> will attempt to unpack your source code. This can be prevented by applying <code>unpackPhase = ":";</code> (<code>:</code> is a no-op in shell scripts).

<syntaxhighlight lang="nix">myscript-package = pkgs.stdenv.mkDerivation {

Line 37:

Line 52:

Source: [http://stackoverflow.com/questions/43837691/how-to-package-a-single-python-script-with-nix/43837692#43837692 nh2 @ StackOverflow]

A more lightweight alternative is to use <code>nix-shell</code> in the shebang line as described in this [http://iam.travishartwell.net/2015/06/17/nix-shell-shebang/ blog post]. This causes the expression to be evaluated and built every time the script is run; this means that the dependencies will always be kept up to date, but since nix-shell only creates a temporary GC root the dependencies may be removed by a garbage collection, so this approach is not advisable for users who don't have an internet connection available all the time.

A more lightweight alternative is to use <code>nix-shell</code> in the shebang line as described in this [https://web.archive.org/web/20230330010914/http://iam.travishartwell.net/2015/06/17/nix-shell-shebang/ blog post]. This causes the expression to be evaluated and built every time the script is run; this means that the dependencies will always be kept up to date, but since nix-shell only creates a temporary GC root the dependencies may be removed by a garbage collection, so this approach is not advisable for users who don't have an internet connection available all the time.

== Caveats ==

Line 43:

Line 58:

After packaging software and successfully generating an executable some functions of the package might still not work. This is a collection of error and how to fix them:

=== GLib-GIO-Message: Using the 'memory' GSettings backend. Your settings will not be saved or shared with ===

Sometime the error mesage might be also:

=== GLib-GIO-~~Message~~: ~~Using~~ the ~~'memory' GSettings backend. Your settings will not be saved or shared with ===~~

GLib-GIO-ERROR **: No GSettings schemas are installed on the system

</syntaxHighlight>

Fixed by adding <code>wrapGAppsHook</code> to buildInputs:

~~buildInputs~~ = [ ... wrapGAppsHook ];

nativeBuildInputs = [ ... wrapGAppsHook ];

</syntaxHighlight>

Sample PR in nixpkgs:

* [https://github.com/NixOS/nixpkgs/pull/24617/files networkmanagerapplet]

=== Namespace Gdk not available ===

You will need <code>/nix/store/*-gtk+3-*/lib/girepository-1.0</code> in <code>GI_TYPELIB_PATH</code>.

@@ Line 8: / Line 8: @@
 == Build software with Autotools ==
-Add <code>autoreconfHook</code> to <code>buildInputs</code> to automatically build software which uses <code>automake</code> and <code>autoconf</code>:
+Add <code>autoreconfHook</code> to <code>nativeBuildInputs</code> to automatically build software which uses <code>automake</code> and <code>autoconf</code>:
 <syntaxhighlight lang="nix">
-buildInputs = [ ...  autoreconfHook ];
+nativeBuildInputs = [ ...  autoreconfHook ];
 </syntaxhighlight>
-Examples in nixpkgs: * [https://github.com/NixOS/nixpkgs/blob/f4c253ff2f68fbe3e302f944e8347233d9dc8c9d/pkgs/tools/networking/samplicator/default.nix samplicator]
+Examples in nixpkgs:
+* [https://github.com/NixOS/nixpkgs/blob/f4c253ff2f68fbe3e302f944e8347233d9dc8c9d/pkgs/tools/networking/samplicator/default.nix samplicator]
+== Configure Scripts that are using pkg-config ==
+Some configure scripts are using <code>pkg-config</code> to determine the location of libraries and headers. Nixpkgs supports this by adding <code>pkg-config</code> to <code>nativeBuildInputs</code>
+<syntaxhighlight lang="nix">
+nativeBuildInputs = [ ...  pkg-config ];
+</syntaxhighlight>
+Examples in nixpkgs:
+* [https://github.com/NixOS/nixpkgs/blob/96d41e393da3ca27fbcc7c82b7221a5c923460c0/pkgs/development/libraries/libmms/default.nix#L13 libmms]
+One typical error when <code>pkg-config</code> is required but not in the <code>nativeBuildInputs</code> is the following during the configure phase:
+<syntaxhighlight lang="shell">
+./configure: line 20832: syntax error near unexpected token `nss,'
+./configure: line 20832: `                      PKG_CHECK_MODULES(nss, nss)'
+</syntaxhighlight>
 == Package simple python scripts ==
-For scripts like a single Python file, it is not necessary to specify <code>src</code> in <code>mkDerivation</code>. When you want to use <code>buildPythonPackage</code> the sources need to provide a <code>setup.py</code> file which also is overkill for a lot of projects. The default <code>mkDerivation</code> will attempt to unpack your source code. This can be prevented that by applying <code>unpackPhase = ":";</code> (<code>:</code> is a no-op in shell scripts).
+For scripts like a single Python file, it is not necessary to specify <code>src</code> in <code>mkDerivation</code>. When you want to use <code>buildPythonPackage</code> the sources need to provide a <code>setup.py</code> file which also is overkill for a lot of projects. The default <code>mkDerivation</code> will attempt to unpack your source code. This can be prevented by applying <code>unpackPhase = ":";</code> (<code>:</code> is a no-op in shell scripts).
 <syntaxhighlight lang="nix">myscript-package = pkgs.stdenv.mkDerivation {
@@ Line 37: / Line 52: @@
 Source: [http://stackoverflow.com/questions/43837691/how-to-package-a-single-python-script-with-nix/43837692#43837692 nh2 @ StackOverflow]
-A more lightweight alternative is to use <code>nix-shell</code> in the shebang line as described in this [http://iam.travishartwell.net/2015/06/17/nix-shell-shebang/ blog post]. This causes the expression to be evaluated and built every time the script is run; this means that the dependencies will always be kept up to date, but since nix-shell only creates a temporary GC root the dependencies may be removed by a garbage collection, so this approach is not advisable for users who don't have an internet connection available all the time.
+A more lightweight alternative is to use <code>nix-shell</code> in the shebang line as described in this [https://web.archive.org/web/20230330010914/http://iam.travishartwell.net/2015/06/17/nix-shell-shebang/ blog post]. This causes the expression to be evaluated and built every time the script is run; this means that the dependencies will always be kept up to date, but since nix-shell only creates a temporary GC root the dependencies may be removed by a garbage collection, so this approach is not advisable for users who don't have an internet connection available all the time.
 == Caveats ==
@@ Line 43: / Line 58: @@
 After packaging software and successfully generating an executable some functions of the package might still not work. This is a collection of error and how to fix them:
+=== GLib-GIO-Message: Using the 'memory' GSettings backend.  Your settings will not be saved or shared with ===
+Sometime the error mesage might be also:
-=== GLib-GIO-Message: Using the 'memory' GSettings backend.  Your settings will not be saved or shared with ===
+<syntaxHighlight lang="nix">
+GLib-GIO-ERROR **: No GSettings schemas are installed on the system
+</syntaxHighlight>
 Fixed by adding <code>wrapGAppsHook</code> to buildInputs:
 <syntaxHighlight lang="nix">
-buildInputs = [ ...  wrapGAppsHook ];
+nativeBuildInputs = [ ...  wrapGAppsHook ];
 </syntaxHighlight>
 Sample PR in nixpkgs:
 * [https://github.com/NixOS/nixpkgs/pull/24617/files networkmanagerapplet]
+=== Namespace Gdk not available ===
+You will need <code>/nix/store/*-gtk+3-*/lib/girepository-1.0</code> in <code>GI_TYPELIB_PATH</code>.
+Similar solution as above, solved by:
+<syntaxHighlight lang=nix>
+  nativeBuildInputs = [ ...  wrapGAppsHook ];
+  buildInputs = [ gtk3 ];
+</syntaxHighlight>
 === ImportError: libstdc++.so.6: cannot open shared object file: No such file ===
@@ Line 58: / Line 87: @@
 This can happen when importing python libraries:
 Solution: add <code>${stdenv.cc.cc.lib}/lib/libstdc++.so.6</code> to the <code>LD_LIBRARY_PATH</code>.
+A sample <code>shell.nix</code>:
+<syntaxHighlight lang="nix">
+{ pkgs ? (import <nixpkgs> {}).pkgs }:
+with pkgs;
+mkShell {
+  buildInputs = [
+    python3Packages.virtualenv # run virtualenv .
+    python3Packages.pyqt5 # avoid installing via pip
+    python3Packages.pyusb # fixes the pyusb 'No backend available' when installed directly via pip
+  ];
+  shellHook = ''
+    # fixes libstdc++ issues and libgl.so issues
+    LD_LIBRARY_PATH=${stdenv.cc.cc.lib}/lib/:/run/opengl-driver/lib/
+    # fixes xcb issues :
+    QT_PLUGIN_PATH=${qt5.qtbase}/${qt5.qtbase.qtPluginPrefix}
+  '';
+}
+</syntaxHighlight>
 === Test cannot access <code>/etc/protocols</code>, <code>/etc/services</code> or expects a special <code>/etc/passwd</code> when building in sandbox ===
@@ Line 72: / Line 120: @@
 </syntaxHighlight>
-[[Category:Guide]]
+[[Category:Cookbook]]