[PATCH] D12129: [libcxx] Add new Sphinx documentation

Sean Silva via cfe-commits cfe-commits at lists.llvm.org
Thu Aug 20 13:19:15 PDT 2015


silvas added inline comments.

================
Comment at: docs/BuildingLibcxx.rst:57
@@ +56,3 @@
+  select a safe place to install libc++.
+
+  * ``make install-libcxx install-libcxxabi`` --- Will install the libraries and the headers
----------------
silvas wrote:
> jroelofs wrote:
> > I feel like a warning is not enough... perhaps a hard error, with a message that says something like: "If you're really really sure you know what you're doing, add -DLIBCXX_OVERRIDE_DARWIN_INSTALL=YES to silence this message"?
> FYI, Sphinx has some directives designed for prominent warnings like this: http://docutils.sourceforge.net/docs/ref/rst/directives.html#danger
> 
> Should render similar to the "Warning" box on http://clang.llvm.org/docs/ReleaseNotes.html (see clang/docs/ReleaseNotes.rst)
The general names for these things are "admonitions" and there are e.g. 'note' 'danger' 'warning' etc. that are hopefully appropriately styled by the theme.


http://reviews.llvm.org/D12129





More information about the cfe-commits mailing list