Adjust variable formatting table

[lubgr]

Summary

While the in-place hints on valid formats are up to date (e.g. when choosing an invalid format expr -f nonExisting -- 42), the corresponding online docs table is not. The formats "address", "hex float", "instruction" and "void" are missing, and "decimal" refers to an outdated abbreviation 'i' instead of 'd'.

[lubgr]

Gentle ping...

[jingham]

That looks good.

Note that the "address" format does more than show symbol/file/line offset, it will also print the string for addresses that point into the string pool. Might be worth mentioning that.

[JDevlieghere]

Lukas, do you have commit access or do you need one of us to land this for you?

[lubgr]

I updated the description of the address format, is it appropriate? And I can't commit that myself, so thanks in advance for doing so when it's ready.

lldb/trunk/docs/use/variable.rst

 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | ``printable character``                       | C                | show the bytes as printable ASCII characters                             |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | ``complex float``                             | F                | interpret this value as the real and imaginary part of a complex         |
 |                                               |                  | floating-point number                                                    |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | ``c-string``                                  | s                | show this as a 0-terminated C string                                     |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
-| ``decimal``                                   | i                | show this as a signed integer number (this does not perform a cast, it   |
+| ``decimal``                                   | d                | show this as a signed integer number (this does not perform a cast, it   |
 |                                               |                  | simply shows the bytes as  an integer with sign)                         |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | ``enumeration``                               | E                | show this as an enumeration, printing the                                |
 |                                               |                  | value's name if available or the integer value otherwise                 |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | ``hex``                                       | x                | show this as in hexadecimal notation (this does                          |
 |                                               |                  | not perform a cast, it simply shows the bytes as hex)                    |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+

 | ``float32[], float64[]``                      |                  | show this as an array of the corresponding                               |
 |                                               |                  |                       floating-point type                                |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | ``complex integer``                           | I                | interpret this value as the real and imaginary part of a complex integer |
 |                                               |                  | number                                                                   |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | ``character array``                           | a                | show this as a character array                                           |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
+| ``address``                                   | A                | show this as an address target (symbol/file/line + offset), possibly     |
+|                                               |                  | also the string this address is pointing to                              |
++-----------------------------------------------+------------------+--------------------------------------------------------------------------+
+| ``hex float``                                 |                  | show this as hexadecimal floating point                                  |
++-----------------------------------------------+------------------+--------------------------------------------------------------------------+
+| ``instruction``                               | i                | show this as an disassembled opcode                                      |
++-----------------------------------------------+------------------+--------------------------------------------------------------------------+
+| ``void``                                      | v                | don't show anything                                                      |
++-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 
 Type Summary
 ------------
 
 Type formats work by showing a different kind of display for the value of a
 variable. However, they only work for basic types. When you want to display a
 class or struct in a custom format, you cannot do that using formats.