Skip to content

Update README for variable path references and fix LLVM_TARGETS_TO_BUILD #19

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

Open
FlyMan2004 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README for variable path references and fix LLVM_TARGETS_TO_BUILD #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9127172
Update README for variable path references
FlyMan2004 May 16, 2026
7f3720b
fix: `LLVM_TARGETS_TO_BUILD` should be `LinxISA`, not `Linx`
FlyMan2004 May 16, 2026
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@
- Linx toolchain artifacts used by superproject gates

## Canonical Build and Test Commands
Run from `/Users/zhoubot/linx-isa`.
Run from `${LINX_ISA_ROOT}`.
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 16, 2026

Choose a reason for hiding this comment

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

medium

The instruction to run from ${LINX_ISA_ROOT} assumes the environment variable is already defined. For a user who has just cloned the repository, this variable will not exist. It is clearer to instruct the user to run from the repository root.

Suggested change
Run from `${LINX_ISA_ROOT}`.
Run from the repository root.


Comment on lines 15 to 17
```bash
cmake -S compiler/llvm/llvm -B compiler/llvm/build-linxisa-clang -G Ninja \
-DLLVM_ENABLE_PROJECTS="clang;lld" \
-DLLVM_TARGETS_TO_BUILD=Linx
-DLLVM_TARGETS_TO_BUILD=LinxISA
cmake --build compiler/llvm/build-linxisa-clang --target clang lld

cd /Users/zhoubot/linx-isa/avs/compiler/linx-llvm/tests
CLANG=/Users/zhoubot/linx-isa/compiler/llvm/build-linxisa-clang/bin/clang ./run.sh
CLANGXX=/Users/zhoubot/linx-isa/compiler/llvm/build-linxisa-clang/bin/clang++ ./run_cpp.sh
cd ${LINX_ISA_ROOT}/avs/compiler/linx-llvm/tests
CLANG=${LINX_ISA_ROOT}/compiler/llvm/build-linxisa-clang/bin/clang ./run.sh
CLANGXX=${LINX_ISA_ROOT}/compiler/llvm/build-linxisa-clang/bin/clang++ ./run_cpp.sh
```

## LinxISA Integration Touchpoints
Expand All @@ -32,6 +32,6 @@ CLANGXX=/Users/zhoubot/linx-isa/compiler/llvm/build-linxisa-clang/bin/clang++ ./
- ABI/runtime coupling with `lib/musl`, `lib/glibc`, and kernel userspace bring-up

## Related Docs
- `/Users/zhoubot/linx-isa/docs/project/navigation.md`
- `/Users/zhoubot/linx-isa/docs/bringup/`
- `/Users/zhoubot/linx-isa/avs/compiler/linx-llvm/README.md`
- `${LINX_ISA_ROOT}/docs/project/navigation.md`
- `${LINX_ISA_ROOT}/docs/bringup/`
- `${LINX_ISA_ROOT}/avs/compiler/linx-llvm/README.md`
Comment on lines +35 to +37
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 16, 2026

Choose a reason for hiding this comment

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

medium

Using environment variables in the 'Related Docs' section prevents these paths from being rendered as clickable links in most Markdown viewers (e.g., GitHub, VS Code). Using relative paths is more idiomatic for repository documentation and ensures the links are functional.

Suggested change
- `${LINX_ISA_ROOT}/docs/project/navigation.md`
- `${LINX_ISA_ROOT}/docs/bringup/`
- `${LINX_ISA_ROOT}/avs/compiler/linx-llvm/README.md`
- [docs/project/navigation.md](docs/project/navigation.md)
- [docs/bringup/](docs/bringup/)
- [avs/compiler/linx-llvm/README.md](avs/compiler/linx-llvm/README.md)

Loading