doc: typo fixes
This commit is contained in:
parent
67d78be036
commit
32ddbe3da9
|
@ -132,7 +132,7 @@
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The difference between an a package being unsupported on some system and
|
The difference between a package being unsupported on some system and
|
||||||
being broken is admittedly a bit fuzzy. If a program
|
being broken is admittedly a bit fuzzy. If a program
|
||||||
<emphasis>ought</emphasis> to work on a certain platform, but doesn't, the
|
<emphasis>ought</emphasis> to work on a certain platform, but doesn't, the
|
||||||
platform should be included in <literal>meta.platforms</literal>, but marked
|
platform should be included in <literal>meta.platforms</literal>, but marked
|
||||||
|
@ -175,11 +175,12 @@
|
||||||
</programlisting>
|
</programlisting>
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
A more useful example, the following configuration allows only allows
|
For a more useful example, try the following. This configuration
|
||||||
flash player and visual studio code:
|
only allows unfree packages named flash player and visual studio
|
||||||
|
code:
|
||||||
<programlisting>
|
<programlisting>
|
||||||
{
|
{
|
||||||
allowUnfreePredicate = (pkg: elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]);
|
allowUnfreePredicate = (pkg: builtins.elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]);
|
||||||
}
|
}
|
||||||
</programlisting>
|
</programlisting>
|
||||||
</para>
|
</para>
|
||||||
|
@ -286,8 +287,8 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
You can define a function called <varname>packageOverrides</varname> in your
|
You can define a function called <varname>packageOverrides</varname> in your
|
||||||
local <filename>~/.config/nixpkgs/config.nix</filename> to override nix
|
local <filename>~/.config/nixpkgs/config.nix</filename> to override Nix
|
||||||
packages. It must be a function that takes pkgs as an argument and return
|
packages. It must be a function that takes pkgs as an argument and returns a
|
||||||
modified set of packages.
|
modified set of packages.
|
||||||
<programlisting>
|
<programlisting>
|
||||||
{
|
{
|
||||||
|
|
|
@ -193,7 +193,7 @@
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
These predicates are defined in <literal>lib.systems.inspect</literal>,
|
These predicates are defined in <literal>lib.systems.inspect</literal>,
|
||||||
and slapped on every platform. They are superior to the ones in
|
and slapped onto every platform. They are superior to the ones in
|
||||||
<varname>stdenv</varname> as they force the user to be explicit about
|
<varname>stdenv</varname> as they force the user to be explicit about
|
||||||
which platform they are inspecting. Please use these instead of those.
|
which platform they are inspecting. Please use these instead of those.
|
||||||
</para>
|
</para>
|
||||||
|
@ -221,7 +221,7 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
In this section we explore the relationship between both runtime and
|
In this section we explore the relationship between both runtime and
|
||||||
buildtime dependencies and the 3 Autoconf platforms.
|
build-time dependencies and the 3 Autoconf platforms.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
|
|
@ -12,7 +12,7 @@
|
||||||
<para>
|
<para>
|
||||||
The Nix language allows a derivation to produce multiple outputs, which is
|
The Nix language allows a derivation to produce multiple outputs, which is
|
||||||
similar to what is utilized by other Linux distribution packaging systems.
|
similar to what is utilized by other Linux distribution packaging systems.
|
||||||
The outputs reside in separate nix store paths, so they can be mostly
|
The outputs reside in separate Nix store paths, so they can be mostly
|
||||||
handled independently of each other, including passing to build inputs,
|
handled independently of each other, including passing to build inputs,
|
||||||
garbage collection or binary substitution. The exception is that building
|
garbage collection or binary substitution. The exception is that building
|
||||||
from source always produces all the outputs.
|
from source always produces all the outputs.
|
||||||
|
|
|
@ -3,9 +3,9 @@
|
||||||
xml:id="chap-overlays">
|
xml:id="chap-overlays">
|
||||||
<title>Overlays</title>
|
<title>Overlays</title>
|
||||||
<para>
|
<para>
|
||||||
This chapter describes how to extend and change Nixpkgs packages using
|
This chapter describes how to extend and change Nixpkgs using overlays.
|
||||||
overlays. Overlays are used to add layers in the fix-point used by Nixpkgs to
|
Overlays are used to add layers in the fixed-point used by Nixpkgs to compose
|
||||||
compose the set of all packages.
|
the set of all packages.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
Nixpkgs can be configured with a list of overlays, which are applied in
|
Nixpkgs can be configured with a list of overlays, which are applied in
|
||||||
|
@ -60,7 +60,7 @@
|
||||||
<para>
|
<para>
|
||||||
First, if an
|
First, if an
|
||||||
<link xlink:href="#sec-overlays-argument"><varname>overlays</varname>
|
<link xlink:href="#sec-overlays-argument"><varname>overlays</varname>
|
||||||
argument</link> to the nixpkgs function itself is given, then that is
|
argument</link> to the Nixpkgs function itself is given, then that is
|
||||||
used and no path lookup will be performed.
|
used and no path lookup will be performed.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
|
@ -205,7 +205,7 @@ $ cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Nixpkgs provides a number of packages that will install Eclipse in its
|
Nixpkgs provides a number of packages that will install Eclipse in its
|
||||||
various forms, these range from the bare-bones Eclipse Platform to the more
|
various forms. These range from the bare-bones Eclipse Platform to the more
|
||||||
fully featured Eclipse SDK or Scala-IDE packages and multiple version are
|
fully featured Eclipse SDK or Scala-IDE packages and multiple version are
|
||||||
often available. It is possible to list available Eclipse packages by
|
often available. It is possible to list available Eclipse packages by
|
||||||
issuing the command:
|
issuing the command:
|
||||||
|
|
|
@ -6,13 +6,13 @@
|
||||||
<title>Darwin (macOS)</title>
|
<title>Darwin (macOS)</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Some common issues when packaging software for darwin:
|
Some common issues when packaging software for Darwin:
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
The darwin <literal>stdenv</literal> uses clang instead of gcc. When
|
The Darwin <literal>stdenv</literal> uses clang instead of gcc. When
|
||||||
referring to the compiler <varname>$CC</varname> or <command>cc</command>
|
referring to the compiler <varname>$CC</varname> or <command>cc</command>
|
||||||
will work in both cases. Some builds hardcode gcc/g++ in their build
|
will work in both cases. Some builds hardcode gcc/g++ in their build
|
||||||
scripts, that can usually be fixed with using something like
|
scripts, that can usually be fixed with using something like
|
||||||
|
@ -31,7 +31,7 @@
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
On darwin libraries are linked using absolute paths, libraries are
|
On Darwin, libraries are linked using absolute paths, libraries are
|
||||||
resolved by their <literal>install_name</literal> at link time. Sometimes
|
resolved by their <literal>install_name</literal> at link time. Sometimes
|
||||||
packages won't set this correctly causing the library lookups to fail at
|
packages won't set this correctly causing the library lookups to fail at
|
||||||
runtime. This can be fixed by adding extra linker flags or by running
|
runtime. This can be fixed by adding extra linker flags or by running
|
||||||
|
|
|
@ -17,27 +17,25 @@
|
||||||
</para>
|
</para>
|
||||||
</warning>
|
</warning>
|
||||||
<para>
|
<para>
|
||||||
The nixpkgs project receives a fairly high number of contributions via GitHub
|
The Nixpkgs project receives a fairly high number of contributions via GitHub
|
||||||
pull-requests. Reviewing and approving these is an important task and a way
|
pull-requests. Reviewing and approving these is an important task and a way
|
||||||
to contribute to the project.
|
to contribute to the project.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
The high change rate of nixpkgs makes any pull request that remains open for
|
The high change rate of Nixpkgs makes any pull-request that remains open for
|
||||||
too long subject to conflicts that will require extra work from the submitter
|
too long subject to conflicts that will require extra work from the submitter
|
||||||
or the merger. Reviewing pull requests in a timely manner and being
|
or the merger. Reviewing pull-requests in a timely manner and being responsive
|
||||||
responsive to the comments is the key to avoid these. GitHub provides sort
|
to the comments is the key to avoid this issue. GitHub provides sort filters
|
||||||
filters that can be used to see the
|
that can be used to see the <link
|
||||||
<link
|
xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most
|
||||||
xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most
|
recently</link> and the <link
|
||||||
recently</link> and the
|
xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least
|
||||||
<link
|
|
||||||
xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least
|
|
||||||
recently</link> updated pull-requests. We highly encourage looking at
|
recently</link> updated pull-requests. We highly encourage looking at
|
||||||
<link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone">
|
<link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone">
|
||||||
this list of ready to merge, unreviewed pull requests</link>.
|
this list of ready to merge, unreviewed pull-requests</link>.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
When reviewing a pull request, please always be nice and polite.
|
When reviewing a pull-request, please always be nice and polite.
|
||||||
Controversial changes can lead to controversial opinions, but it is important
|
Controversial changes can lead to controversial opinions, but it is important
|
||||||
to respect every community member and their work.
|
to respect every community member and their work.
|
||||||
</para>
|
</para>
|
||||||
|
@ -230,7 +228,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
|
||||||
<title>New packages</title>
|
<title>New packages</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
New packages are a common type of pull-requests. These pull requests
|
New packages are a common type of pull-requests. These pull-requests
|
||||||
consists in adding a new nix-expression for a package.
|
consists in adding a new nix-expression for a package.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
@ -279,7 +277,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
A maintainer must be set, this can be the package submitter or a
|
A maintainer must be set. This can be the package submitter or a
|
||||||
community member that accepts to take maintainership of the package.
|
community member that accepts to take maintainership of the package.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
@ -582,7 +580,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Container system, boot system and library changes are some examples of the
|
Container system, boot system and library changes are some examples of the
|
||||||
pull requests fitting this category.
|
pull-requests fitting this category.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
<section xml:id="reviewing-contributions--merging-pull-requests">
|
<section xml:id="reviewing-contributions--merging-pull-requests">
|
||||||
|
@ -590,7 +588,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
It is possible for community members that have enough knowledge and
|
It is possible for community members that have enough knowledge and
|
||||||
experience on a special topic to contribute by merging pull requests.
|
experience on a special topic to contribute by merging pull-requests.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
|
|
@ -581,7 +581,7 @@ let f(h, h + 1, i) = i + h
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term>
|
<term>
|
||||||
<varname>depsTargetTarget</varname>
|
<varname>depsTargetTargetPropagated</varname>
|
||||||
</term>
|
</term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
|
@ -836,7 +836,7 @@ passthru = {
|
||||||
<para>
|
<para>
|
||||||
Zip files are unpacked using <command>unzip</command>. However,
|
Zip files are unpacked using <command>unzip</command>. However,
|
||||||
<command>unzip</command> is not in the standard environment, so you
|
<command>unzip</command> is not in the standard environment, so you
|
||||||
should add it to <varname>buildInputs</varname> yourself.
|
should add it to <varname>nativeBuildInputs</varname> yourself.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
Loading…
Reference in New Issue
Block a user