[libcxx-commits] [libcxx] e52f0e7 - [libc++][hardening][NFC] Rename `HardenedMode.rst` to `Hardening.rst`.

[Konstantin Varlamov via libcxx-commits]

Author: Konstantin Varlamov
Date: 2023-07-20T17:41:37-07:00
New Revision: e52f0e7746c8f2e8c0328054cc0934d4710e372d

URL: https://github.com/llvm/llvm-project/commit/e52f0e7746c8f2e8c0328054cc0934d4710e372d
DIFF: https://github.com/llvm/llvm-project/commit/e52f0e7746c8f2e8c0328054cc0934d4710e372d.diff

LOG: [libc++][hardening][NFC] Rename `HardenedMode.rst` to `Hardening.rst`.

This addresses a comment from https://reviews.llvm.org/D154997.

Added: 
    libcxx/docs/Hardening.rst

Modified: 
    libcxx/docs/ReleaseNotes/17.rst
    libcxx/docs/index.rst

Removed: 
    libcxx/docs/HardenedMode.rst


################################################################################
diff  --git a/libcxx/docs/HardenedMode.rst b/libcxx/docs/Hardening.rst
similarity index 100%
rename from libcxx/docs/HardenedMode.rst
rename to libcxx/docs/Hardening.rst

diff  --git a/libcxx/docs/ReleaseNotes/17.rst b/libcxx/docs/ReleaseNotes/17.rst
index 6b2e2e3b1ee66e..a21e428c156a67 100644
--- a/libcxx/docs/ReleaseNotes/17.rst
+++ b/libcxx/docs/ReleaseNotes/17.rst
@@ -97,14 +97,14 @@ Improvements and New Features
   a reliable program termination. Vendors can configure whether the hardened mode is enabled by default with the
   ``LIBCXX_HARDENING_MODE`` variable at CMake configuration time. Users can control whether the hardened mode is
   enabled on a per translation unit basis using the ``-D_LIBCPP_ENABLE_HARDENED_MODE=1`` macro. See
-  ``libcxx/docs/HardenedMode.rst`` for more details.
+  ``libcxx/docs/Hardening.rst`` for more details.
 
 - The library now provides a debug mode which is a superset of the hardened mode, additionally enabling more expensive
   checks that are not suitable to be used in production. This replaces the legacy debug mode that was removed in this
   release. Unlike the legacy debug mode, this doesn't affect the ABI and doesn't require locking. Vendors can configure
   whether the debug mode is enabled by default with the ``LIBCXX_HARDENING_MODE`` variable at CMake configuration time.
   Users can control whether the debug mode is enabled on a per translation unit basis using the
-  ``-D_LIBCPP_ENABLE_DEBUG_MODE=1`` macro. See ``libcxx/docs/HardenedMode.rst`` for more details.
+  ``-D_LIBCPP_ENABLE_DEBUG_MODE=1`` macro. See ``libcxx/docs/Hardening.rst`` for more details.
 
 - ASAN annotations to detect container overflow have been added to the
   containers ``std::deque``, and ``std::vector``.
@@ -115,7 +115,7 @@ Deprecations and Removals
 - The "safe" mode is replaced by the hardened mode in this release. The ``LIBCXX_ENABLE_ASSERTIONS`` CMake variable is
   deprecated and setting it will trigger an error; use ``LIBCXX_HARDENING_MODE`` instead. Similarly, the
   ``_LIBCPP_ENABLE_ASSERTIONS`` macro is deprecated and setting it to ``1`` now enables the hardened mode. See
-  ``libcxx/docs/HardenedMode.rst`` for more details.
+  ``libcxx/docs/Hardening.rst`` for more details.
 
 - The legacy debug mode has been removed in this release. Setting the macro ``_LIBCPP_ENABLE_DEBUG_MODE`` to ``1`` now
   enables the new debug mode which is part of hardening (see the "Improvements and New Features" section above). The

diff  --git a/libcxx/docs/index.rst b/libcxx/docs/index.rst
index 40a3ce6c3844cd..fbe39d823ed5c6 100644
--- a/libcxx/docs/index.rst
+++ b/libcxx/docs/index.rst
@@ -40,7 +40,7 @@ Getting Started with libc++
    TestingLibcxx
    Contributing
    Modules
-   HardenedMode
+   Hardening
    ReleaseProcedure
    Status/Cxx14
    Status/Cxx17