[Lldb-commits] [lldb] [lldb] Revive internal data formatter documentation (PR #66527)

Walter Erquinigo via lldb-commits lldb-commits at lists.llvm.org
Fri Sep 15 10:25:25 PDT 2023


================
@@ -0,0 +1,436 @@
+Data Formatters
+===============
+
+This page is an introduction to the design of the LLDB data formatters
+subsystem. The intended target audience are people interested in understanding
+or modifying the formatters themselves rather than writing a specific data
+formatter. For this latter purpose, the user documentation about formatters is
+the main relevant document which one should refer to.
+
+This page also highlights some open areas for improvement to the general
+subsystem, and more evolutions not anticipated here are certainly possible.
+
+Overview
+--------
+
+The LLDB data formatters subsystem is used to allow the debugger as well as the
+end-users to customize the way their variables look upon inspection in the user
+interface (be it the command line tool, or one of the several GUIs that are
+backed by LLDB)
+
+To this aim, they are hooked into the ValueObjects model, in order to provide
+entry points through which such customization questions can be answered. For
+example what format should this number be printed as? How many child elements
----------------
walter-erquinigo wrote:

```suggestion
example: What format should this number be printed as? How many child elements
```

https://github.com/llvm/llvm-project/pull/66527


More information about the lldb-commits mailing list