Skip to content

docs/GettingStarted: document linker-related cmake options #80932

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.

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 3 commits into from
Feb 8, 2024

Conversation

nhaehnle
Copy link
Collaborator

@nhaehnle nhaehnle commented Feb 7, 2024

Both LLVM_LINK_LLVM_DYLIB and LLVM_PARALLEL_LINK_JOBS help with some common gotchas. It seems worth documenting them here explicitly.

Both LLVM_LINK_LLVM_DYLIB and LLVM_PARALLEL_LINK_JOBS help with some
common gotchas. It seems worth documenting them here explicitly.
@MaskRay
Copy link
Member

MaskRay commented Feb 7, 2024

I agree that LLVM_PARALLEL_LINK_JOBS is a frequently used option, but the option documentation duplication makes me nervous (status quo). I wonder whether this section should list option names without (duplicated) description and refer readers to CMake.html.

I took the liberty of moving LLVM_ENABLE_DOXYGEN to keep
thematically-related variables closer together.
@nhaehnle
Copy link
Collaborator Author

nhaehnle commented Feb 7, 2024

That's a fair point. How about this?

| | the LLVM build. This can dramatically speed up |
| | debug builds. |
+-------------------------+----------------------------------------------------+
* CMAKE_C_COMPILER
Copy link
Member

Choose a reason for hiding this comment

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

Add double backticks to quote each variable

@nhaehnle nhaehnle merged commit c0ff108 into llvm:main Feb 8, 2024
@nhaehnle nhaehnle deleted the pub-cmake-docs branch February 8, 2024 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants