summary refs log tree commit diff
path: root/doc/cross-compilation.xml
diff options
context:
space:
mode:
authorJohn Ericson <John.Ericson@Obsidian.Systems>2018-08-27 14:39:58 -0400
committerJohn Ericson <John.Ericson@Obsidian.Systems>2018-09-05 11:53:51 -0400
commite51f736076548459f36a1250de4bf6867f880b66 (patch)
treec2a7424011a0f04baaa2b1d2b1b03b553faa8c57 /doc/cross-compilation.xml
parent51907d257cac16eb7d45a3a35a57bad69bbe8c46 (diff)
downloadnixpkgs-e51f736076548459f36a1250de4bf6867f880b66.tar
nixpkgs-e51f736076548459f36a1250de4bf6867f880b66.tar.gz
nixpkgs-e51f736076548459f36a1250de4bf6867f880b66.tar.bz2
nixpkgs-e51f736076548459f36a1250de4bf6867f880b66.tar.lz
nixpkgs-e51f736076548459f36a1250de4bf6867f880b66.tar.xz
nixpkgs-e51f736076548459f36a1250de4bf6867f880b66.tar.zst
nixpkgs-e51f736076548459f36a1250de4bf6867f880b66.zip
top-level: Deprecate top-level `{build,host,target}Platform`
I don't know when we can/should remove them, but this at least gets
people to stop using them. The preferred alternatives also date back to
17.09 so writing forward-compatable code without extra conditions is
easy.

Beginning with these as they are the least controversial.
Diffstat (limited to 'doc/cross-compilation.xml')
-rw-r--r--doc/cross-compilation.xml10
1 files changed, 3 insertions, 7 deletions
diff --git a/doc/cross-compilation.xml b/doc/cross-compilation.xml
index 3b90596bcc2..c7187d86d1b 100644
--- a/doc/cross-compilation.xml
+++ b/doc/cross-compilation.xml
@@ -47,13 +47,9 @@
 
    <para>
     In Nixpkgs, these three platforms are defined as attribute sets under the
-    names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>,
-    and <literal>targetPlatform</literal>. All three are always defined as
-    attributes in the standard environment, and at the top level. That means
-    one can get at them just like a dependency in a function that is imported
-    with <literal>callPackage</literal>:
-<programlisting>{ stdenv, buildPlatform, hostPlatform, fooDep, barDep, .. }: ...buildPlatform...</programlisting>
-    , or just off <varname>stdenv</varname>:
+    names <literal>buildPlatform</literal>, <literal>hostPlatform</literal>, and
+    <literal>targetPlatform</literal>. They are always defined as attributes in
+    the standard environment. That means one can access them like:
 <programlisting>{ stdenv, fooDep, barDep, .. }: ...stdenv.buildPlatform...</programlisting>
     .
    </para>