[Lldb-commits] [lldb] 31c03c9 - [lldb][docs] Fix plaintext marker in variables doc
David Spickett via lldb-commits
lldb-commits at lists.llvm.org
Tue Dec 9 04:32:56 PST 2025
Author: David Spickett
Date: 2025-12-09T12:32:48Z
New Revision: 31c03c93b1b8dbfa398185fc698066c0480f40e7
URL: https://github.com/llvm/llvm-project/commit/31c03c93b1b8dbfa398185fc698066c0480f40e7
DIFF: https://github.com/llvm/llvm-project/commit/31c03c93b1b8dbfa398185fc698066c0480f40e7.diff
LOG: [lldb][docs] Fix plaintext marker in variables doc
Single backtick tries to make a reference to something
and if that fails, renders as plain text.
These 3 weren't finding a reference and so produced
a warning:
variable.rst:975: WARNING: 'any' reference target not found: max_children
Added:
Modified:
lldb/docs/use/variable.rst
Removed:
################################################################################
diff --git a/lldb/docs/use/variable.rst b/lldb/docs/use/variable.rst
index 212e5c5f8a140..9d558954ff12b 100644
--- a/lldb/docs/use/variable.rst
+++ b/lldb/docs/use/variable.rst
@@ -972,13 +972,13 @@ Being more specific, in case of exceptions, LLDB might assume that the given
object has no children or it might skip printing some children, as they are
printed one by one.
-[1] The `max_children` argument is optional (since lldb 3.8.0) and indicates the
+[1] The ``max_children`` argument is optional (since lldb 3.8.0) and indicates the
maximum number of children that lldb is interested in (at this moment). If the
computation of the number of children is expensive (for example, requires
traversing a linked list to determine its size) your implementation may return
-`max_children` rather than the actual number. If the computation is cheap (e.g., the
+``max_children`` rather than the actual number. If the computation is cheap (e.g., the
number is stored as a field of the object), then you can always return the true
-number of children (that is, ignore the `max_children` argument).
+number of children (that is, ignore the ``max_children`` argument).
[2] This method is optional. Also, a boolean value must be returned (since lldb
3.1.0). If ``False`` is returned, then whenever the process reaches a new stop,
More information about the lldb-commits
mailing list