[libcxx-commits] [PATCH] D119052: [libc++][docs] Change some words to use reST inline literals

Fangrui Song via Phabricator via libcxx-commits libcxx-commits at lists.llvm.org
Mon Feb 7 10:00:55 PST 2022


This revision was automatically updated to reflect the committed changes.
Closed by commit rG0a1c94f915b6: [libc++][docs] Change some words to use reST inline literals (authored by MaskRay).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D119052/new/

https://reviews.llvm.org/D119052

Files:
  libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst


Index: libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst
===================================================================
--- libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst
+++ libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst
@@ -35,7 +35,7 @@
 Design
 ======
 
-* Introduce new macro `_LIBCPP_DEBUG_RANDOMIZE_UNSPECIFIED_STABILITY` which should
+* Introduce new macro ``_LIBCPP_DEBUG_RANDOMIZE_UNSPECIFIED_STABILITY`` which should
   be a part of the libcxx config.
 * This macro randomizes the unspecified behavior of algorithms and containers.
   For example, for sorting algorithm the input range is shuffled and then
@@ -43,14 +43,14 @@
 * This macro is off by default because users should enable it only for testing
   purposes and/or migrations if they happen to libcxx.
 * This feature is only available for C++11 and further because of
-  `std::shuffle` availability.
+  ``std::shuffle`` availability.
 * We may use `ASLR <https://en.wikipedia.org/wiki/Address_space_layout_randomization>`_ or
-  static `std::random_device` for seeding the random number generator. This
+  static ``std::random_device`` for seeding the random number generator. This
   guarantees the same stability guarantee within a run but not through different
   runs, for example, for tests become flaky and eventually be seen as broken.
   For platforms which do not support ASLR, the seed is fixed during build.
 * The users can fix the seed of the random number generator by providing
-  `_LIBCPP_RANDOMIZE_UNSPECIFIED_STABILITY_SEED=seed` definition.
+  ``_LIBCPP_RANDOMIZE_UNSPECIFIED_STABILITY_SEED=seed`` definition.
 
 This comes with some side effects if any of the flags is on:
 
@@ -77,10 +77,10 @@
 Currently supported randomization
 ---------------------------------
 
-* `std::sort`, there is no guarantee on the order of equal elements
-* `std::partial_sort`, there is no guarantee on the order of equal elements and
+* ``std::sort``, there is no guarantee on the order of equal elements
+* ``std::partial_sort``, there is no guarantee on the order of equal elements and
    on the order of the remaining part
-* `std::nth_element`, there is no guarantee on the order from both sides of the
+* ``std::nth_element``, there is no guarantee on the order from both sides of the
    partition
 
 Patches welcome.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D119052.406516.patch
Type: text/x-patch
Size: 2342 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/libcxx-commits/attachments/20220207/4d6a194f/attachment.bin>


More information about the libcxx-commits mailing list