Skip to content

[LLVM][DOCS] Add documentation for 'host' and 'Native' options in LLVM_TARGETS_TO_BUILD. #111382

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

Merged
merged 5 commits into from
Oct 10, 2024
Merged

[LLVM][DOCS] Add documentation for 'host' and 'Native' options in LLVM_TARGETS_TO_BUILD. #111382

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
90e97b6
[LLVM][DOCS] Add documentation for 'host' and 'Native' options in LLV…
harrisonGPU Oct 7, 2024
4fb7d22
[DOCS] Update for comments.
harrisonGPU Oct 7, 2024
52519ba
[DOCS] Add 'all' target comments.
harrisonGPU Oct 7, 2024
fb17779
Merge branch 'main' into harrison/llvm/doc
harrisonGPU Oct 8, 2024
56a1346
Merge branch 'main' into harrison/llvm/doc
harrisonGPU Oct 8, 2024
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: 6 additions & 0 deletions llvm/docs/CMake.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -836,6 +836,12 @@ enabled sub-projects. Nearly all of these variable names begin with
The full list, as of March 2023, is:
``AArch64;AMDGPU;ARM;AVR;BPF;Hexagon;Lanai;LoongArch;Mips;MSP430;NVPTX;PowerPC;RISCV;Sparc;SystemZ;VE;WebAssembly;X86;XCore``

You can also specify ``host`` or ``Native`` to automatically detect and
Copy link
Member

Choose a reason for hiding this comment

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

Just document the common host and omit Native?

Copy link

Choose a reason for hiding this comment

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

It is good to only promote one canonical symbolic name, e.g. host. However, for someone reading the documentation for understanding some project found on the net, it is really important that all accepted names are documented.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, thanks.

include the target corresponding to the host machine's architecture, or
use ``all`` to include all available targets.
Copy link
Contributor

Choose a reason for hiding this comment

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

Note that all is already mentioned above (in the part that github helpfully hides by default).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, thanks!

For example, on an x86_64 machine, specifying ``-DLLVM_TARGETS_TO_BUILD=host``
will include the ``X86`` target.

**LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN**:BOOL
If enabled, the compiler version check will only warn when using a toolchain
which is about to be deprecated, instead of emitting an error.
Expand Down
Loading