Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc/stdenv/cross-compilation.chapter.md: explain tuples #180030

Closed
wants to merge 9 commits into from
Closed

doc/stdenv/cross-compilation.chapter.md: explain tuples #180030

Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4c59f44
doc/stdenv/cross-compilation.chapter.md: explain tuples
Jul 3, 2022
35475b8
Update doc/stdenv/cross-compilation.chapter.md
Jul 4, 2022
1e28866
minimize reference to multiarch, mentioning it only in the case where…
Jul 4, 2022
a0b3adf
"Nix host double" -> "Nix system double", "the previous format" -> "t…
Jul 4, 2022
dd6235b
remove mention of multiarch
Jul 4, 2022
f34b04e
add link to LLVM triples documentation
Jul 4, 2022
494a1fd
cross-compilation.md: correct the authoritative source of config.sub
Aug 1, 2022
c3d8109
Update doc/stdenv/cross-compilation.chapter.md
Apr 24, 2023
d110097
fix trailing whitespace
Apr 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion doc/stdenv/cross-compilation.chapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ The exact schema these fields follow is a bit ill-defined due to a long and conv

`config`

: This is a 3- or 4- component shorthand for the platform. Examples of this would be `x86_64-unknown-linux-gnu` and `aarch64-apple-darwin14`. This is a standard format called the "LLVM target triple", as they are pioneered by LLVM. In the 4-part form, this corresponds to `[cpu]-[vendor]-[os]-[abi]`. This format is strictly more informative than the "Nix host double", as the previous format could analogously be termed. This needs a better name than `config`!
: This is a 3-, 4-, or 5- component shorthand for the platform. Examples of this would be `x86_64-unknown-linux-gnux32`, `aarch64-apple-darwin14`, and `mips64el-unknown-linux-muslabin32`. This is a standard format [pioneered by autoconf](https://www.gnu.org/software/autoconf/manual/autoconf-2.65/html_node/System-Type.html#System-Type) and [adopted by LLVM](https://clang.llvm.org/docs/CrossCompilation.html#target-triple).

In the 5-part form, this corresponds to `[cpu]-[vendor]-[os]-[libc][abi]`; note that there is no hyphen separating the `[libc]` field from the `[abi]` field. This format is strictly more informative than the "Nix system double", the format used by the nix interpreter. This needs a better name than `config`!
This conversation was marked as resolved.
Show resolved Hide resolved

This field should be *canonicalized*. The rules for canonicalizing a tuple are kept in the `config.sub` file in the source code for `gnu-config`.
Comment on lines +68 to +69
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand what this means. Is "should be canonicalized" a recommendation to the user? What is gnu-configand where is this config.subfile? I suppose you mean this file?

Unless you want to clarify this, I'd just leave it out and fix later if the need arises.

Suggested change
This field should be *canonicalized*. The rules for canonicalizing a tuple are kept in the `config.sub` file in the source code for `gnu-config`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems you moved that line to the end, which seems sensible. I still don't know what it means, so once you address the original comment, for me this is ready to merge.


`parsed`

Expand Down