summary refs log tree commit diff
path: root/doc/cross-compilation.xml
diff options
context:
space:
mode:
authorJohn Ericson <John.Ericson@Obsidian.Systems>2018-09-23 13:18:38 -0400
committerJohn Ericson <John.Ericson@Obsidian.Systems>2018-09-23 13:25:44 -0400
commite39a73cc55bf6fb9559d9d51e1959a5340c2510b (patch)
treebf5af6c62be43d8de7774b10a6ed82567363327a /doc/cross-compilation.xml
parent359d00f8b0990fdad0bf308e355490058f264ca2 (diff)
downloadnixlib-e39a73cc55bf6fb9559d9d51e1959a5340c2510b.tar
nixlib-e39a73cc55bf6fb9559d9d51e1959a5340c2510b.tar.gz
nixlib-e39a73cc55bf6fb9559d9d51e1959a5340c2510b.tar.bz2
nixlib-e39a73cc55bf6fb9559d9d51e1959a5340c2510b.tar.lz
nixlib-e39a73cc55bf6fb9559d9d51e1959a5340c2510b.tar.xz
nixlib-e39a73cc55bf6fb9559d9d51e1959a5340c2510b.tar.zst
nixlib-e39a73cc55bf6fb9559d9d51e1959a5340c2510b.zip
doc: Don't mention top-level `{build, host, target}Platform`
For technical reasons, we cannot easily add a warning to top-level
definitions, so 2a6e4ae49a891adc7c0562fda08b17d60beb1b4f and
e51f736076548459f36a1250de4bf6867f880b66 reverted the deprecation. But
we can still remove mention of the would-be deprecated definitions to
steer people towards using the preferred alternatives.
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 3b90596bcc2c..c7187d86d1b3 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>