Merge pull request #66147 from worldofpeace/meson-ninja-docs
doc/stdenv: document meson variables
This commit is contained in:
worldofpeace
GitHub
commit
4eaa8a815c
@ -485,10 +485,10 @@ nix-build <nixpkgs> --arg crossSystem '{ config = "<arch>-<os>
|
||||
<xref
|
||||
linkend="ssec-cross-dependency-categorization"/> are specified as
|
||||
lists of derivations given to <varname>mkDerivation</varname>, as
|
||||
documented in <xref linkend="ssec-stdenv-dependencies"/>. In short,
|
||||
each list of dependencies for "host → target" of "foo → bar" is called
|
||||
<varname>depsFooBar</varname>, with exceptions for backwards
|
||||
compatibility that <varname>depsBuildHost</varname> is instead called
|
||||
documented in <xref linkend="ssec-stdenv-dependencies"/>. In short, each
|
||||
list of dependencies for "host → target" of "foo → bar" is called
|
||||
<varname>depsFooBar</varname>, with exceptions for backwards compatibility
|
||||
that <varname>depsBuildHost</varname> is instead called
|
||||
<varname>nativeBuildInputs</varname> and <varname>depsHostTarget</varname>
|
||||
is instead called <varname>buildInputs</varname>. Nixpkgs is now structured
|
||||
so that each <varname>depsFooBar</varname> is automatically taken from
|
||||
@ -507,9 +507,8 @@ nix-build <nixpkgs> --arg crossSystem '{ config = "<arch>-<os>
|
||||
<varname>buildPackages</varname>, <varname>pkgs</varname>, and
|
||||
<varname>targetPackages</varname>. Those are now redefined as aliases to
|
||||
<varname>pkgsBuildHost</varname>, <varname>pkgsHostTarget</varname>, and
|
||||
<varname>pkgsTargetTarget</varname>. It is acceptable, even
|
||||
recommended, to use them for libraries to show that the host platform is
|
||||
irrelevant.
|
||||
<varname>pkgsTargetTarget</varname>. It is acceptable, even recommended, to
|
||||
use them for libraries to show that the host platform is irrelevant.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
@ -581,14 +580,15 @@ nix-build <nixpkgs> --arg crossSystem '{ config = "<arch>-<os>
|
||||
<varname>pkgsHostTarget</varname> refers to the current one, and
|
||||
<varname>pkgsTargetTarget</varname> refers to the next one. When there is
|
||||
no previous or next stage, they instead refer to the current stage. Note
|
||||
how all the invariants regarding the mapping between dependency and depending
|
||||
packages' build host and target platforms are preserved.
|
||||
how all the invariants regarding the mapping between dependency and
|
||||
depending packages' build host and target platforms are preserved.
|
||||
<varname>pkgsBuildTarget</varname> and <varname>pkgsHostHost</varname> are
|
||||
more complex in that the stage fitting the requirements isn't always a
|
||||
fixed chain of "prevs" and "nexts" away (modulo the "saturating"
|
||||
self-references at the ends). We just special case each instead. All the primary
|
||||
edges are implemented is in <filename>pkgs/stdenv/booter.nix</filename>,
|
||||
and secondarily aliases in <filename>pkgs/top-level/stage.nix</filename>.
|
||||
self-references at the ends). We just special case each instead. All the
|
||||
primary edges are implemented is in
|
||||
<filename>pkgs/stdenv/booter.nix</filename>, and secondarily aliases in
|
||||
<filename>pkgs/top-level/stage.nix</filename>.
|
||||
</para>
|
||||
|
||||
<note>
|
||||
@ -645,19 +645,19 @@ nix-build <nixpkgs> --arg crossSystem '{ config = "<arch>-<os>
|
||||
"infinite recursions" / cycles. When only package sets that don't mention
|
||||
target are used, the package set forms a directed acyclic graph. This
|
||||
means that all cycles that exist are confined to one stage. This means
|
||||
they are a lot smaller, and easier to follow in the code or a backtrace. It
|
||||
also means they are present in native and cross builds alike, and so more
|
||||
likely to be caught by CI and other users.
|
||||
they are a lot smaller, and easier to follow in the code or a backtrace.
|
||||
It also means they are present in native and cross builds alike, and so
|
||||
more likely to be caught by CI and other users.
|
||||
</para>
|
||||
<para>
|
||||
Thirdly, it is because everything target-mentioning only exists to
|
||||
accommodate compilers with lousy build systems that insist on the compiler
|
||||
itself and standard library being built together. Of course that is bad
|
||||
because bigger derivations means longer rebuilds. It is also problematic because
|
||||
it tends to make the standard libraries less like other libraries than
|
||||
they could be, complicating code and build systems alike. Because of the
|
||||
other problems, and because of these innate disadvantages, compilers ought
|
||||
to be packaged another way where possible.
|
||||
because bigger derivations means longer rebuilds. It is also problematic
|
||||
because it tends to make the standard libraries less like other libraries
|
||||
than they could be, complicating code and build systems alike. Because of
|
||||
the other problems, and because of these innate disadvantages, compilers
|
||||
ought to be packaged another way where possible.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
|
||||
@ -325,10 +325,9 @@ hello latest de2bf4786de6 About a minute ago 25.2MB
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Shell commands to run while building the final layer, without access
|
||||
to most of the layer contents. Changes to this layer are "on top"
|
||||
of all the other layers, so can create additional directories
|
||||
and files.
|
||||
Shell commands to run while building the final layer, without access to
|
||||
most of the layer contents. Changes to this layer are "on top" of all the
|
||||
other layers, so can create additional directories and files.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -493,28 +492,23 @@ pullImage {
|
||||
</calloutlist>
|
||||
|
||||
<para>
|
||||
<literal>nix-prefetch-docker</literal> command can be used to get required
|
||||
image parameters:
|
||||
|
||||
<literal>nix-prefetch-docker</literal> command can be used to get required
|
||||
image parameters:
|
||||
<screen>
|
||||
<prompt>$ </prompt>nix run nixpkgs.nix-prefetch-docker -c nix-prefetch-docker --image-name mysql --image-tag 5
|
||||
</screen>
|
||||
|
||||
Since a given <varname>imageName</varname> may transparently refer to a
|
||||
manifest list of images which support multiple architectures and/or
|
||||
operating systems, you can supply the <option>--os</option> and
|
||||
<option>--arch</option> arguments to specify exactly which image you want.
|
||||
By default it will match the OS and architecture of the host the command is
|
||||
run on.
|
||||
|
||||
Since a given <varname>imageName</varname> may transparently refer to a
|
||||
manifest list of images which support multiple architectures and/or
|
||||
operating systems, you can supply the <option>--os</option> and
|
||||
<option>--arch</option> arguments to specify exactly which image you want.
|
||||
By default it will match the OS and architecture of the host the command is
|
||||
run on.
|
||||
<screen>
|
||||
<prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --arch x86_64 --os linux
|
||||
</screen>
|
||||
|
||||
Desired image name and tag can be set using
|
||||
<option>--final-image-name</option> and <option>--final-image-tag</option>
|
||||
arguments:
|
||||
|
||||
Desired image name and tag can be set using
|
||||
<option>--final-image-name</option> and <option>--final-image-tag</option>
|
||||
arguments:
|
||||
<screen>
|
||||
<prompt>$ </prompt>nix-prefetch-docker --image-name mysql --image-tag 5 --final-image-name eu.gcr.io/my-project/mysql --final-image-tag prod
|
||||
</screen>
|
||||
|
||||
@ -51,10 +51,10 @@ buildContainer {
|
||||
<calloutlist>
|
||||
<callout arearefs='ex-ociTools-buildContainer-1'>
|
||||
<para>
|
||||
<varname>args</varname> specifies a set of arguments to run inside the container.
|
||||
This is the only required argument for <varname>buildContainer</varname>.
|
||||
All referenced packages inside the derivation will be made available
|
||||
inside the container
|
||||
<varname>args</varname> specifies a set of arguments to run inside the
|
||||
container. This is the only required argument for
|
||||
<varname>buildContainer</varname>. All referenced packages inside the
|
||||
derivation will be made available inside the container
|
||||
</para>
|
||||
</callout>
|
||||
<callout arearefs='ex-ociTools-buildContainer-2'>
|
||||
@ -66,8 +66,8 @@ buildContainer {
|
||||
</callout>
|
||||
<callout arearefs='ex-ociTools-buildContainer-3'>
|
||||
<para>
|
||||
<varname>readonly</varname> makes the container's rootfs read-only if it is set to true.
|
||||
The default value is false <literal>false</literal>.
|
||||
<varname>readonly</varname> makes the container's rootfs read-only if it
|
||||
is set to true. The default value is false <literal>false</literal>.
|
||||
</para>
|
||||
</callout>
|
||||
</calloutlist>
|
||||
|
||||
@ -5,26 +5,53 @@
|
||||
<title>Packaging GNOME applications</title>
|
||||
|
||||
<para>
|
||||
Programs in the GNOME universe are written in various languages but they all use GObject-based libraries like GLib, GTK or GStreamer. These libraries are often modular, relying on looking into certain directories to find their modules. However, due to Nix’s specific file system organization, this will fail without our intervention. Fortunately, the libraries usually allow overriding the directories through environment variables, either natively or thanks to a patch in nixpkgs. <link xlink:href="#fun-wrapProgram">Wrapping</link> the executables to ensure correct paths are available to the application constitutes a significant part of packaging a modern desktop application. In this section, we will describe various modules needed by such applications, environment variables needed to make the modules load, and finally a script that will do the work for us.
|
||||
Programs in the GNOME universe are written in various languages but they all
|
||||
use GObject-based libraries like GLib, GTK or GStreamer. These libraries are
|
||||
often modular, relying on looking into certain directories to find their
|
||||
modules. However, due to Nix’s specific file system organization, this
|
||||
will fail without our intervention. Fortunately, the libraries usually allow
|
||||
overriding the directories through environment variables, either natively or
|
||||
thanks to a patch in nixpkgs.
|
||||
<link xlink:href="#fun-wrapProgram">Wrapping</link> the executables to
|
||||
ensure correct paths are available to the application constitutes a
|
||||
significant part of packaging a modern desktop application. In this section,
|
||||
we will describe various modules needed by such applications, environment
|
||||
variables needed to make the modules load, and finally a script that will do
|
||||
the work for us.
|
||||
</para>
|
||||
|
||||
<section xml:id="ssec-gnome-settings">
|
||||
<title>Settings</title>
|
||||
|
||||
<para>
|
||||
<link xlink:href="https://developer.gnome.org/gio/stable/GSettings.html">GSettings</link> API is often used for storing settings. GSettings schemas are required, to know the type and other metadata of the stored values. GLib looks for <filename>glib-2.0/schemas/gschemas.compiled</filename> files inside the directories of <envar>XDG_DATA_DIRS</envar>.
|
||||
<link xlink:href="https://developer.gnome.org/gio/stable/GSettings.html">GSettings</link>
|
||||
API is often used for storing settings. GSettings schemas are required, to
|
||||
know the type and other metadata of the stored values. GLib looks for
|
||||
<filename>glib-2.0/schemas/gschemas.compiled</filename> files inside the
|
||||
directories of <envar>XDG_DATA_DIRS</envar>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
On Linux, GSettings API is implemented using <link xlink:href="https://wiki.gnome.org/Projects/dconf">dconf</link> backend. You will need to add <literal>dconf</literal> GIO module to <envar>GIO_EXTRA_MODULES</envar> variable, otherwise the <literal>memory</literal> backend will be used and the saved settings will not be persistent.
|
||||
On Linux, GSettings API is implemented using
|
||||
<link xlink:href="https://wiki.gnome.org/Projects/dconf">dconf</link>
|
||||
backend. You will need to add <literal>dconf</literal> GIO module to
|
||||
<envar>GIO_EXTRA_MODULES</envar> variable, otherwise the
|
||||
<literal>memory</literal> backend will be used and the saved settings will
|
||||
not be persistent.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Last you will need the dconf database D-Bus service itself. You can enable it using <option>programs.dconf.enable</option>.
|
||||
Last you will need the dconf database D-Bus service itself. You can enable
|
||||
it using <option>programs.dconf.enable</option>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Some applications will also require <package>gsettings-desktop-schemas</package> for things like reading proxy configuration or user interface customization. This dependency is often not mentioned by upstream, you should grep for <literal>org.gnome.desktop</literal> and <literal>org.gnome.system</literal> to see if the schemas are needed.
|
||||
Some applications will also require
|
||||
<package>gsettings-desktop-schemas</package> for things like reading proxy
|
||||
configuration or user interface customization. This dependency is often not
|
||||
mentioned by upstream, you should grep for
|
||||
<literal>org.gnome.desktop</literal> and
|
||||
<literal>org.gnome.system</literal> to see if the schemas are needed.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
@ -32,7 +59,16 @@
|
||||
<title>Icons</title>
|
||||
|
||||
<para>
|
||||
When an application uses icons, an icon theme should be available in <envar>XDG_DATA_DIRS</envar>. The package for the default, icon-less <link xlink:href="https://www.freedesktop.org/wiki/Software/icon-theme/">hicolor-icon-theme</link> contains <link linkend="ssec-gnome-hooks-hicolor-icon-theme">a setup hook</link> that will pick up icon themes from <literal>buildInputs</literal> and pass it to our wrapper. Unfortunately, relying on that would mean every user has to download the theme included in the package expression no matter their preference. For that reason, we leave the installation of icon theme on the user. If you use one of the desktop environments, you probably already have an icon theme installed.
|
||||
When an application uses icons, an icon theme should be available in
|
||||
<envar>XDG_DATA_DIRS</envar>. The package for the default, icon-less
|
||||
<link xlink:href="https://www.freedesktop.org/wiki/Software/icon-theme/">hicolor-icon-theme</link>
|
||||
contains <link linkend="ssec-gnome-hooks-hicolor-icon-theme">a setup
|
||||
hook</link> that will pick up icon themes from
|
||||
<literal>buildInputs</literal> and pass it to our wrapper. Unfortunately,
|
||||
relying on that would mean every user has to download the theme included in
|
||||
the package expression no matter their preference. For that reason, we
|
||||
leave the installation of icon theme on the user. If you use one of the
|
||||
desktop environments, you probably already have an icon theme installed.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
@ -40,7 +76,12 @@
|
||||
<title>GTK Themes</title>
|
||||
|
||||
<para>
|
||||
Previously, a GTK theme needed to be in <envar>XDG_DATA_DIRS</envar>. This is no longer necessary for most programs since GTK incorporated Adwaita theme. Some programs (for example, those designed for <link xlink:href="https://elementary.io/docs/human-interface-guidelines#human-interface-guidelines">elementary HIG</link>) might require a special theme like <package>pantheon.elementary-gtk-theme</package>.
|
||||
Previously, a GTK theme needed to be in <envar>XDG_DATA_DIRS</envar>. This
|
||||
is no longer necessary for most programs since GTK incorporated Adwaita
|
||||
theme. Some programs (for example, those designed for
|
||||
<link xlink:href="https://elementary.io/docs/human-interface-guidelines#human-interface-guidelines">elementary
|
||||
HIG</link>) might require a special theme like
|
||||
<package>pantheon.elementary-gtk-theme</package>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
@ -48,7 +89,10 @@
|
||||
<title>GObject introspection typelibs</title>
|
||||
|
||||
<para>
|
||||
<link xlink:href="https://wiki.gnome.org/Projects/GObjectIntrospection">GObject introspection</link> allows applications to use C libraries in other languages easily. It does this through <literal>typelib</literal> files searched in <envar>GI_TYPELIB_PATH</envar>.
|
||||
<link xlink:href="https://wiki.gnome.org/Projects/GObjectIntrospection">GObject
|
||||
introspection</link> allows applications to use C libraries in other
|
||||
languages easily. It does this through <literal>typelib</literal> files
|
||||
searched in <envar>GI_TYPELIB_PATH</envar>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
@ -56,7 +100,11 @@
|
||||
<title>Various plug-ins</title>
|
||||
|
||||
<para>
|
||||
If your application uses <link xlink:href="https://gstreamer.freedesktop.org/">GStreamer</link> or <link xlink:href="https://wiki.gnome.org/Projects/Grilo">Grilo</link>, you should set <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and <envar>GRL_PLUGIN_PATH</envar>, respectively.
|
||||
If your application uses
|
||||
<link xlink:href="https://gstreamer.freedesktop.org/">GStreamer</link> or
|
||||
<link xlink:href="https://wiki.gnome.org/Projects/Grilo">Grilo</link>, you
|
||||
should set <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and
|
||||
<envar>GRL_PLUGIN_PATH</envar>, respectively.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
@ -65,7 +113,8 @@
|
||||
<title>Onto <package>wrapGAppsHook</package></title>
|
||||
|
||||
<para>
|
||||
Given the requirements above, the package expression would become messy quickly:
|
||||
Given the requirements above, the package expression would become messy
|
||||
quickly:
|
||||
<programlisting>
|
||||
preFixup = ''
|
||||
for f in $(find $out/bin/ $out/libexec/ -type f -executable); do
|
||||
@ -79,48 +128,76 @@ preFixup = ''
|
||||
done
|
||||
'';
|
||||
</programlisting>
|
||||
Fortunately, there is <package>wrapGAppsHook</package>, that does the wrapping for us. In particular, it works in conjunction with other setup hooks that will populate the variable:
|
||||
Fortunately, there is <package>wrapGAppsHook</package>, that does the
|
||||
wrapping for us. In particular, it works in conjunction with other setup
|
||||
hooks that will populate the variable:
|
||||
<itemizedlist>
|
||||
<listitem xml:id="ssec-gnome-hooks-wrapgappshook">
|
||||
<para>
|
||||
<package>wrapGAppsHook</package> itself will add the package’s <filename>share</filename> directory to <envar>XDG_DATA_DIRS</envar>.
|
||||
<package>wrapGAppsHook</package> itself will add the package’s
|
||||
<filename>share</filename> directory to <envar>XDG_DATA_DIRS</envar>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem xml:id="ssec-gnome-hooks-glib">
|
||||
<para>
|
||||
<package>glib</package> setup hook will populate <envar>GSETTINGS_SCHEMAS_PATH</envar> and then <package>wrapGAppsHook</package> will prepend it to <envar>XDG_DATA_DIRS</envar>.
|
||||
<package>glib</package> setup hook will populate
|
||||
<envar>GSETTINGS_SCHEMAS_PATH</envar> and then
|
||||
<package>wrapGAppsHook</package> will prepend it to
|
||||
<envar>XDG_DATA_DIRS</envar>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem xml:id="ssec-gnome-hooks-dconf">
|
||||
<para>
|
||||
<package>gnome3.dconf.lib</package> is a dependency of <package>wrapGAppsHook</package>, which then also adds it to the <envar>GIO_EXTRA_MODULES</envar> variable.
|
||||
<package>gnome3.dconf.lib</package> is a dependency of
|
||||
<package>wrapGAppsHook</package>, which then also adds it to the
|
||||
<envar>GIO_EXTRA_MODULES</envar> variable.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem xml:id="ssec-gnome-hooks-hicolor-icon-theme">
|
||||
<para>
|
||||
<package>hicolor-icon-theme</package>’s setup hook will add icon themes to <envar>XDG_ICON_DIRS</envar> which is prepended to <envar>XDG_DATA_DIRS</envar> by <package>wrapGAppsHook</package>.
|
||||
<package>hicolor-icon-theme</package>’s setup hook will add icon themes
|
||||
to <envar>XDG_ICON_DIRS</envar> which is prepended to
|
||||
<envar>XDG_DATA_DIRS</envar> by <package>wrapGAppsHook</package>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem xml:id="ssec-gnome-hooks-gobject-introspection">
|
||||
<para>
|
||||
<package>gobject-introspection</package> setup hook populates <envar>GI_TYPELIB_PATH</envar> variable with <filename>lib/girepository-1.0</filename> directories of dependencies, which is then added to wrapper by <package>wrapGAppsHook</package>. It also adds <filename>share</filename> directories of dependencies to <envar>XDG_DATA_DIRS</envar>, which is intended to promote GIR files but it also <link xlink:href="https://github.com/NixOS/nixpkgs/issues/32790">pollutes the closures</link> of packages using <package>wrapGAppsHook</package>.
|
||||
<package>gobject-introspection</package> setup hook populates
|
||||
<envar>GI_TYPELIB_PATH</envar> variable with
|
||||
<filename>lib/girepository-1.0</filename> directories of dependencies,
|
||||
which is then added to wrapper by <package>wrapGAppsHook</package>. It
|
||||
also adds <filename>share</filename> directories of dependencies to
|
||||
<envar>XDG_DATA_DIRS</envar>, which is intended to promote GIR files but
|
||||
it also
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/32790">pollutes
|
||||
the closures</link> of packages using <package>wrapGAppsHook</package>.
|
||||
</para>
|
||||
<warning>
|
||||
<para>
|
||||
The setup hook <link xlink:href="https://github.com/NixOS/nixpkgs/issues/56943">currently</link> does not work in expressions with <literal>strictDeps</literal> enabled, like Python packages. In those cases, you will need to disable it with <code>strictDeps = false;</code>.
|
||||
The setup hook
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/issues/56943">currently</link>
|
||||
does not work in expressions with <literal>strictDeps</literal> enabled,
|
||||
like Python packages. In those cases, you will need to disable it with
|
||||
<code>strictDeps = false;</code>.
|
||||
</para>
|
||||
</warning>
|
||||
</listitem>
|
||||
<listitem xml:id="ssec-gnome-hooks-gst-grl-plugins">
|
||||
<para>
|
||||
Setup hooks of <package>gst_all_1.gstreamer</package> and <package>gnome3.grilo</package> will populate the <envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and <envar>GRL_PLUGIN_PATH</envar> variables, respectively, which will then be added to the wrapper by <literal>wrapGAppsHook</literal>.
|
||||
Setup hooks of <package>gst_all_1.gstreamer</package> and
|
||||
<package>gnome3.grilo</package> will populate the
|
||||
<envar>GST_PLUGIN_SYSTEM_PATH_1_0</envar> and
|
||||
<envar>GRL_PLUGIN_PATH</envar> variables, respectively, which will then
|
||||
be added to the wrapper by <literal>wrapGAppsHook</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You can also pass additional arguments to <literal>makeWrapper</literal> using <literal>gappsWrapperArgs</literal> in <literal>preFixup</literal> hook:
|
||||
You can also pass additional arguments to <literal>makeWrapper</literal>
|
||||
using <literal>gappsWrapperArgs</literal> in <literal>preFixup</literal>
|
||||
hook:
|
||||
<programlisting>
|
||||
preFixup = ''
|
||||
gappsWrapperArgs+=(
|
||||
@ -138,7 +215,13 @@ preFixup = ''
|
||||
<title>Updating GNOME packages</title>
|
||||
|
||||
<para>
|
||||
Most GNOME package offer <link linkend="var-passthru-updateScript"><literal>updateScript</literal></link>, it is therefore possible to update to latest source tarball by running <command>nix-shell maintainers/scripts/update.nix --argstr package gnome3.nautilus</command> or even en masse with <command>nix-shell maintainers/scripts/update.nix --argstr path gnome3</command>. Read the package’s <filename>NEWS</filename> file to see what changed.
|
||||
Most GNOME package offer
|
||||
<link linkend="var-passthru-updateScript"><literal>updateScript</literal></link>,
|
||||
it is therefore possible to update to latest source tarball by running
|
||||
<command>nix-shell maintainers/scripts/update.nix --argstr package
|
||||
gnome3.nautilus</command> or even en masse with <command>nix-shell
|
||||
maintainers/scripts/update.nix --argstr path gnome3</command>. Read the
|
||||
package’s <filename>NEWS</filename> file to see what changed.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
@ -152,7 +235,17 @@ preFixup = ''
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
There are no schemas avalable in <envar>XDG_DATA_DIRS</envar>. Temporarily add a random package containing schemas like <package>gsettings-desktop-schemas</package> to <literal>buildInputs</literal>. <link linkend="ssec-gnome-hooks-glib"><package>glib</package></link> and <link linkend="ssec-gnome-hooks-wrapgappshook"><package>wrapGAppsHook</package></link> setup hooks will take care of making the schemas available to application and you will see the actual missing schemas with the <link linkend="ssec-gnome-common-issues-missing-schema">next error</link>. Or you can try looking through the source code for the actual schemas used.
|
||||
There are no schemas avalable in <envar>XDG_DATA_DIRS</envar>.
|
||||
Temporarily add a random package containing schemas like
|
||||
<package>gsettings-desktop-schemas</package> to
|
||||
<literal>buildInputs</literal>.
|
||||
<link linkend="ssec-gnome-hooks-glib"><package>glib</package></link> and
|
||||
<link linkend="ssec-gnome-hooks-wrapgappshook"><package>wrapGAppsHook</package></link>
|
||||
setup hooks will take care of making the schemas available to application
|
||||
and you will see the actual missing schemas with the
|
||||
<link linkend="ssec-gnome-common-issues-missing-schema">next
|
||||
error</link>. Or you can try looking through the source code for the
|
||||
actual schemas used.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -162,7 +255,11 @@ preFixup = ''
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Package is missing some GSettings schemas. You can find out the package containing the schema with <command>nix-locate <replaceable>org.gnome.foo</replaceable>.gschema.xml</command> and let the hooks handle the wrapping as <link linkend="ssec-gnome-common-issues-no-schemas">above</link>.
|
||||
Package is missing some GSettings schemas. You can find out the package
|
||||
containing the schema with <command>nix-locate
|
||||
<replaceable>org.gnome.foo</replaceable>.gschema.xml</command> and let
|
||||
the hooks handle the wrapping as
|
||||
<link linkend="ssec-gnome-common-issues-no-schemas">above</link>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -172,7 +269,14 @@ preFixup = ''
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
This is because derivers like <function>python.pkgs.buildPythonApplication</function> or <function>qt5.mkDerivation</function> have setup-hooks automatically added that produce wrappers with <package>makeWrapper</package>. The simplest way to workaround that is to disable the <package>wrapGAppsHook</package> automatic wrapping with <code>dontWrapGApps = true;</code> and pass the arguments it intended to pass to <package>makeWrapper</package> to another.
|
||||
This is because derivers like
|
||||
<function>python.pkgs.buildPythonApplication</function> or
|
||||
<function>qt5.mkDerivation</function> have setup-hooks automatically
|
||||
added that produce wrappers with <package>makeWrapper</package>. The
|
||||
simplest way to workaround that is to disable the
|
||||
<package>wrapGAppsHook</package> automatic wrapping with
|
||||
<code>dontWrapGApps = true;</code> and pass the arguments it intended to
|
||||
pass to <package>makeWrapper</package> to another.
|
||||
</para>
|
||||
<para>
|
||||
In the case of a Python application it could look like:
|
||||
@ -224,34 +328,55 @@ mkDerivation {
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
You can rely on applications depending on the library set the necessary environment variables but that it often easy to miss. Instead we recommend to patch the paths in the source code whenever possible. Here are some examples:
|
||||
You can rely on applications depending on the library set the necessary
|
||||
environment variables but that it often easy to miss. Instead we
|
||||
recommend to patch the paths in the source code whenever possible. Here
|
||||
are some examples:
|
||||
<itemizedlist>
|
||||
<listitem xml:id="ssec-gnome-common-issues-unwrappable-package-gnome-shell-ext">
|
||||
<para>
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/gnome-3/core/gnome-shell-extensions/default.nix#L21-L24">Replacing a <envar>GI_TYPELIB_PATH</envar> in GNOME Shell extension</link> – we are using <function>substituteAll</function> to include the path to a typelib into a patch.
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/gnome-3/core/gnome-shell-extensions/default.nix#L21-L24">Replacing
|
||||
a <envar>GI_TYPELIB_PATH</envar> in GNOME Shell extension</link> –
|
||||
we are using <function>substituteAll</function> to include the path to
|
||||
a typelib into a patch.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings">
|
||||
<para>
|
||||
The following examples are hardcoding GSettings schema paths. To get the schema paths we use the functions
|
||||
The following examples are hardcoding GSettings schema paths. To get
|
||||
the schema paths we use the functions
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<function>glib.getSchemaPath</function> Takes a nix package attribute as an argument.
|
||||
<function>glib.getSchemaPath</function> Takes a nix package
|
||||
attribute as an argument.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<function>glib.makeSchemaPath</function> Takes a package output like <literal>$out</literal> and a derivation name. You should use this if the schemas you need to hardcode are in the same derivation.
|
||||
<function>glib.makeSchemaPath</function> Takes a package output
|
||||
like <literal>$out</literal> and a derivation name. You should use
|
||||
this if the schemas you need to hardcode are in the same
|
||||
derivation.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
<para xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings-vala">
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86">Hard-coding GSettings schema path in Vala plug-in (dynamically loaded library)</link> – here, <function>substituteAll</function> cannot be used since the schema comes from the same package preventing us from pass its path to the function, probably due to a <link xlink:href="https://github.com/NixOS/nix/issues/1846">Nix bug</link>.
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/7bb8f05f12ca3cff9da72b56caa2f7472d5732bc/pkgs/desktops/pantheon/apps/elementary-files/default.nix#L78-L86">Hard-coding
|
||||
GSettings schema path in Vala plug-in (dynamically loaded
|
||||
library)</link> – here, <function>substituteAll</function> cannot be
|
||||
used since the schema comes from the same package preventing us from
|
||||
pass its path to the function, probably due to a
|
||||
<link xlink:href="https://github.com/NixOS/nix/issues/1846">Nix
|
||||
bug</link>.
|
||||
</para>
|
||||
<para xml:id="ssec-gnome-common-issues-unwrappable-package-gsettings-c">
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34">Hard-coding GSettings schema path in C library</link> – nothing special other than using <link xlink:href="https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467">Coccinelle patch</link> to generate the patch itself.
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/blob/29c120c065d03b000224872251bed93932d42412/pkgs/development/libraries/glib-networking/default.nix#L31-L34">Hard-coding
|
||||
GSettings schema path in C library</link> – nothing special other
|
||||
than using
|
||||
<link xlink:href="https://github.com/NixOS/nixpkgs/pull/67957#issuecomment-527717467">Coccinelle
|
||||
patch</link> to generate the patch itself.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
@ -141,8 +141,8 @@ ClassC3Componentised = buildPerlPackage rec {
|
||||
<para>
|
||||
On Darwin, if a script has too many
|
||||
<literal>-I<replaceable>dir</replaceable></literal> flags in its first line
|
||||
(its “shebang line”), it will not run. This can be worked around by calling
|
||||
the <literal>shortenPerlShebang</literal> function from the
|
||||
(its “shebang line”), it will not run. This can be worked around by
|
||||
calling the <literal>shortenPerlShebang</literal> function from the
|
||||
<literal>postInstall</literal> phase:
|
||||
<programlisting>
|
||||
{ stdenv, buildPerlPackage, fetchurl, shortenPerlShebang }:
|
||||
@ -162,10 +162,10 @@ ImageExifTool = buildPerlPackage {
|
||||
'';
|
||||
};
|
||||
</programlisting>
|
||||
This will remove the <literal>-I</literal> flags from the shebang line,
|
||||
rewrite them in the <literal>use lib</literal> form, and put them on the next
|
||||
line instead. This function can be given any number of Perl scripts as
|
||||
arguments; it will modify them in-place.
|
||||
This will remove the <literal>-I</literal> flags from the shebang line,
|
||||
rewrite them in the <literal>use lib</literal> form, and put them on the next
|
||||
line instead. This function can be given any number of Perl scripts as
|
||||
arguments; it will modify them in-place.
|
||||
</para>
|
||||
|
||||
<section xml:id="ssec-generation-from-CPAN">
|
||||
|
||||
@ -4,16 +4,16 @@
|
||||
<title>Qt</title>
|
||||
|
||||
<para>
|
||||
This section describes the differences between Nix expressions for Qt
|
||||
libraries and applications and Nix expressions for other C++ software. Some
|
||||
knowledge of the latter is assumed. There are primarily two problems which
|
||||
the Qt infrastructure is designed to address: ensuring consistent versioning
|
||||
of all dependencies and finding dependencies at runtime.
|
||||
This section describes the differences between Nix expressions for Qt
|
||||
libraries and applications and Nix expressions for other C++ software. Some
|
||||
knowledge of the latter is assumed. There are primarily two problems which
|
||||
the Qt infrastructure is designed to address: ensuring consistent versioning
|
||||
of all dependencies and finding dependencies at runtime.
|
||||
</para>
|
||||
|
||||
<example xml:id='qt-default-nix'>
|
||||
<title>Nix expression for a Qt package (<filename>default.nix</filename>)</title>
|
||||
<programlisting>
|
||||
<title>Nix expression for a Qt package (<filename>default.nix</filename>)</title>
|
||||
<programlisting>
|
||||
{ mkDerivation, lib, qtbase }: <co xml:id='qt-default-nix-co-1' />
|
||||
|
||||
mkDerivation { <co xml:id='qt-default-nix-co-2' />
|
||||
@ -26,53 +26,51 @@ mkDerivation { <co xml:id='qt-default-nix-co-2' />
|
||||
</example>
|
||||
|
||||
<calloutlist>
|
||||
<callout arearefs='qt-default-nix-co-1'>
|
||||
<para>
|
||||
Import <literal>mkDerivation</literal> and Qt (such as
|
||||
<literal>qtbase</literal> modules directly. <emphasis>Do not</emphasis>
|
||||
import Qt package sets; the Qt versions of dependencies may not be
|
||||
coherent, causing build and runtime failures.
|
||||
</para>
|
||||
</callout>
|
||||
<callout arearefs='qt-default-nix-co-2'>
|
||||
<para>
|
||||
Use <literal>mkDerivation</literal> instead of
|
||||
<literal>stdenv.mkDerivation</literal>. <literal>mkDerivation</literal>
|
||||
is a wrapper around <literal>stdenv.mkDerivation</literal> which
|
||||
applies some Qt-specific settings.
|
||||
This deriver accepts the same arguments as
|
||||
<literal>stdenv.mkDerivation</literal>; refer to
|
||||
<xref linkend='chap-stdenv' /> for details.
|
||||
</para>
|
||||
<para>
|
||||
To use another deriver instead of
|
||||
<literal>stdenv.mkDerivation</literal>, use
|
||||
<literal>mkDerivationWith</literal>:
|
||||
<callout arearefs='qt-default-nix-co-1'>
|
||||
<para>
|
||||
Import <literal>mkDerivation</literal> and Qt (such as
|
||||
<literal>qtbase</literal> modules directly. <emphasis>Do not</emphasis>
|
||||
import Qt package sets; the Qt versions of dependencies may not be
|
||||
coherent, causing build and runtime failures.
|
||||
</para>
|
||||
</callout>
|
||||
<callout arearefs='qt-default-nix-co-2'>
|
||||
<para>
|
||||
Use <literal>mkDerivation</literal> instead of
|
||||
<literal>stdenv.mkDerivation</literal>. <literal>mkDerivation</literal> is
|
||||
a wrapper around <literal>stdenv.mkDerivation</literal> which applies some
|
||||
Qt-specific settings. This deriver accepts the same arguments as
|
||||
<literal>stdenv.mkDerivation</literal>; refer to
|
||||
<xref linkend='chap-stdenv' /> for details.
|
||||
</para>
|
||||
<para>
|
||||
To use another deriver instead of <literal>stdenv.mkDerivation</literal>,
|
||||
use <literal>mkDerivationWith</literal>:
|
||||
<programlisting>
|
||||
mkDerivationWith myDeriver {
|
||||
# ...
|
||||
}
|
||||
</programlisting>
|
||||
If you cannot use <literal>mkDerivationWith</literal>, please refer to
|
||||
<xref linkend='qt-runtime-dependencies' />.
|
||||
</para>
|
||||
</callout>
|
||||
<callout arearefs='qt-default-nix-co-3'>
|
||||
<para>
|
||||
<literal>mkDerivation</literal> accepts the same arguments as
|
||||
<literal>stdenv.mkDerivation</literal>, such as
|
||||
<literal>buildInputs</literal>.
|
||||
</para>
|
||||
</callout>
|
||||
If you cannot use <literal>mkDerivationWith</literal>, please refer to
|
||||
<xref linkend='qt-runtime-dependencies' />.
|
||||
</para>
|
||||
</callout>
|
||||
<callout arearefs='qt-default-nix-co-3'>
|
||||
<para>
|
||||
<literal>mkDerivation</literal> accepts the same arguments as
|
||||
<literal>stdenv.mkDerivation</literal>, such as
|
||||
<literal>buildInputs</literal>.
|
||||
</para>
|
||||
</callout>
|
||||
</calloutlist>
|
||||
|
||||
<formalpara xml:id='qt-runtime-dependencies'>
|
||||
<title>Locating runtime dependencies</title>
|
||||
<para>
|
||||
Qt applications need to be wrapped to find runtime dependencies. If you
|
||||
cannot use <literal>mkDerivation</literal> or
|
||||
<literal>mkDerivationWith</literal> above, include
|
||||
<literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>:
|
||||
<title>Locating runtime dependencies</title>
|
||||
<para>
|
||||
Qt applications need to be wrapped to find runtime dependencies. If you
|
||||
cannot use <literal>mkDerivation</literal> or
|
||||
<literal>mkDerivationWith</literal> above, include
|
||||
<literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>:
|
||||
<programlisting>
|
||||
stdenv.mkDerivation {
|
||||
# ...
|
||||
@ -80,13 +78,13 @@ stdenv.mkDerivation {
|
||||
nativeBuildInputs = [ wrapQtAppsHook ];
|
||||
}
|
||||
</programlisting>
|
||||
</para>
|
||||
</para>
|
||||
</formalpara>
|
||||
|
||||
<para>
|
||||
Entries added to <literal>qtWrapperArgs</literal> are used to modify the
|
||||
wrappers created by <literal>wrapQtAppsHook</literal>. The entries are
|
||||
passed as arguments to <xref linkend='fun-wrapProgram' />.
|
||||
Entries added to <literal>qtWrapperArgs</literal> are used to modify the
|
||||
wrappers created by <literal>wrapQtAppsHook</literal>. The entries are passed
|
||||
as arguments to <xref linkend='fun-wrapProgram' />.
|
||||
<programlisting>
|
||||
mkDerivation {
|
||||
# ...
|
||||
@ -97,8 +95,8 @@ mkDerivation {
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Set <literal>dontWrapQtApps</literal> to stop applications from being
|
||||
wrapped automatically. It is required to wrap applications manually with
|
||||
Set <literal>dontWrapQtApps</literal> to stop applications from being wrapped
|
||||
automatically. It is required to wrap applications manually with
|
||||
<literal>wrapQtApp</literal>, using the syntax of
|
||||
<xref linkend='fun-wrapProgram' />:
|
||||
<programlisting>
|
||||
@ -115,16 +113,17 @@ mkDerivation {
|
||||
|
||||
<note>
|
||||
<para>
|
||||
<literal>wrapQtAppsHook</literal> ignores files that are non-ELF executables.
|
||||
This means that scripts won't be automatically wrapped so you'll need to manually
|
||||
wrap them as previously mentioned. An example of when you'd always need to do this
|
||||
is with Python applications that use PyQT.
|
||||
<literal>wrapQtAppsHook</literal> ignores files that are non-ELF
|
||||
executables. This means that scripts won't be automatically wrapped so
|
||||
you'll need to manually wrap them as previously mentioned. An example of
|
||||
when you'd always need to do this is with Python applications that use PyQT.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<para>
|
||||
Libraries are built with every available version of Qt. Use the <literal>meta.broken</literal>
|
||||
attribute to disable the package for unsupported Qt versions:
|
||||
Libraries are built with every available version of Qt. Use the
|
||||
<literal>meta.broken</literal> attribute to disable the package for
|
||||
unsupported Qt versions:
|
||||
<programlisting>
|
||||
mkDerivation {
|
||||
# ...
|
||||
@ -136,13 +135,13 @@ mkDerivation {
|
||||
</para>
|
||||
|
||||
<formalpara>
|
||||
<title>Adding a library to Nixpkgs</title>
|
||||
<para>
|
||||
Add a Qt library to <filename>all-packages.nix</filename> by adding it to the
|
||||
collection inside <literal>mkLibsForQt5</literal>. This ensures that the
|
||||
library is built with every available version of Qt as needed.
|
||||
<example xml:id='qt-library-all-packages-nix'>
|
||||
<title>Adding a Qt library to <filename>all-packages.nix</filename></title>
|
||||
<title>Adding a library to Nixpkgs</title>
|
||||
<para>
|
||||
Add a Qt library to <filename>all-packages.nix</filename> by adding it to
|
||||
the collection inside <literal>mkLibsForQt5</literal>. This ensures that the
|
||||
library is built with every available version of Qt as needed.
|
||||
<example xml:id='qt-library-all-packages-nix'>
|
||||
<title>Adding a Qt library to <filename>all-packages.nix</filename></title>
|
||||
<programlisting>
|
||||
{
|
||||
# ...
|
||||
@ -156,19 +155,19 @@ mkDerivation {
|
||||
# ...
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</example>
|
||||
</para>
|
||||
</formalpara>
|
||||
|
||||
<formalpara>
|
||||
<title>Adding an application to Nixpkgs</title>
|
||||
<para>
|
||||
Add a Qt application to <filename>all-packages.nix</filename> using
|
||||
<literal>libsForQt5.callPackage</literal> instead of the usual
|
||||
<literal>callPackage</literal>. The former ensures that all dependencies
|
||||
are built with the same version of Qt.
|
||||
<example xml:id='qt-application-all-packages-nix'>
|
||||
<title>Adding a Qt application to <filename>all-packages.nix</filename></title>
|
||||
<title>Adding an application to Nixpkgs</title>
|
||||
<para>
|
||||
Add a Qt application to <filename>all-packages.nix</filename> using
|
||||
<literal>libsForQt5.callPackage</literal> instead of the usual
|
||||
<literal>callPackage</literal>. The former ensures that all dependencies are
|
||||
built with the same version of Qt.
|
||||
<example xml:id='qt-application-all-packages-nix'>
|
||||
<title>Adding a Qt application to <filename>all-packages.nix</filename></title>
|
||||
<programlisting>
|
||||
{
|
||||
# ...
|
||||
@ -178,8 +177,7 @@ mkDerivation {
|
||||
# ...
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</example>
|
||||
</para>
|
||||
</formalpara>
|
||||
|
||||
</section>
|
||||
|
||||
10
doc/meta.xml
10
doc/meta.xml
@ -156,9 +156,9 @@ hello-2.3 A program that produces a familiar, friendly greeting
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
A link or a list of links to the location of Changelog for a package.
|
||||
A link may use expansion to refer to the correct changelog version.
|
||||
Example:
|
||||
A link or a list of links to the location of Changelog for a package. A
|
||||
link may use expansion to refer to the correct changelog version.
|
||||
Example:
|
||||
<literal>"https://git.savannah.gnu.org/cgit/hello.git/plain/NEWS?h=v${version}"</literal>
|
||||
</para>
|
||||
</listitem>
|
||||
@ -273,8 +273,8 @@ meta.platforms = stdenv.lib.platforms.linux;
|
||||
This attribute is special in that it is not actually under the
|
||||
<literal>meta</literal> attribute set but rather under the
|
||||
<literal>passthru</literal> attribute set. This is due to how
|
||||
<literal>meta</literal> attributes work, and the fact that they
|
||||
are supposed to contain only metadata, not derivations.
|
||||
<literal>meta</literal> attributes work, and the fact that they are
|
||||
supposed to contain only metadata, not derivations.
|
||||
</para>
|
||||
</warning>
|
||||
<para>
|
||||
|
||||
@ -311,7 +311,8 @@ packageOverrides = pkgs: {
|
||||
<title>Elm</title>
|
||||
|
||||
<para>
|
||||
To start a development environment do <command>nix-shell -p elmPackages.elm elmPackages.elm-format</command>
|
||||
To start a development environment do <command>nix-shell -p elmPackages.elm
|
||||
elmPackages.elm-format</command>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
@ -506,10 +507,11 @@ stdenv.mkDerivation {
|
||||
<para>
|
||||
The IBus engine is based on <literal>hunspell</literal> to support
|
||||
completion in many languages. By default the dictionaries
|
||||
<literal>de-de</literal>, <literal>en-us</literal>, <literal>fr-moderne</literal>
|
||||
<literal>es-es</literal>, <literal>it-it</literal>,
|
||||
<literal>sv-se</literal> and <literal>sv-fi</literal> are in use. To add
|
||||
another dictionary, the package can be overridden like this:
|
||||
<literal>de-de</literal>, <literal>en-us</literal>,
|
||||
<literal>fr-moderne</literal> <literal>es-es</literal>,
|
||||
<literal>it-it</literal>, <literal>sv-se</literal> and
|
||||
<literal>sv-fi</literal> are in use. To add another dictionary, the package
|
||||
can be overridden like this:
|
||||
<programlisting>ibus-engines.typing-booster.override {
|
||||
langs = [ "de-at" "en-gb" ];
|
||||
}</programlisting>
|
||||
@ -543,47 +545,45 @@ stdenv.mkDerivation {
|
||||
<title>Nginx</title>
|
||||
|
||||
<para>
|
||||
<link xlink:href="https://nginx.org/">Nginx</link> is a
|
||||
reverse proxy and lightweight webserver.
|
||||
<link xlink:href="https://nginx.org/">Nginx</link> is a reverse proxy and
|
||||
lightweight webserver.
|
||||
</para>
|
||||
|
||||
<section xml:id="sec-nginx-etag">
|
||||
<title>ETags on static files served from the Nix store</title>
|
||||
|
||||
<para>
|
||||
HTTP has a couple different mechanisms for caching to prevent
|
||||
clients from having to download the same content repeatedly
|
||||
if a resource has not changed since the last time it was requested.
|
||||
When nginx is used as a server for static files, it implements
|
||||
the caching mechanism based on the
|
||||
<link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"><literal>Last-Modified</literal></link>
|
||||
response header automatically; unfortunately, it works by using
|
||||
filesystem timestamps to determine the value of the
|
||||
<literal>Last-Modified</literal> header. This doesn't give the
|
||||
desired behavior when the file is in the Nix store, because all
|
||||
file timestamps are set to 0 (for reasons related to build
|
||||
reproducibility).
|
||||
HTTP has a couple different mechanisms for caching to prevent clients from
|
||||
having to download the same content repeatedly if a resource has not
|
||||
changed since the last time it was requested. When nginx is used as a
|
||||
server for static files, it implements the caching mechanism based on the
|
||||
<link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"><literal>Last-Modified</literal></link>
|
||||
response header automatically; unfortunately, it works by using filesystem
|
||||
timestamps to determine the value of the <literal>Last-Modified</literal>
|
||||
header. This doesn't give the desired behavior when the file is in the Nix
|
||||
store, because all file timestamps are set to 0 (for reasons related to
|
||||
build reproducibility).
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Fortunately, HTTP supports an alternative (and more effective)
|
||||
caching mechanism: the
|
||||
Fortunately, HTTP supports an alternative (and more effective) caching
|
||||
mechanism: the
|
||||
<link xlink:href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag"><literal>ETag</literal></link>
|
||||
response header. The value of the <literal>ETag</literal> header
|
||||
specifies some identifier for the particular content that the
|
||||
server is sending (e.g. a hash). When a client makes a second
|
||||
request for the same resource, it sends that value back in an
|
||||
<literal>If-None-Match</literal> header. If the ETag value is
|
||||
unchanged, then the server does not need to resend the content.
|
||||
response header. The value of the <literal>ETag</literal> header specifies
|
||||
some identifier for the particular content that the server is sending (e.g.
|
||||
a hash). When a client makes a second request for the same resource, it
|
||||
sends that value back in an <literal>If-None-Match</literal> header. If the
|
||||
ETag value is unchanged, then the server does not need to resend the
|
||||
content.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
As of NixOS 19.09, the nginx package in Nixpkgs is patched such
|
||||
that when nginx serves a file out of <filename>/nix/store</filename>,
|
||||
the hash in the store path is used as the <literal>ETag</literal>
|
||||
header in the HTTP response, thus providing proper caching functionality.
|
||||
This happens automatically; you do not need to do modify any
|
||||
configuration to get this behavior.
|
||||
As of NixOS 19.09, the nginx package in Nixpkgs is patched such that when
|
||||
nginx serves a file out of <filename>/nix/store</filename>, the hash in the
|
||||
store path is used as the <literal>ETag</literal> header in the HTTP
|
||||
response, thus providing proper caching functionality. This happens
|
||||
automatically; you do not need to do modify any configuration to get this
|
||||
behavior.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
@ -1,14 +1,10 @@
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="package-specific-user-notes">
|
||||
<title>Package-specific usage notes</title>
|
||||
<para>
|
||||
These chapters includes some notes
|
||||
that apply to specific packages and should
|
||||
answer some of the frequently asked questions
|
||||
related to Nixpkgs use.
|
||||
|
||||
Some useful information related to package use
|
||||
can be found in <link linkend="chap-package-notes">package-specific development notes</link>.
|
||||
|
||||
These chapters includes some notes that apply to specific packages and should
|
||||
answer some of the frequently asked questions related to Nixpkgs use. Some
|
||||
useful information related to package use can be found in
|
||||
<link linkend="chap-package-notes">package-specific development notes</link>.
|
||||
</para>
|
||||
<section xml:id="opengl">
|
||||
<title>OpenGL</title>
|
||||
@ -47,7 +43,6 @@
|
||||
<literal>locales</literal> of the package.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section xml:id="sec-emacs">
|
||||
<title>Emacs</title>
|
||||
|
||||
@ -204,46 +199,43 @@ overrides = self: super: rec {
|
||||
</screen>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section xml:id="dlib">
|
||||
<title>DLib</title>
|
||||
|
||||
<para>
|
||||
<link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based toolkit which
|
||||
provides several machine learning algorithms.
|
||||
<link xlink:href="http://dlib.net/">DLib</link> is a modern, C++-based
|
||||
toolkit which provides several machine learning algorithms.
|
||||
</para>
|
||||
|
||||
<section xml:id="compiling-without-avx-support">
|
||||
<title>Compiling without AVX support</title>
|
||||
|
||||
<para>
|
||||
Especially older CPUs don't support
|
||||
<link xlink:href="https://en.wikipedia.org/wiki/Advanced_Vector_Extensions">AVX</link>
|
||||
(<abbrev>Advanced Vector Extensions</abbrev>) instructions that are used by DLib to
|
||||
optimize their algorithms.
|
||||
Especially older CPUs don't support
|
||||
<link xlink:href="https://en.wikipedia.org/wiki/Advanced_Vector_Extensions">AVX</link>
|
||||
(<abbrev>Advanced Vector Extensions</abbrev>) instructions that are used by
|
||||
DLib to optimize their algorithms.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
On the affected hardware errors like <literal>Illegal instruction</literal> will occur.
|
||||
In those cases AVX support needs to be disabled:
|
||||
On the affected hardware errors like <literal>Illegal instruction</literal>
|
||||
will occur. In those cases AVX support needs to be disabled:
|
||||
<programlisting>self: super: {
|
||||
dlib = super.dlib.override { avxSupport = false; };
|
||||
}</programlisting>
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section xml:id="unfree-software">
|
||||
<title>Unfree software</title>
|
||||
|
||||
<para>
|
||||
All users of Nixpkgs are free software users, and many users (and
|
||||
developers) of Nixpkgs want to limit and tightly control their exposure to
|
||||
unfree software. At the same time, many users need (or want)
|
||||
to run some specific
|
||||
pieces of proprietary software. Nixpkgs includes some expressions for unfree
|
||||
software packages. By default unfree software cannot be installed and
|
||||
doesn’t show up in searches. To allow installing unfree software in a
|
||||
unfree software. At the same time, many users need (or want) to run some
|
||||
specific pieces of proprietary software. Nixpkgs includes some expressions
|
||||
for unfree software packages. By default unfree software cannot be installed
|
||||
and doesn’t show up in searches. To allow installing unfree software in a
|
||||
single Nix invocation one can export
|
||||
<literal>NIXPKGS_ALLOW_UNFREE=1</literal>. For a persistent solution, users
|
||||
can set <literal>allowUnfree</literal> in the Nixpkgs configuration.
|
||||
@ -256,7 +248,6 @@ overrides = self: super: rec {
|
||||
<literal>true</literal> for unfree packages that should be allowed.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section xml:id="sec-steam">
|
||||
<title>Steam</title>
|
||||
|
||||
@ -407,21 +398,24 @@ overrides = self: super: rec {
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section xml:id="sec-citrix">
|
||||
<title>Citrix Receiver & Citrix Workspace App</title>
|
||||
|
||||
<para>
|
||||
<note>
|
||||
<para>
|
||||
Please note that the <literal>citrix_receiver</literal> package has been deprecated since its
|
||||
development was <link xlink:href="https://docs.citrix.com/en-us/citrix-workspace-app.html">discontinued by upstream</link>
|
||||
and has been replaced by <link xlink:href="https://www.citrix.com/products/workspace-app/">the citrix workspace app</link>.
|
||||
Please note that the <literal>citrix_receiver</literal> package has been
|
||||
deprecated since its development was
|
||||
<link xlink:href="https://docs.citrix.com/en-us/citrix-workspace-app.html">discontinued
|
||||
by upstream</link> and has been replaced by
|
||||
<link xlink:href="https://www.citrix.com/products/workspace-app/">the
|
||||
citrix workspace app</link>.
|
||||
</para>
|
||||
</note>
|
||||
<link xlink:href="https://www.citrix.com/products/receiver/">Citrix Receiver</link> and
|
||||
<link xlink:href="https://www.citrix.com/products/workspace-app/">Citrix Workspace App</link>
|
||||
are a remote desktop viewers which provide access to
|
||||
<link xlink:href="https://www.citrix.com/products/receiver/">Citrix
|
||||
Receiver</link> and
|
||||
<link xlink:href="https://www.citrix.com/products/workspace-app/">Citrix
|
||||
Workspace App</link> are a remote desktop viewers which provide access to
|
||||
<link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link>
|
||||
installations.
|
||||
</para>
|
||||
@ -432,24 +426,24 @@ overrides = self: super: rec {
|
||||
<para>
|
||||
The tarball archive needs to be downloaded manually as the license
|
||||
agreements of the vendor for
|
||||
<link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">Citrix Receiver</link>
|
||||
or <link xlink:href="https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html">Citrix Workspace</link>
|
||||
need to be accepted first.
|
||||
Then run <command>nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz</command>.
|
||||
With the archive available
|
||||
in the store the package can be built and installed with Nix.
|
||||
<link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">Citrix
|
||||
Receiver</link> or
|
||||
<link xlink:href="https://www.citrix.de/downloads/workspace-app/linux/workspace-app-for-linux-latest.html">Citrix
|
||||
Workspace</link> need to be accepted first. Then run
|
||||
<command>nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz</command>.
|
||||
With the archive available in the store the package can be built and
|
||||
installed with Nix.
|
||||
</para>
|
||||
|
||||
<warning>
|
||||
<title>Caution with <command>nix-shell</command> installs</title>
|
||||
<para>
|
||||
It's recommended to install <literal>Citrix Receiver</literal>
|
||||
and/or <literal>Citrix Workspace</literal> using
|
||||
<literal>nix-env -i</literal> or globally to
|
||||
ensure that the <literal>.desktop</literal> files are installed properly
|
||||
into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it won't be possible to
|
||||
open <literal>.ica</literal> files automatically from the browser to start
|
||||
a Citrix connection.
|
||||
It's recommended to install <literal>Citrix Receiver</literal> and/or
|
||||
<literal>Citrix Workspace</literal> using <literal>nix-env -i</literal> or
|
||||
globally to ensure that the <literal>.desktop</literal> files are
|
||||
installed properly into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it
|
||||
won't be possible to open <literal>.ica</literal> files automatically from
|
||||
the browser to start a Citrix connection.
|
||||
</para>
|
||||
</warning>
|
||||
</section>
|
||||
@ -458,8 +452,8 @@ overrides = self: super: rec {
|
||||
<title>Custom certificates</title>
|
||||
|
||||
<para>
|
||||
The <literal>Citrix Workspace App</literal>
|
||||
in <literal>nixpkgs</literal> trust several certificates
|
||||
The <literal>Citrix Workspace App</literal> in <literal>nixpkgs</literal>
|
||||
trust several certificates
|
||||
<link xlink:href="https://curl.haxx.se/docs/caextract.html">from the
|
||||
Mozilla database</link> by default. However several companies using Citrix
|
||||
might require their own corporate certificate. On distros with imperative
|
||||
|
||||
@ -210,9 +210,11 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Optionally commit the new package and open a pull request <link
|
||||
xlink:href="https://github.com/NixOS/nixpkgs/pulls">to nixpkgs</link>, or
|
||||
use <link
|
||||
Optionally commit the new package and open a pull request
|
||||
<link
|
||||
xlink:href="https://github.com/NixOS/nixpkgs/pulls">to
|
||||
nixpkgs</link>, or use
|
||||
<link
|
||||
xlink:href="https://discourse.nixos.org/t/about-the-patches-category/477">
|
||||
the Patches category</link> on Discourse for sending a patch without a
|
||||
GitHub account.
|
||||
|
||||
126
doc/stdenv.xml
126
doc/stdenv.xml
@ -736,8 +736,8 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ]
|
||||
commit</command> or any other commands that cannot handle that.
|
||||
</para>
|
||||
<para>
|
||||
For information about how to run the updates, execute
|
||||
<command>nix-shell maintainers/scripts/update.nix</command>.
|
||||
For information about how to run the updates, execute <command>nix-shell
|
||||
maintainers/scripts/update.nix</command>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -764,7 +764,8 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ]
|
||||
to <emphasis>add</emphasis> some commands to a phase, e.g. by defining
|
||||
<literal>postInstall</literal> or <literal>preFixup</literal>, as skipping
|
||||
some of the default actions may have unexpected consequences. The default
|
||||
script for each phase is defined in the file <filename>pkgs/stdenv/generic/setup.sh</filename>.
|
||||
script for each phase is defined in the file
|
||||
<filename>pkgs/stdenv/generic/setup.sh</filename>.
|
||||
</para>
|
||||
|
||||
<section xml:id="ssec-controlling-phases">
|
||||
@ -786,7 +787,8 @@ passthru.updateScript = [ ../../update.sh pname "--requested-release=unstable" ]
|
||||
set, the default value is used, which is <literal>$prePhases
|
||||
unpackPhase patchPhase $preConfigurePhases configurePhase
|
||||
$preBuildPhases buildPhase checkPhase $preInstallPhases installPhase
|
||||
fixupPhase installCheckPhase $preDistPhases distPhase $postPhases</literal>.
|
||||
fixupPhase installCheckPhase $preDistPhases distPhase
|
||||
$postPhases</literal>.
|
||||
</para>
|
||||
<para>
|
||||
Usually, if you just want to add a few phases, it’s more convenient
|
||||
@ -1605,7 +1607,7 @@ installTargets = "install-bin install-doc";</programlisting>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Set to true to skip the fixup phase.
|
||||
Set to true to skip the fixup phase.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -2411,12 +2413,12 @@ addEnvHooks "$hostOffset" myBashFunction
|
||||
<para>
|
||||
The Bintools Wrapper was only just recently split off from CC Wrapper,
|
||||
so the division of labor is still being worked out. For example, it
|
||||
shouldn't care about the C standard library, but just take a
|
||||
derivation with the dynamic loader (which happens to be the glibc on
|
||||
linux). Dependency finding however is a task both wrappers will continue
|
||||
to need to share, and probably the most important to understand. It is
|
||||
currently accomplished by collecting directories of host-platform
|
||||
dependencies (i.e. <varname>buildInputs</varname> and
|
||||
shouldn't care about the C standard library, but just take a derivation
|
||||
with the dynamic loader (which happens to be the glibc on linux).
|
||||
Dependency finding however is a task both wrappers will continue to need
|
||||
to share, and probably the most important to understand. It is currently
|
||||
accomplished by collecting directories of host-platform dependencies
|
||||
(i.e. <varname>buildInputs</varname> and
|
||||
<varname>nativeBuildInputs</varname>) in environment variables. The
|
||||
Bintools Wrapper's setup hook causes any <filename>lib</filename> and
|
||||
<filename>lib64</filename> subdirectories to be added to
|
||||
@ -2633,7 +2635,8 @@ addEnvHooks "$hostOffset" myBashFunction
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Hooks related to GNOME platform and related libraries like GLib, GTK and GStreamer are described in <xref linkend="sec-language-gnome" />.
|
||||
Hooks related to GNOME platform and related libraries like GLib, GTK and
|
||||
GStreamer are described in <xref linkend="sec-language-gnome" />.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -2688,12 +2691,12 @@ addEnvHooks "$hostOffset" myBashFunction
|
||||
At <filename>/var/lib/cntr</filename> the sandboxed filesystem is
|
||||
mounted. All commands and files of the system are still accessible
|
||||
within the shell. To execute commands from the sandbox use the cntr exec
|
||||
subcommand. <command>cntr</command> is only supported
|
||||
on Linux-based platforms. To use it first add <literal>cntr</literal> to
|
||||
your <literal>environment.systemPackages</literal> on NixOS or
|
||||
alternatively to the root user on non-NixOS systems. Then in the package
|
||||
that is supposed to be inspected, add <literal>breakpointHook</literal>
|
||||
to <literal>nativeBuildInputs</literal>.
|
||||
subcommand. <command>cntr</command> is only supported on Linux-based
|
||||
platforms. To use it first add <literal>cntr</literal> to your
|
||||
<literal>environment.systemPackages</literal> on NixOS or alternatively
|
||||
to the root user on non-NixOS systems. Then in the package that is
|
||||
supposed to be inspected, add <literal>breakpointHook</literal> to
|
||||
<literal>nativeBuildInputs</literal>.
|
||||
<programlisting>
|
||||
nativeBuildInputs = [ breakpointHook ];
|
||||
</programlisting>
|
||||
@ -2703,11 +2706,11 @@ nativeBuildInputs = [ breakpointHook ];
|
||||
<note>
|
||||
<title>Caution with remote builds</title>
|
||||
<para>
|
||||
This won't work with remote builds as the build environment is on
|
||||
a different machine and can't be accessed by <command>cntr</command>.
|
||||
Remote builds can be turned off by setting <literal>--option builders ''</literal>
|
||||
for <command>nix-build</command> or <literal>--builders ''</literal> for
|
||||
<command>nix build</command>.
|
||||
This won't work with remote builds as the build environment is on a
|
||||
different machine and can't be accessed by <command>cntr</command>.
|
||||
Remote builds can be turned off by setting <literal>--option builders
|
||||
''</literal> for <command>nix-build</command> or <literal>--builders
|
||||
''</literal> for <command>nix build</command>.
|
||||
</para>
|
||||
</note>
|
||||
</listitem>
|
||||
@ -2806,17 +2809,78 @@ postInstall = ''
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
meson
|
||||
Meson
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Overrides the configure phase to run meson to generate Ninja files. You
|
||||
can disable this behavior by setting configurePhase to a custom value,
|
||||
or by setting dontUseMesonConfigure. To run these files, you should
|
||||
accompany meson with ninja. mesonFlags controls only the flags passed to
|
||||
meson. By default, parallel building is enabled as Meson supports
|
||||
Overrides the configure phase to run meson to generate Ninja files. To
|
||||
run these files, you should accompany Meson with ninja. By default,
|
||||
<varname>enableParallelBuilding</varname> is enabled as Meson supports
|
||||
parallel building almost everywhere.
|
||||
</para>
|
||||
<variablelist>
|
||||
<title>Variables controlling Meson</title>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<varname>mesonFlags</varname>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Controls the flags passed to meson.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<varname>mesonBuildType</varname>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Which
|
||||
<link
|
||||
xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>--buildtype</command></link>
|
||||
to pass to Meson. We default to <literal>plain</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<varname>mesonAutoFeatures</varname>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
What value to set
|
||||
<link
|
||||
xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>-Dauto_features=</command></link>
|
||||
to. We default to <command>enabled</command>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<varname>mesonWrapMode</varname>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
What value to set
|
||||
<link
|
||||
xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>-Dwrap_mode=</command></link>
|
||||
to. We default to <command>nodownload</command> as we disallow
|
||||
network access.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<varname>dontUseMesonConfigure</varname>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Disables using Meson's <varname>configurePhase</varname>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
@ -2851,8 +2915,8 @@ postInstall = ''
|
||||
<para>
|
||||
Overrides the configure, build, and install phases. This will run the
|
||||
"waf" script used by many projects. If wafPath (default ./waf) doesn’t
|
||||
exist, it will copy the version of waf available in Nixpkgs. wafFlags can
|
||||
be used to pass flags to the waf script.
|
||||
exist, it will copy the version of waf available in Nixpkgs. wafFlags
|
||||
can be used to pass flags to the waf script.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user