Docs fixes for arm-runtimes and arm-multilib sub-builds. #575
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The suggested build commands left out the usual `cd` after `mkdir`, so that if you followed them literally, you'd create an `arm-runtimes` or `arm-multilib` directory and then ignore it completely and put all your build debris at the level above it. Also, trying to follow the instructions, I was confused by the semantics of `LLVM_BINARY_DIR`: given the name, I instinctively pointed it at the actual `bin` directory, but it turned out I should have aimed one level up. Added some clarifying text, with particular reference to using a full build of this toolchain for a standalone build of one library. While I'm here, removed some apparently accidental physical tabs, so that all the continuation lines in the long cmake commands line up.
dcandler
approved these changes
Nov 21, 2024
There was a problem hiding this comment.
Thanks - I can understand the confusion around LLVM_BINARY_DIR since it's using "binary" in the CMake context of the build tree rather than a source one. But calling it the build directory also didn't quite work since it can also be pointed to an install or extracted package.
|
Yes, I guessed that was the sense you meant "binary" in. As you say – it's a valid use, just not the only use, so the clarification seems worth having. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The suggested build commands left out the usual
cdaftermkdir, so that if you followed them literally, you'd create anarm-runtimesorarm-multilibdirectory and then ignore it completely and put all your build debris at the level above it.Also, trying to follow the instructions, I was confused by the semantics of
LLVM_BINARY_DIR: given the name, I instinctively pointed it at the actualbindirectory, but it turned out I should have aimed one level up. Added some clarifying text, with particular reference to using a full build of this toolchain for a standalone build of one library.While I'm here, removed some apparently accidental physical tabs, so that all the continuation lines in the long cmake commands line up.