Skip to content

Commit 0e66928

Browse files
committed
fixup! fix table format
1 parent 52fde0a commit 0e66928

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

lldb/docs/use/formatting.rst

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -89,22 +89,22 @@ A complete list of currently supported format string variables is listed below:
8989
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9090
| ``function.name-without-args`` | The name of the current function without arguments and values (used to include a function name in-line in the ``disassembly-format``) |
9191
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
92-
| ``function.basename`` | The basename of the current function depending on the frame's language. E.g., for C++ the basename for ``void ns::foo<float>::bar<int>(int) const`` is ``bar``. |
92+
| ``function.basename`` | The basename of the current function depending on the frame's language. E.g., for C++ the basename for ``void ns::foo<float>::bar<int>(int) const`` is ``bar``. |
9393
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
94-
| ``function.scope`` | The scope qualifiers of the current function depending on the frame's language. E.g., for C++ the scope for `void ns::foo<float>::bar<int>(int) const` is `ns::foo<float>`. |
94+
| ``function.scope`` | The scope qualifiers of the current function depending on the frame's language. E.g., for C++ the scope for ``void ns::foo<float>::bar<int>(int) const`` is ``ns::foo<float>``. |
9595
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
96-
| ``function.template-arguments`` | The template arguments of the current function depending on the frame's language. E.g., for C++ the template arguments for `void ns::foo<float>::bar<int>(int) const` are `<float>`. |
96+
| ``function.template-arguments`` | The template arguments of the current function depending on the frame's language. E.g., for C++ the template arguments for ``void ns::foo<float>::bar<int>(int) const`` are ``<float>``. |
9797
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9898
| ``function.formatted-arguments`` | Arguments of the current function, formatted according to the frame's language. When debug-info is available, will apply data-formatters to each argument and include it's name if available. Otherwise prints the type of each argument according to the mangling. E.g., for C++ the |
99-
| | pretty-printed arguments for `func(int x, const char \*str)` are `(x=10, str="Hello")`. Without debug-info it would be `(int, const char\*)`. |
99+
| | pretty-printed arguments for ``func(int x, const char \*str)`` are ``(x=10, str="Hello")``. Without debug-info it would be ``(int, const char\*)``. |
100100
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
101-
| ``function.qualifiers`` | The function CV and reference qualifiers of the current function depending on the frame's language. E.g., for C++ the qualifiers for `void ns::foo<float>::bar<int>(int) const &` are ` const &`. |
101+
| ``function.qualifiers`` | The function CV and reference qualifiers of the current function depending on the frame's language. E.g., for C++ the qualifiers for ``void ns::foo<float>::bar<int>(int) const &`` are `` const &``. |
102102
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
103-
| ``function.return-left`` | The return type to the left of the demangled function name of the current function. This depends on the frame's language. E.g., for C++ the `function.return-left` is in most-cases the entirety of the return type. In `void ns::foo(int)` that would be `void `. However, in some cases, |
104-
| | particularly for functions returning function pointers, part of the return type is to the right of the function name. E.g., for `void (\*ns::func(float))(int)` the `function.return-left` would be `void (\*` and the `function.return-right` would be `)(int)`. |
103+
| ``function.return-left`` | The return type to the left of the demangled function name of the current function. This depends on the frame's language. E.g., for C++ the ``function.return-left`` is in most-cases the entirety of the return type. In ``void ns::foo(int)`` that would be ``void ``. However, in some |
104+
| | cases, particularly for functions returning function pointers, part of the return type is to the right of the function name. E.g., for ``void (\*ns::func(float))(int)`` the ``function.return-left`` would be ``void (\*`` and the ``function.return-right`` would be ``)(int)``. |
105105
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
106-
| ``function.return-right`` | The return type to the right of the demangled function name of the current function. This depends on the frame's language. In `void ns::foo(int)` there is no `function.return-right` so this would correspond to an empty string. However, in some cases, particularly for functions |
107-
| | returning function pointers, part of the return type is to the right of the function name. E.g., for `void (\*ns::func(float))(int)` the `function.return-left` would be `void (\*` and the `function.return-right` would be `)(int)`. |
106+
| ``function.return-right`` | The return type to the right of the demangled function name of the current function. This depends on the frame's language. In ``void ns::foo(int)`` there is no ``function.return-right`` so this would correspond to an empty string. However, in some cases, particularly for functions |
107+
| | returning function pointers, part of the return type is to the right of the function name. E.g., for ``void (\*ns::func(float))(int)`` the ``function.return-left`` would be ``void (\*`` and the ``function.return-right`` would be ``)(int)``. |
108108
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
109109
| ``function.mangled-name`` | The mangled name of the current function or symbol. |
110110
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -321,13 +321,14 @@ Function Name Formats
321321
_____________________
322322

323323
The function names displayed in backtraces/``frame info``/``thread info`` are the demangled names of functions. On some platforms (like ones using Itanium the mangling scheme), LLDB supports decomposing these names into fine-grained components. These are currently:
324-
* ``${function.return-left}``
325-
* ``${function.scope}``
326-
* ``${function.basename}``
327-
* ``${function.template-arguments}``
328-
* ``${function.formatted-arguments}``
329-
* ``${function.qualifiers}``
330-
* ``${function.return-right}``
324+
325+
- ``${function.return-left}``
326+
- ``${function.scope}``
327+
- ``${function.basename}``
328+
- ``${function.template-arguments}``
329+
- ``${function.formatted-arguments}``
330+
- ``${function.qualifiers}``
331+
- ``${function.return-right}``
331332

332333
Each language plugin decides how to handle these variables. For C++, LLDB uses these variables to dictate how function names are formatted. This can be customized using the ``plugin.cplusplus.display.function-name-format`` LLDB setting.
333334

0 commit comments

Comments
 (0)