Docs: fix "building" documentation w.r.t. meson #12977
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
edolstra
approved these changes
Apr 9, 2025
|
|
||
| ``` | ||
| <cpu>-<vendor>-<os>[<version>][-<abi>] | ||
| ``` | ||
|
|
||
| When Nix is built such that `./configure` is passed any of the `--host`, `--build`, `--target` options, the value is based on the output of [`config.sub`](https://github.com/nixos/nix/blob/master/config/config.sub) ([upstream](https://git.savannah.gnu.org/cgit/config.git/tree/config.sub)): | ||
| When cross-compiling Nix with Meson, you need to specify a [cross-file](https://mesonbuild.com/Cross-compilation.html) using the `--cross-file` option. Cross-files define the target architecture and toolchain. |
There was a problem hiding this comment.
Maybe we should point people to the cross flake outputs here (e.g. nix build .#nix-everything-riscv64-unknown-linux-gnu).
roberth
changed the title
Co-authored-by: Eelco Dolstra <[email protected]>
roberth
reviewed
Apr 20, 2025
|
|
||
| ``` | ||
| <cpu>-<vendor>-<os>[<version>][-<abi>] | ||
| ``` | ||
|
|
||
| When Nix is built such that `./configure` is passed any of the `--host`, `--build`, `--target` options, the value is based on the output of [`config.sub`](https://github.com/nixos/nix/blob/master/config/config.sub) ([upstream](https://git.savannah.gnu.org/cgit/config.git/tree/config.sub)): | ||
| When cross-compiling Nix with Meson, you need to specify a [cross-file](https://mesonbuild.com/Cross-compilation.html) using the `--cross-file` option. Cross-files define the target architecture and toolchain. |
There was a problem hiding this comment.
Suggested change
| When cross-compiling Nix with Meson, you need to specify a [cross-file](https://mesonbuild.com/Cross-compilation.html) using the `--cross-file` option. Cross-files define the target architecture and toolchain. | |
| When cross-compiling Nix with Meson for local development, you need to specify a [cross-file](https://mesonbuild.com/Cross-compilation.html) using the `--cross-file` option. Cross-files define the target architecture and toolchain. | |
| When cross-compiling Nix with Nix, Nixpkgs takes care of this for you. |
There was a problem hiding this comment.
This section isn't really about cross compiling, so I'm not sure that we need to be entirely specific in this particular place, but it'd be good to catch a somewhat lost reader here. Doing all this is quite the detour if you're not doing it for local dev.
Ericson2314
reviewed
Apr 20, 2025
Comment on lines
-206
to
-219
| ``` | ||
| <cpu>-<vendor>[-<kernel>]-<os> | ||
| ``` | ||
|
|
||
| For historic reasons and backward-compatibility, some CPU and OS identifiers are translated from the GNU Autotools naming convention in [`configure.ac`](https://github.com/nixos/nix/blob/master/configure.ac) as follows: | ||
|
|
||
| | `config.guess` | Nix | | ||
| |----------------------------|---------------------| | ||
| | `amd64` | `x86_64` | | ||
| | `i*86` | `i686` | | ||
| | `arm6` | `arm6l` | | ||
| | `arm7` | `arm7l` | | ||
| | `linux-gnu*` | `linux` | | ||
| | `linux-musl*` | `linux` | |
There was a problem hiding this comment.
I think we should document how the system differs from Meson's defaults likewise? we have
host_machine.cpu_family() + '-' + host_machine.system()currently, but I recall there was an issue pointing out this cases a regression with Power CPUs, and responded that a PR making a special case would be welcome. That is the sort of thing we'd document here.
There was a problem hiding this comment.
#12769 this is the issue I was thinking of.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
fixes #12934
Context
Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.