Skip to content

Update README for variable path references and fix LLVM_TARGETS_TO_BUILD#19

Open
FlyMan2004 wants to merge 2 commits into
LinxISA:mainfrom
FlyMan2004:FlyMan2004-patch-fix-readme
Open

Update README for variable path references and fix LLVM_TARGETS_TO_BUILD#19
FlyMan2004 wants to merge 2 commits into
LinxISA:mainfrom
FlyMan2004:FlyMan2004-patch-fix-readme

Conversation

@FlyMan2004
Copy link
Copy Markdown

This pull request updates the README.md to improve portability and clarity by replacing hardcoded absolute paths with the ${LINX_ISA_ROOT} environment variable and correcting the LLVM target name.

Documentation improvements:

  • Replaced all hardcoded absolute paths (e.g., /Users/zhoubot/linx-isa) with the ${LINX_ISA_ROOT} environment variable to make build and test instructions more portable.
  • Updated LLVM build instructions to use the correct target name (LinxISA instead of Linx).

Copilot AI review requested due to automatic review settings May 16, 2026 18:18
@github-actions
Copy link
Copy Markdown

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md to replace hardcoded local file paths with the ${LINX_ISA_ROOT} environment variable and updates the LLVM target name to LinxISA. Feedback suggests that using the repository root is clearer for new users than an environment variable and recommends using relative paths for documentation links to ensure they remain clickable in Markdown viewers.

Comment thread README.md

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

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 thread README.md
Comment on lines +35 to +37
- `${LINX_ISA_ROOT}/docs/project/navigation.md`
- `${LINX_ISA_ROOT}/docs/bringup/`
- `${LINX_ISA_ROOT}/avs/compiler/linx-llvm/README.md`
Copy link
Copy Markdown

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)

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the top-level build/test documentation to be more portable by replacing developer-specific absolute paths with a ${LINX_ISA_ROOT} variable, and it attempts to correct the LLVM target name used in the CMake configure command.

Changes:

  • Replaced hardcoded /Users/... paths in build/test instructions with ${LINX_ISA_ROOT}.
  • Updated the documented LLVM_TARGETS_TO_BUILD value from Linx to LinxISA.
  • Updated “Related Docs” paths to use ${LINX_ISA_ROOT}.

Comment thread README.md
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
Comment thread README.md
Comment on lines 15 to 17
## Canonical Build and Test Commands
Run from `/Users/zhoubot/linx-isa`.
Run from `${LINX_ISA_ROOT}`.

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.

2 participants