From 54085d764b3d4ffd3d4933a491ceaeda60efc46b Mon Sep 17 00:00:00 2001 From: chaoticgd <43898262+chaoticgd@users.noreply.github.com> Date: Mon, 22 Jan 2024 04:42:42 +0000 Subject: [PATCH 1/3] Add a introductory paragraph to the symbol database documentation --- docs/SymbolDatabase.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/SymbolDatabase.md b/docs/SymbolDatabase.md index 7903fe2..48292ce 100644 --- a/docs/SymbolDatabase.md +++ b/docs/SymbolDatabase.md @@ -1,5 +1,9 @@ # Symbol Database +The symbol database provides a unified in-memory and on-disk representation for +debugging symbols, including those imported from multiple different types of +symbol tables, and those that are defined manually by the user. + Many of the objects in the symbol database are similar to objects found in traditional relational databases. The symbol lists are the tables, the maps are the indexes, and the symbol handles are the keys. From 927f52e97d0a572be269b403b037342e8b398113 Mon Sep 17 00:00:00 2001 From: chaoticgd <43898262+chaoticgd@users.noreply.github.com> Date: Mon, 22 Jan 2024 04:54:31 +0000 Subject: [PATCH 2/3] Reword some of the stdump help text --- src/stdump.cpp | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/stdump.cpp b/src/stdump.cpp index 1305af7..6e54b5f 100644 --- a/src/stdump.cpp +++ b/src/stdump.cpp @@ -56,33 +56,33 @@ static const StdumpCommand commands[] = { "is a directory, it will be walked recursively." }}, {print_functions, "functions", { - "Print all the functions recovered from the symbol table as C++." + "Print all the functions defined in the input symbol table(s) as C++." }}, {print_globals, "globals", { - "Print all the global variables recovered from the symbol table as C++." + "Print all the global variables defined in the input symbol table(s) as C++." }}, {print_types, "types", { - "Print all the types recovered from the symbol table as C++." + "Print all the types defined in the input symbol table(s) as C++." }}, {print_type_graph, "type_graph", { - "Print out a dependency graph of all the types in graphviz DOT format." + "Print a dependency graph of all the types as a graphviz DOT file." }}, {print_labels, "labels", { - "Print all the labels recovered from the symbol table. Note that this may", - "include other symbols where their type is not recoverable." + "Print all the labels defined in the input symbol table(s). Note that this", + "may include other symbols where their type is not recoverable." }}, {print_json, "json", { "Print all of the above as JSON." }}, {print_symbols, "symbols", { - "Print all of the symbols in a given symbol table.", + "Print all the raw symbols in the input symbol table(s).", "", "--locals Only print local .mdebug symbols.", "", "--externals Only print external .mdebug symbols." }}, {print_headers, "headers", { - "Print out the contents of the .mdebug header." + "Print the contents of the .mdebug header." }}, {print_files, "files", { "Print a list of all the source files." From 86b2b04a1af08c9013264f3ba9a07d3d6c6a05f9 Mon Sep 17 00:00:00 2001 From: chaoticgd <43898262+chaoticgd@users.noreply.github.com> Date: Mon, 22 Jan 2024 04:57:01 +0000 Subject: [PATCH 3/3] Another help text tweak --- src/stdump.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/stdump.cpp b/src/stdump.cpp index 6e54b5f..06103de 100644 --- a/src/stdump.cpp +++ b/src/stdump.cpp @@ -52,7 +52,7 @@ struct StdumpCommand { static const StdumpCommand commands[] = { {identify_symbol_tables, "identify", { - "Identify the symbol tables present in the input file(s). If the input path", + "Identify the symbol table(s) present in the input file(s). If the input path", "is a directory, it will be walked recursively." }}, {print_functions, "functions", {