Skip to content

Conversation

@doofin
Copy link
Contributor

@doofin doofin commented Nov 7, 2025

Hi, this PR add more details about building specific part

@dobios
Copy link
Member

dobios commented Nov 21, 2025

While we're at it, we should probably also add the lld linker flag to the readme as it's rough to compiler llvm without it:

-DLLVM_ENABLE_LLD=ON

Copy link
Member

@dobios dobios left a comment

Choose a reason for hiding this comment

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

Don't want to make the wording more confusing in the readme, so here are a few suggestions.

@dobios dobios changed the title docs: Update README.md with enhanced build instructions for CIRCT [NFC][Docs] Update README.md with enhanced build instructions for CIRCT Nov 21, 2025
doofin and others added 2 commits November 25, 2025 12:40
Co-authored-by: Amelia Dobis <[email protected]>
Co-authored-by: Amelia Dobis <[email protected]>
@doofin doofin requested a review from dobios November 25, 2025 04:43
@doofin
Copy link
Contributor Author

doofin commented Nov 25, 2025

Thanks @dobios , I applied your suggestions.

README.md Outdated
If you want to only build a specific part, for example the `circt-opt` tool:
```sh
ninja -C build circt-opt
\```
Copy link
Member

Choose a reason for hiding this comment

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

stray backslash

@dobios
Copy link
Member

dobios commented Nov 27, 2025

While we're at it, we should probably also add the lld linker flag to the readme as it's rough to compiler llvm without it:

-DLLVM_ENABLE_LLD=ON

I also suggest taking this comment into account

@doofin
Copy link
Contributor Author

doofin commented Nov 27, 2025

While we're at it, we should probably also add the lld linker flag to the readme as it's rough to compiler llvm without it:

-DLLVM_ENABLE_LLD=ON

I also suggest taking this comment into account

it's here https://github.com/llvm/circt/pull/9203/files?short_path=b335630#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5

@doofin doofin requested a review from dobios November 27, 2025 11:47
@TaoBi22
Copy link
Contributor

TaoBi22 commented Nov 27, 2025

While we're at it, we should probably also add the lld linker flag to the readme as it's rough to compiler llvm without it:

-DLLVM_ENABLE_LLD=ON

I also suggest taking this comment into account

Fly-by nit but lld isn't in our dependency list so I'm not sure we want it to depend in the default build command - might be worth documenting it as an option separately from the default command?

@dobios
Copy link
Member

dobios commented Nov 27, 2025

While we're at it, we should probably also add the lld linker flag to the readme as it's rough to compiler llvm without it:

-DLLVM_ENABLE_LLD=ON

I also suggest taking this comment into account

Fly-by nit but lld isn't in our dependency list so I'm not sure we want it to depend in the default build command - might be worth documenting it as an option separately from the default command?

@TaoBi22 isn't lld part of llvm?

@TaoBi22
Copy link
Contributor

TaoBi22 commented Nov 28, 2025

@TaoBi22 isn't lld part of llvm?

It is, but it's not built or installed by the existing command, so someone who doesn't have an existing lld install would still get hit by an opaque error following the instructions

@dobios
Copy link
Member

dobios commented Nov 29, 2025

@TaoBi22 isn't lld part of llvm?

It is, but it's not built or installed by the existing command, so someone who doesn't have an existing lld install would still get hit by an opaque error following the instructions

It's currently part of the "getting started" command though, and linking LLVM with the default linker requires something like 64Gb or memory, so it will crash for most systems without an absurd amount of swap. But yeah if you think it's best to leave it out, your reasoning does make sense

@doofin
Copy link
Contributor Author

doofin commented Dec 1, 2025

@dobios please help me merge this since it's approved, thanks!

@dobios dobios merged commit 4c86425 into llvm:main Dec 1, 2025
7 checks passed
@doofin doofin deleted the docs/build branch December 2, 2025 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants