summaryrefslogtreecommitdiff
path: root/libcxx/docs
diff options
context:
space:
mode:
authorLouis Dionne <ldionne@apple.com>2018-12-04 19:31:08 +0000
committerLouis Dionne <ldionne@apple.com>2018-12-04 19:31:08 +0000
commit676de18f285e329feb4ebaede9ed11a6e714f2d4 (patch)
treed917bd8318b2e39d5869d6ed2c8b1d40de422f9f /libcxx/docs
parent639ace01219f4a071d53fe2f48623da4f1cc540c (diff)
[libcxx] Always enable availability in the lit test suite.
Summary: Running the tests without availability enabled doesn't really make sense: availability annotations allow catching errors at compile-time instead of link-time. Running the tests without availability enabled allows confirming that a test breaks at link-time under some configuration, but it is more useful to instead check that it should fail at compile-time. Always enabling availability in the lit test suite will greatly simplify XFAILs and troubleshooting of failing tests, which is currently a giant pain because we have these two levels of possible failure: link-time and compile-time. Reviewers: EricWF, mclow.lists Subscribers: christof, jkorous, dexonsmith, libcxx-commits Differential Revision: https://reviews.llvm.org/D55079
Diffstat (limited to 'libcxx/docs')
-rw-r--r--libcxx/docs/DesignDocs/AvailabilityMarkup.rst6
1 files changed, 2 insertions, 4 deletions
diff --git a/libcxx/docs/DesignDocs/AvailabilityMarkup.rst b/libcxx/docs/DesignDocs/AvailabilityMarkup.rst
index 750798f97c1..4ddef135f57 100644
--- a/libcxx/docs/DesignDocs/AvailabilityMarkup.rst
+++ b/libcxx/docs/DesignDocs/AvailabilityMarkup.rst
@@ -65,14 +65,12 @@ availability.
the test-suite against the host system library. Alternatively a path to the
directory containing a specific prebuilt libc++ can be used, for example:
`--param=use_system_cxx_lib=/path/to/macOS/10.8/`.
-* The `with_availability` boolean parameter enables the availability markup.
Tests can be marked as XFAIL based on multiple features made available by lit:
-* if either `use_system_cxx_lib` or `with_availability` is passed to lit,
- assuming `--param=platform=macosx10.8` is passed as well the following
- features will be available:
+* if `use_system_cxx_lib` is passed to lit, assuming `--param=platform=macosx10.8`
+ is passed as well the following features will be available:
- availability
- availability=x86_64