Page MenuHomePhabricator

[Docs] Unify build instructions
ClosedPublic

Authored by JDevlieghere on Jul 3 2019, 1:14 PM.

Details

Summary

The current build instructions are structured according the host platform. Instead of having instructions on how to build with CMake repeated for every platform, I propose unifying them and having subsections if things are different for a certain platform.

Diff Detail

Event Timeline

JDevlieghere created this revision.Jul 3 2019, 1:14 PM
lldb/docs/resources/build.rst
151–152

This is not Windows specific and it is frequently used on non-Windows platforms. The other properties are also technically not Windows specific, though they are usually used on Windows.

xiaobai added a subscriber: xiaobai.Jul 3 2019, 1:25 PM

Thanks for doing this! :D

lldb/docs/resources/build.rst
156–157

The windows invocation should probably be more suited towards what one might see building on windows. See https://github.com/apple/swift/blob/master/docs/WindowsBuild.md#9-build-lldb as an example of what it might look like.

JDevlieghere marked an inline comment as done.
  • Move up custom test compilers
  • Specify that the CMake options are not Windows specific

Make Windows invocation look like a Windows invocation

stella.stamenova accepted this revision.Jul 3 2019, 1:33 PM
This revision is now accepted and ready to land.Jul 3 2019, 1:33 PM
labath added inline comments.Jul 4 2019, 11:04 PM
lldb/docs/resources/build.rst
17

Should we also mention lld somewhere?
Lld is a hard requirement for running tests on windows. On other platforms lld is not a hard requirement, but having it around will cause some additional tests to be run...

167–170

@mgorny: Maybe you are interested in changing the build scripts so that this is the default when targetting netbsd?