forked from mirrors/nixpkgs
nixpkgs docs: normalize
This commit is contained in:
Graham Christensen
parent
53371b15c6
commit
360f420ac7
|
|
@ -523,7 +523,8 @@ merge:"diff3"
|
||||||
<callout arearefs='ex-dockerTools-buildImage-2'>
|
<callout arearefs='ex-dockerTools-buildImage-2'>
|
||||||
<para>
|
<para>
|
||||||
<varname>tag</varname> specifies the tag of the resulting image. By
|
<varname>tag</varname> specifies the tag of the resulting image. By
|
||||||
default it's <literal>null</literal>, which indicates that the nix output hash will be used as tag.
|
default it's <literal>null</literal>, which indicates that the nix output
|
||||||
|
hash will be used as tag.
|
||||||
</para>
|
</para>
|
||||||
</callout>
|
</callout>
|
||||||
<callout arearefs='ex-dockerTools-buildImage-3'>
|
<callout arearefs='ex-dockerTools-buildImage-3'>
|
||||||
|
|
@ -669,12 +670,12 @@ merge:"diff3"
|
||||||
<para>
|
<para>
|
||||||
<varname>imageDigest</varname> specifies the digest of the image to be
|
<varname>imageDigest</varname> specifies the digest of the image to be
|
||||||
downloaded. Skopeo can be used to get the digest of an image, with its
|
downloaded. Skopeo can be used to get the digest of an image, with its
|
||||||
<varname>inspect</varname> subcommand. Since a given <varname>imageName</varname>
|
<varname>inspect</varname> subcommand. Since a given
|
||||||
may transparently refer to a manifest list of images which support
|
<varname>imageName</varname> may transparently refer to a manifest list
|
||||||
multiple architectures and/or operating systems, supply the `--override-os`
|
of images which support multiple architectures and/or operating systems,
|
||||||
and `--override-arch` arguments to specify exactly which image you
|
supply the `--override-os` and `--override-arch` arguments to specify
|
||||||
want. By default it will match the OS and architecture of the host the
|
exactly which image you want. By default it will match the OS and
|
||||||
command is run on.
|
architecture of the host the command is run on.
|
||||||
<programlisting>
|
<programlisting>
|
||||||
$ nix-shell --packages skopeo jq --command "skopeo --override-os linux --override-arch x86_64 inspect docker://docker.io/nixos/nix:1.11 | jq -r '.Digest'"
|
$ nix-shell --packages skopeo jq --command "skopeo --override-os linux --override-arch x86_64 inspect docker://docker.io/nixos/nix:1.11 | jq -r '.Digest'"
|
||||||
sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b
|
sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b
|
||||||
|
|
@ -697,16 +698,16 @@ merge:"diff3"
|
||||||
</para>
|
</para>
|
||||||
</callout>
|
</callout>
|
||||||
<callout arearefs='ex-dockerTools-pullImage-5'>
|
<callout arearefs='ex-dockerTools-pullImage-5'>
|
||||||
<para>
|
<para>
|
||||||
<varname>os</varname>, if specified, is the operating system of the fetched image.
|
<varname>os</varname>, if specified, is the operating system of the
|
||||||
By default it's <literal>linux</literal>.
|
fetched image. By default it's <literal>linux</literal>.
|
||||||
</para>
|
</para>
|
||||||
</callout>
|
</callout>
|
||||||
<callout arearefs='ex-dockerTools-pullImage-6'>
|
<callout arearefs='ex-dockerTools-pullImage-6'>
|
||||||
<para>
|
<para>
|
||||||
<varname>arch</varname>, if specified, is the cpu architecture of the fetched image.
|
<varname>arch</varname>, if specified, is the cpu architecture of the
|
||||||
By default it's <literal>x86_64</literal>.
|
fetched image. By default it's <literal>x86_64</literal>.
|
||||||
</para>
|
</para>
|
||||||
</callout>
|
</callout>
|
||||||
</calloutlist>
|
</calloutlist>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
||||||
|
|
@ -16,18 +16,17 @@ stdenv.mkDerivation {
|
||||||
}
|
}
|
||||||
</programlisting>
|
</programlisting>
|
||||||
Note that <varname>jdk</varname> is an alias for the OpenJDK (self-built
|
Note that <varname>jdk</varname> is an alias for the OpenJDK (self-built
|
||||||
where available, or pre-built via Zulu).
|
where available, or pre-built via Zulu). Platforms with OpenJDK not (yet) in
|
||||||
Platforms with OpenJDK not (yet) in Nixpkgs (<literal>Aarch32</literal>,
|
Nixpkgs (<literal>Aarch32</literal>, <literal>Aarch64</literal>) point to the
|
||||||
<literal>Aarch64</literal>) point to the (unfree)
|
(unfree) <literal>oraclejdk</literal>.
|
||||||
<literal>oraclejdk</literal>.
|
</para>
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
JAR files that are intended to be used by other packages should be installed
|
JAR files that are intended to be used by other packages should be installed
|
||||||
in <filename>$out/share/java</filename>. JDKs have a stdenv setup hook
|
in <filename>$out/share/java</filename>. JDKs have a stdenv setup hook that
|
||||||
that add any JARs in the <filename>share/java</filename> directories of the
|
add any JARs in the <filename>share/java</filename> directories of the build
|
||||||
build inputs to the <envar>CLASSPATH</envar> environment variable. For
|
inputs to the <envar>CLASSPATH</envar> environment variable. For instance, if
|
||||||
instance, if the package <literal>libfoo</literal> installs a JAR named
|
the package <literal>libfoo</literal> installs a JAR named
|
||||||
<filename>foo.jar</filename> in its <filename>share/java</filename>
|
<filename>foo.jar</filename> in its <filename>share/java</filename>
|
||||||
directory, and another package declares the attribute
|
directory, and another package declares the attribute
|
||||||
<programlisting>
|
<programlisting>
|
||||||
|
|
@ -61,18 +60,17 @@ installPhase =
|
||||||
<literal>${jre}/bin/java</literal> instead of
|
<literal>${jre}/bin/java</literal> instead of
|
||||||
<literal>${jdk}/bin/java</literal>, you prevent your package from depending
|
<literal>${jdk}/bin/java</literal>, you prevent your package from depending
|
||||||
on the JDK at runtime.
|
on the JDK at runtime.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Note all JDKs passthru <literal>home</literal>, so if your application
|
Note all JDKs passthru <literal>home</literal>, so if your application
|
||||||
requires environment variables like <envar>JAVA_HOME</envar> being set, that
|
requires environment variables like <envar>JAVA_HOME</envar> being set, that
|
||||||
can be done in a generic fashion with the <literal>--set</literal> argument
|
can be done in a generic fashion with the <literal>--set</literal> argument
|
||||||
of <literal>makeWrapper</literal>:
|
of <literal>makeWrapper</literal>:
|
||||||
|
|
||||||
<programlisting>
|
<programlisting>
|
||||||
--set JAVA_HOME ${jdk.home}
|
--set JAVA_HOME ${jdk.home}
|
||||||
</programlisting>
|
</programlisting>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
It is possible to use a different Java compiler than <command>javac</command>
|
It is possible to use a different Java compiler than <command>javac</command>
|
||||||
|
|
|
||||||
|
|
@ -709,40 +709,50 @@ overrides = super: self: rec {
|
||||||
<title>Citrix Receiver</title>
|
<title>Citrix Receiver</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The <link xlink:href="https://www.citrix.com/products/receiver/">Citrix Receiver</link> is a remote
|
The <link xlink:href="https://www.citrix.com/products/receiver/">Citrix
|
||||||
desktop viewer which provides access to
|
Receiver</link> is a remote desktop viewer which provides access to
|
||||||
<link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link> installations.
|
<link xlink:href="https://www.citrix.com/products/xenapp-xendesktop/">XenDesktop</link>
|
||||||
|
installations.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<section xml:id="sec-citrix-base">
|
<section xml:id="sec-citrix-base">
|
||||||
<title>Basic usage</title>
|
<title>Basic usage</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The tarball archive needs to be downloaded manually as the licenses agreements of the vendor
|
The tarball archive needs to be downloaded manually as the licenses
|
||||||
need to be accepted first. This is available at the
|
agreements of the vendor need to be accepted first. This is available at
|
||||||
<link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">download page at citrix.com</link>.
|
the
|
||||||
Then run <literal>nix-prefetch-url file://$PWD/linuxx64-$version.tar.gz</literal>.
|
<link xlink:href="https://www.citrix.com/downloads/citrix-receiver/">download
|
||||||
With the archive available in the store the package can be built and installed with Nix.
|
page at citrix.com</link>. Then run <literal>nix-prefetch-url
|
||||||
|
file://$PWD/linuxx64-$version.tar.gz</literal>. With the archive available
|
||||||
|
in the store the package can be built and installed with Nix.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
<emphasis>Note: it's recommended to install <literal>Citrix Receiver</literal> using
|
<emphasis>Note: it's recommended to install <literal>Citrix
|
||||||
<literal>nix-env -i</literal> or globally to ensure that the <literal>.desktop</literal> files
|
Receiver</literal> using <literal>nix-env -i</literal> or globally to
|
||||||
are installed properly into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it won't
|
ensure that the <literal>.desktop</literal> files are installed properly
|
||||||
be possible to open <literal>.ica</literal> files
|
into <literal>$XDG_CONFIG_DIRS</literal>. Otherwise it won't be possible to
|
||||||
automatically from the browser to start a Citrix connection.</emphasis>
|
open <literal>.ica</literal> files automatically from the browser to start
|
||||||
|
a Citrix connection.</emphasis>
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section xml:id="sec-citrix-custom-certs">
|
<section xml:id="sec-citrix-custom-certs">
|
||||||
<title>Custom certificates</title>
|
<title>Custom certificates</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The <literal>Citrix Receiver</literal> in <literal>nixpkgs</literal> trusts several certificates
|
The <literal>Citrix Receiver</literal> in <literal>nixpkgs</literal> trusts
|
||||||
<link xlink:href="https://curl.haxx.se/docs/caextract.html">from the Mozilla database</link> by default.
|
several certificates
|
||||||
However several companies using Citrix might require their own corporate certificate. On distros with imperative
|
<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
|
||||||
packaging these certs can be stored easily in
|
packaging these certs can be stored easily in
|
||||||
<link xlink:href="https://developer-docs.citrix.com/projects/receiver-for-linux-command-reference/en/13.7/"><literal>$ICAROOT</literal></link>,
|
<link xlink:href="https://developer-docs.citrix.com/projects/receiver-for-linux-command-reference/en/13.7/"><literal>$ICAROOT</literal></link>,
|
||||||
however this directory is a store path in <literal>nixpkgs</literal>. In order to work around this issue the package provides a simple
|
however this directory is a store path in <literal>nixpkgs</literal>. In
|
||||||
mechanism to add custom certificates without rebuilding the entire package using <literal>symlinkJoin</literal>:
|
order to work around this issue the package provides a simple mechanism to
|
||||||
|
add custom certificates without rebuilding the entire package using
|
||||||
|
<literal>symlinkJoin</literal>:
|
||||||
<programlisting>
|
<programlisting>
|
||||||
<![CDATA[with import <nixpkgs> { config.allowUnfree = true; };
|
<![CDATA[with import <nixpkgs> { config.allowUnfree = true; };
|
||||||
let extraCerts = [ ./custom-cert-1.pem ./custom-cert-2.pem /* ... */ ]; in
|
let extraCerts = [ ./custom-cert-1.pem ./custom-cert-2.pem /* ... */ ]; in
|
||||||
|
|
|
||||||
|
|
@ -29,7 +29,6 @@
|
||||||
}
|
}
|
||||||
</programlisting>
|
</programlisting>
|
||||||
</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
|
||||||
|
|
@ -47,19 +46,19 @@
|
||||||
}
|
}
|
||||||
</programlisting>
|
</programlisting>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Even if the libraries are linked using absolute paths and resolved via
|
Even if the libraries are linked using absolute paths and resolved via
|
||||||
their <literal>install_name</literal> correctly, tests can sometimes fail
|
their <literal>install_name</literal> correctly, tests can sometimes fail
|
||||||
to run binaries. This happens because the <varname>checkPhase</varname>
|
to run binaries. This happens because the <varname>checkPhase</varname>
|
||||||
runs before the libraries are installed.
|
runs before the libraries are installed.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
This can usually be solved by running the tests after the
|
This can usually be solved by running the tests after the
|
||||||
<varname>installPhase</varname> or alternatively by using
|
<varname>installPhase</varname> or alternatively by using
|
||||||
<varname>DYLD_LIBRARY_PATH</varname>. More information about this variable
|
<varname>DYLD_LIBRARY_PATH</varname>. More information about this variable
|
||||||
can be found in the <citerefentry><refentrytitle>dyld</refentrytitle>
|
can be found in the <citerefentry>
|
||||||
|
<refentrytitle>dyld</refentrytitle>
|
||||||
<manvolnum>1</manvolnum></citerefentry> manpage.
|
<manvolnum>1</manvolnum></citerefentry> manpage.
|
||||||
</para>
|
</para>
|
||||||
<programlisting>
|
<programlisting>
|
||||||
|
|
@ -77,7 +76,6 @@
|
||||||
}
|
}
|
||||||
</programlisting>
|
</programlisting>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Some packages assume xcode is available and use <command>xcrun</command>
|
Some packages assume xcode is available and use <command>xcrun</command>
|
||||||
|
|
|
||||||
|
|
@ -6,18 +6,20 @@
|
||||||
<title>Reviewing contributions</title>
|
<title>Reviewing contributions</title>
|
||||||
<warning>
|
<warning>
|
||||||
<para>
|
<para>
|
||||||
The following section is a draft, and the policy for reviewing is still being
|
The following section is a draft, and the policy for reviewing is still
|
||||||
discussed in issues such as <link
|
being discussed in issues such as
|
||||||
|
<link
|
||||||
xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166
|
xlink:href="https://github.com/NixOS/nixpkgs/issues/11166">#11166
|
||||||
</link> and <link
|
</link> and
|
||||||
|
<link
|
||||||
xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836
|
xlink:href="https://github.com/NixOS/nixpkgs/issues/20836">#20836
|
||||||
</link>.
|
</link>.
|
||||||
</para>
|
</para>
|
||||||
</warning>
|
</warning>
|
||||||
<para>
|
<para>
|
||||||
The nixpkgs project receives a fairly high number of contributions via
|
The nixpkgs project receives a fairly high number of contributions via GitHub
|
||||||
GitHub pull-requests. Reviewing and approving these is an important task and
|
pull-requests. Reviewing and approving these is an important task and a way
|
||||||
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
|
||||||
|
|
@ -40,10 +42,10 @@
|
||||||
to respect every community member and their work.
|
to respect every community member and their work.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
GitHub provides reactions as a simple and quick way to provide
|
GitHub provides reactions as a simple and quick way to provide feedback to
|
||||||
feedback to pull-requests or any comments. The thumb-down reaction should be
|
pull-requests or any comments. The thumb-down reaction should be used with
|
||||||
used with care and if possible accompanied with some explanation so the
|
care and if possible accompanied with some explanation so the submitter has
|
||||||
submitter has directions to improve their contribution.
|
directions to improve their contribution.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
Pull-request reviews should include a list of what has been reviewed in a
|
Pull-request reviews should include a list of what has been reviewed in a
|
||||||
|
|
@ -117,8 +119,8 @@
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
License can change with version updates, so it should be checked to match
|
License can change with version updates, so it should be checked to
|
||||||
the upstream license.
|
match the upstream license.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
|
|
@ -143,8 +145,8 @@
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Pull-requests are often targeted to the master or staging branch, and
|
Pull-requests are often targeted to the master or staging branch, and
|
||||||
building the pull-request locally when it is submitted can trigger
|
building the pull-request locally when it is submitted can trigger many
|
||||||
many source builds.
|
source builds.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
It is possible to rebase the changes on nixos-unstable or
|
It is possible to rebase the changes on nixos-unstable or
|
||||||
|
|
@ -605,11 +607,12 @@ policy.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
In a case a contributor leaves definitively the Nix community, he
|
In a case a contributor leaves definitively the Nix community, he should
|
||||||
should create an issue or post on <link
|
create an issue or post on
|
||||||
|
<link
|
||||||
xlink:href="https://discourse.nixos.org">Discourse</link> with
|
xlink:href="https://discourse.nixos.org">Discourse</link> with
|
||||||
references of packages and modules he maintains so the
|
references of packages and modules he maintains so the maintainership can be
|
||||||
maintainership can be taken over by other contributors.
|
taken over by other contributors.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
</chapter>
|
</chapter>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue