Commit e51f7360 authored by John Ericson's avatar John Ericson
Browse files

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.
parent 51907d25

doc/cross-compilation.xml

+3 −7
Original line number Diff line number Diff line
@@ -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>

pkgs/top-level/stage.nix

+11 −5
Original line number Diff line number Diff line
@@ -79,11 +79,17 @@ let 


  # The old identifiers for cross-compiling. These should eventually be removed,

  # and the packages that rely on them refactored accordingly.

  platformCompat = self: super: let

    inherit (super.stdenv) buildPlatform hostPlatform targetPlatform;

  in {

    inherit buildPlatform hostPlatform targetPlatform;

    inherit (buildPlatform) system;

  platformCompat = self: super: {

    buildPlatform = lib.warn

      "top-level `buildPlatform` is deprecated since 18.09. Please use `stdenv.buildPlatform`."

      super.stdenv.buildPlatform;

    hostPlatform = lib.warn

      "top-level `hostPlatform` is deprecated since 18.09. Please use `stdenv.hostPlatform`."

      super.stdenv.hostPlatform;

    targetPlatform = lib.warn

      "top-level `targetPlatform` is deprecated since 18.09. Please use `stdenv.targetPlatform`."

      super.stdenv.targetPlatform;

    inherit (super.stdenv.buildPlatform) system;

  };



  splice = self: super: import ./splice.nix lib self (buildPackages != null);