diff --git a/doc/cross-compilation.xml b/doc/cross-compilation.xml index 3e67944e58f7..10e4706b0590 100644 --- a/doc/cross-compilation.xml +++ b/doc/cross-compilation.xml @@ -256,6 +256,16 @@ You can use them programmatically, or on the command line: nix-build <nixpkgs> --arg crossSystem '(import <nixpkgs/lib>).systems.examples.fooBarBaz' -A whatever + + + Eventually we would like to make these platform examples an unnecessary convenience so that +nix-build <nixpkgs> --arg crossSystem.config '<arch>-<os>-<vendor>-<abi>' -A whatever + 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 #34274 tracks this inconvenience along with its root cause in crufty configuration options. + + While one is free to pass both parameters in full, there's a lot of logic to fill in missing fields. As discussed in the previous section, only one of system, config, and parsed is needed to infer the other two.