Update README for variable path references and fix LLVM_TARGETS_TO_BUILD#19
Update README for variable path references and fix LLVM_TARGETS_TO_BUILD#19FlyMan2004 wants to merge 2 commits into
Conversation
Remove the absolute path in `README.md`
|
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 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. |
There was a problem hiding this comment.
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.
|
|
||
| ## Canonical Build and Test Commands | ||
| Run from `/Users/zhoubot/linx-isa`. | ||
| Run from `${LINX_ISA_ROOT}`. |
There was a problem hiding this comment.
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.
| Run from `${LINX_ISA_ROOT}`. | |
| Run from the repository root. |
| - `${LINX_ISA_ROOT}/docs/project/navigation.md` | ||
| - `${LINX_ISA_ROOT}/docs/bringup/` | ||
| - `${LINX_ISA_ROOT}/avs/compiler/linx-llvm/README.md` |
There was a problem hiding this comment.
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.
| - `${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) |
There was a problem hiding this comment.
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_BUILDvalue fromLinxtoLinxISA. - Updated “Related Docs” paths to use
${LINX_ISA_ROOT}.
| 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 |
| ## Canonical Build and Test Commands | ||
| Run from `/Users/zhoubot/linx-isa`. | ||
| Run from `${LINX_ISA_ROOT}`. | ||
|
|
This pull request updates the
README.mdto improve portability and clarity by replacing hardcoded absolute paths with the${LINX_ISA_ROOT}environment variable and correcting the LLVM target name.Documentation improvements:
/Users/zhoubot/linx-isa) with the${LINX_ISA_ROOT}environment variable to make build and test instructions more portable.LinxISAinstead ofLinx).