This is an archive of the discontinued LLVM Phabricator instance.

[libcxxabi] Document the standalone build's requirements on llvm-config and llvm sources.
ClosedPublic

Authored by EricWF on Oct 16 2014, 6:20 PM.

Details

Summary

The current documentation does not explain that the standalone build requires the LLVM sources. This patch updates the documentation to reflect this requirement and explains how to manually specify the location of the required files.

Any suggestions on better wording are encouraged.

Diff Detail

Event Timeline

EricWF updated this revision to Diff 15059.Oct 16 2014, 6:20 PM
EricWF retitled this revision from to [libcxxabi] Document the standalone build's requirements on llvm-config and llvm sources..
EricWF updated this object.
EricWF edited the test plan for this revision. (Show Details)
EricWF added reviewers: danalbert, jroelofs.
EricWF added a subscriber: Unknown Object (MLST).
jroelofs added inline comments.Oct 16 2014, 7:53 PM
www/index.html
100

perhaps you can also coerce cmake into barfing in such a way as to display this message when the appropriate circumstance comes up?

104

this one looks ok

105

but ones like this tend to confuse me when I see them because I'm never quite sure which folder it's asking me to point it at.

Some alternative bikeshed colors (none of which I particularly like):
<li><code>-DLLVM_PATH=path/to/llvm/</code></li>
<li><code>-DLLVM_PATH=path/to/llvm/lib/../</code></li>
<li><code>-DLLVM_PATH=path/to/llvm-source-root/</li>

EricWF updated this revision to Diff 15060.Oct 16 2014, 8:07 PM

Implement jroelofs's suggestions. I now use -DLLVM_SOURCE=path/to/llvm-source-root. The error message produced my CMake is also more informative.

EricWF updated this revision to Diff 15061.Oct 16 2014, 8:10 PM

Woops, the last patch uses LLVM_SOURCE instead of LLVM_PATH. Sorry for the spam.

jroelofs accepted this revision.Oct 17 2014, 7:01 AM
jroelofs edited edge metadata.

Looks reasonable to me.

This revision is now accepted and ready to land.Oct 17 2014, 7:01 AM
EricWF closed this revision.Oct 17 2014, 9:42 AM

Thanks. Committed as r220049.