ARM-software / LLVM-embedded-toolchain-for-Arm

A project dedicated to building LLVM toolchain for Arm and AArch64 embedded targets.
Apache License 2.0
425 stars 98 forks source link

Docs fixes for arm-runtimes and arm-multilib sub-builds. #575

Closed statham-arm closed 1 week ago

statham-arm commented 1 week ago

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.

statham-arm commented 1 week ago

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.