Skip to content

Commit 9e07b42

Browse files
committed
address review feedback
1 parent 522a4a9 commit 9e07b42

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

lldb/docs/resources/symbolfilejson.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,28 @@ JSON Symbol File Format
22
=======================
33

44
The JSON symbol file format encodes symbols in a text based, human readable
5-
format. JSON symbol files can be used to symbolicate programs that miss symbol
5+
format. JSON symbol files can be used to symbolicate programs that lack symbol
66
information, for example because they have been stripped.
77

8+
Under the hood, the JSON symbol file format is also used by the crashlog
9+
script, specifically to provide symbol information for interactive crashlogs.
10+
811
Format
912
------
1013

11-
The symbol file contains of a single JSON object with the following top level
14+
The symbol file consists of a single JSON object with the following top level
1215
keys:
1316

14-
* ``triple``
15-
* ``uuid``
16-
* ``type``
17-
* ``sections``
18-
* ``symbols``
17+
* ``triple`` (string)
18+
* ``uuid`` (string)
19+
* ``type`` (string, optional)
20+
* ``sections`` (array, optional)
21+
* ``symbols`` (array, optional)
1922

2023
The ``triple``, ``uuid`` and ``type`` form the header and should therefore come
2124
first. The ``type`` field is optional. The body consists ``sections`` and
22-
``symbols``, each represented as a JSON array. Both arrays are optional, and
23-
can be omitted and are allowed to be empty.
25+
``symbols``. Both arrays are optional, and can be omitted and are allowed to be
26+
empty.
2427

2528
triple
2629
``````
@@ -57,7 +60,7 @@ Valid values for the ``type`` field are:
5760
* ``corefile``: A core file that has a checkpoint of a program's execution state.
5861
* ``executable``: A normal executable.
5962
* ``debuginfo``: An object file that contains only debug information.
60-
* ``dynamicuinker``: The platform's dynamic linker executable.
63+
* ``dynamiclinker``: The platform's dynamic linker executable.
6164
* ``objectfile``: An intermediate object file.
6265
* ``sharedlibrary``: A shared library that can be used during execution.
6366
* ``stublibrary``: A library that can be linked against but not used for execution.

0 commit comments

Comments
 (0)