Author: Jonas Devlieghere Date: 2023-05-15T22:18:08-07:00 New Revision: 9adf60fc53fb105e331eec20e7fd2be71ee2a13c
URL: https://github.com/llvm/llvm-project/commit/9adf60fc53fb105e331eec20e7fd2be71ee2a13c DIFF: https://github.com/llvm/llvm-project/commit/9adf60fc53fb105e331eec20e7fd2be71ee2a13c.diff LOG: [lldb] Fix lldb_assert -> lldbassert in docs Update the documentation to reference lldbassert rather than lldb_assert. The latter is the implementation, which shouldn't be used directly. Instead, users should use lldbassert which is the macro that expands to assert or lldb_assert depending on the build type. Added: Modified: lldb/docs/resources/contributing.rst Removed: ################################################################################ diff --git a/lldb/docs/resources/contributing.rst b/lldb/docs/resources/contributing.rst index b2d4cf0e47181..5f4b24a8013e7 100644 --- a/lldb/docs/resources/contributing.rst +++ b/lldb/docs/resources/contributing.rst @@ -64,14 +64,14 @@ rules of thumb: errors cannot reasonably be surfaced to the end user, the error may be written to a topical log channel. -* Soft assertions. LLDB provides ``lldb_assert()`` as a soft +* Soft assertions. LLDB provides ``lldbassert()`` as a soft alternative to cover the middle ground of situations that indicate a - recoverable bug in LLDB. In a Debug configuration ``lldb_assert()`` + recoverable bug in LLDB. In a Debug configuration ``lldbassert()`` behaves like ``assert()``. In a Release configuration it will print a warning and encourage the user to file a bug report, similar to LLVM's crash handler, and then return execution. Use these sparingly and only if error handling is not otherwise feasible. Specifically, - new code should not be using ``lldb_assert()`` and existing + new code should not be using ``lldbassert()`` and existing uses should be replaced by other means of error handling. * Fatal errors. Aborting LLDB's process using _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
