git.iko.soy/typeable/nixpkgs
on master help sign in
Merge pull request #69060 from alexfmpe/fix-example

Fix example

commitba91110c613e239a457ff8640008ce4107feb01f authorMatthew Bauer <mjbauer95@gmail.com> dateThu 19 Sep 2019, 10:36 (7 years ago) parentb24afa99b184c1
1 file changed+2−2
doc/cross-compilation.xml+2−2
doc/cross-compilation.xml+2−2
@@ -271,14 +271,14 @@
271271 <para>
272272 Nixpkgs can be instantiated with <varname>localSystem</varname> alone, in which case there is no cross-compiling and everything is built by and for that system, or also with <varname>crossSystem</varname>, in which case packages run on the latter, but all building happens on the former. Both parameters take the same schema as the 3 (build, host, and target) platforms defined in the previous section. As mentioned above, <literal>lib.systems.examples</literal> has some platforms which are used as arguments for these parameters in practice. You can use them programmatically, or on the command line:
273273<programlisting>
274−nix-build &lt;nixpkgs&gt; --arg crossSystem '(import &lt;nixpkgs/lib&gt;).systems.examples.fooBarBaz' -A whatever</programlisting>
274+nix-build '&lt;nixpkgs&gt;' --arg crossSystem '(import &lt;nixpkgs/lib&gt;).systems.examples.fooBarBaz' -A whatever</programlisting>
275275 </para>
276276
277277 <note>
278278 <para>
279279 Eventually we would like to make these platform examples an unnecessary convenience so that
280280<programlisting>
281−nix-build &lt;nixpkgs&gt; --arg crossSystem '{ config = "&lt;arch&gt;-&lt;os&gt;-&lt;vendor&gt;-&lt;abi&gt;"; }' -A whatever</programlisting>
281+nix-build '&lt;nixpkgs&gt;' --arg crossSystem '{ config = "&lt;arch&gt;-&lt;os&gt;-&lt;vendor&gt;-&lt;abi&gt;"; }' -A whatever</programlisting>
282282 works in the vast majority of cases. The problem today is dependencies on other sorts of configuration which aren't given proper defaults. We rely on the examples to crudely to set those configuration parameters in some vaguely sane manner on the users behalf. Issue <link xlink:href="https://github.com/NixOS/nixpkgs/issues/34274">#34274</link> tracks this inconvenience along with its root cause in crufty configuration options.
283283 </para>
284284 </note>