llvm/libcxx
1
0
Fork 0
mirror of https://github.com/llvm-mirror/libcxx.git synced 2025-10-21 23:30:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

[NFC] Fix formatting in availability documentation

Browse Source 
git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@347362 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Louis Dionne
2018-11-20 23:07:01 +00:00
parent 7c5126bcc4
commit ee720ea18f
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/DesignDocs/AvailabilityMarkup.rst
View File

@@ -24,11 +24,11 @@ systems. For example::
// Define availability macros. // Define availability macros.
#if defined(_LIBCPP_USE_AVAILABILITY_APPLE) #if defined(_LIBCPP_USE_AVAILABILITY_APPLE)
#define _LIBCPP_AVAILABILITY_BAD_OPTIONAL_ACCESS __attribute__((unavailable)) # define _LIBCPP_AVAILABILITY_BAD_OPTIONAL_ACCESS __attribute__((unavailable))
#else if defined(_LIBCPP_USE_AVAILABILITY_SOME_OTHER_VENDOR) #else if defined(_LIBCPP_USE_AVAILABILITY_SOME_OTHER_VENDOR)
#define _LIBCPP_AVAILABILITY_BAD_OPTIONAL_ACCESS __attribute__((unavailable)) # define _LIBCPP_AVAILABILITY_BAD_OPTIONAL_ACCESS __attribute__((unavailable))
#else #else
#define _LIBCPP_AVAILABILITY_BAD_OPTIONAL_ACCESS # define _LIBCPP_AVAILABILITY_BAD_OPTIONAL_ACCESS
#endif #endif
When the library is updated by the platform vendor, the markup can be updated. When the library is updated by the platform vendor, the markup can be updated.
@@ -43,9 +43,9 @@ For example::
In the source code, the macro can be added on a class if the full class requires In the source code, the macro can be added on a class if the full class requires
type info from the library for example:: type info from the library for example::
_LIBCPP_BEGIN_NAMESPACE_EXPERIMENTAL _LIBCPP_BEGIN_NAMESPACE_EXPERIMENTAL
class _LIBCPP_EXCEPTION_ABI _LIBCPP_AVAILABILITY_BAD_OPTIONAL_ACCESS bad_optional_access class _LIBCPP_EXCEPTION_ABI _LIBCPP_AVAILABILITY_BAD_OPTIONAL_ACCESS bad_optional_access
: public std::logic_error { : public std::logic_error {
or on a particular symbol: or on a particular symbol:
@@ -70,7 +70,7 @@ availability.
Tests can be marked as XFAIL based on multiple features made available by lit: 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, * if either `use_system_cxx_lib` or `with_availability` is passed to lit,
assuming `--param=platform=macosx10.8` is passed as well the following assuming `--param=platform=macosx10.8` is passed as well the following
features will be available: features will be available:
@@ -81,7 +81,7 @@ Tests can be marked as XFAIL based on multiple features made available by lit:
- availability=x86_64-apple-macosx10.8 - availability=x86_64-apple-macosx10.8
- availability=macosx10.8 - availability=macosx10.8
This feature is used to XFAIL a test that *is* using a class of a method marked This feature is used to XFAIL a test that *is* using a class or a method marked
as unavailable *and* that is expected to *fail* if deployed on an older system. as unavailable *and* that is expected to *fail* if deployed on an older system.
* if `use_system_cxx_lib` is passed to lit, the following features will also * if `use_system_cxx_lib` is passed to lit, the following features will also
@@ -94,9 +94,9 @@ Tests can be marked as XFAIL based on multiple features made available by lit:
- with_system_cxx_lib=x86_64-apple-macosx10.8 - with_system_cxx_lib=x86_64-apple-macosx10.8
- with_system_cxx_lib=macosx10.8 - with_system_cxx_lib=macosx10.8
This feature is used to XFAIL a test that is *not* using a class of a method This feature is used to XFAIL a test that is *not* using a class or a method
marked as unavailable *but* that is expected to fail if deployed on an older marked as unavailable *but* that is expected to fail if deployed on an older
system. For example if we know that it exhibits a but in the libc on a system. For example if we know that it exhibits a bug in the libc on a
particular system version. particular system version.
* if `with_availability` is passed to lit, the following features will also * if `with_availability` is passed to lit, the following features will also
@@ -109,6 +109,6 @@ Tests can be marked as XFAIL based on multiple features made available by lit:
- availability_markup=x86_64-apple-macosx10.8 - availability_markup=x86_64-apple-macosx10.8
- availability_markup=macosx10.8 - availability_markup=macosx10.8
This feature is used to XFAIL a test that *is* using a class of a method This feature is used to XFAIL a test that *is* using a class or a method
marked as unavailable *but* that is expected to *pass* if deployed on an older marked as unavailable *but* that is expected to *pass* if deployed on an older
system. For example if it is using a symbol in a statically evaluated context. system. For example if it is using a symbol in a statically evaluated context.