Merge pull request #245 from chaoticgd/minor_corrections

Make some minor corrections to comments, documentation, and formatting

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## v2.2
 
-- Provide x64 builds for macOS again in addition to the arm64 builds.
+- Mac builds compiled for x64 processors are now provided in addition to the arm64 builds.
 - stdump: The `functions` and `globals` subcommands now output a header comment like the `types` command.
 - stdump: The output format of the `files` subcommand has been updated.
 

README.md

@@ -9,7 +9,7 @@ A library and set of command line tools for parsing debugging symbols from PS2 g
 
 ### demangle
 
-Demangler for the old GNU ABI.
+C++ symbol demangler with support for both the new Itanium C++ ABI (GCC 3+) mangling scheme and the old GCC 2 scheme.
 
 ### objdump
 

src/ccc/mdebug_importer.h

@@ -12,7 +12,7 @@
 namespace ccc::mdebug {
 
 // Perform all the main analysis passes on the mdebug symbol table and convert
-// it to a set of C++ ASTs.
+// it to a set of symbols and C++ ASTs.
 Result<void> import_symbol_table(
 	SymbolDatabase& database,
 	std::span<const u8> elf,

src/ccc/symbol_database.h

@@ -443,7 +443,7 @@ class LocalVariable : public Symbol {
 	static constexpr u32 FLAGS = WITH_ADDRESS_MAP;
 
 	LocalVariableHandle handle() const { return m_handle; }
-	FunctionHandle function() const { return m_function; };
+	FunctionHandle function() const { return m_function; }
 
 	std::variant<GlobalStorage, RegisterStorage, StackStorage> storage;
 	AddressRange live_range;

src/ccc/symbol_table.cpp

@@ -12,9 +12,9 @@
 namespace ccc {
 
 const std::vector<SymbolTableFormatInfo> SYMBOL_TABLE_FORMATS = {
-	{MDEBUG, "mdebug", ".mdebug"}, // The infamous Third Eye symbol table.
-	{SYMTAB, "symtab", ".symtab"}, // The standard ELF symbol table.
-	{SNDLL, "sndll", ".sndata"}    // The SNDLL symbol table.
+	{MDEBUG, "mdebug", ".mdebug"},
+	{SYMTAB, "symtab", ".symtab"},
+	{SNDLL, "sndll", ".sndata"}
 };
 
 const SymbolTableFormatInfo* symbol_table_format_from_enum(SymbolTableFormat format)

src/ccc/symbol_table.h

@@ -12,9 +12,9 @@ namespace ccc {
 // Determine which symbol tables are present in a given file.
 
 enum SymbolTableFormat {
-	MDEBUG = 0, // The infamous Third Eye symbol table
-	SYMTAB = 1, // Standard ELF symbol table
-	SNDLL  = 2  // SNDLL section
+	MDEBUG = 0, // The infamous Third Eye symbol table.
+	SYMTAB = 1, // Standard ELF symbol table.
+	SNDLL  = 2  // SNDLL dynamic linker symbol table.
 };
 
 struct SymbolTableFormatInfo {