[llvm-debuginfo-analyzer][DOC] Change .wasm references to .o #85566
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As part of the WebAssembly support work llvm#82588 As the object files used in the test cases are a single object (just produced by clang without being processed by wasm-ld), it was determined to use .o intead of .wasm. Update the README.txt to reflect that the tool now supports WebAssembly.
|
@llvm/pr-subscribers-debuginfo @llvm/pr-subscribers-llvm-binary-utilities Author: Carlos Alberto Enciso (CarlosAlbertoEnciso) ChangesAs part of the WebAssembly support work As the object files used in the test cases are a single object (just produced by clang without being processed by wasm-ld), it was determined to use .o intead of .wasm. Update the README.txt to reflect that the tool now supports WebAssembly. Full diff: https://github.com/llvm/llvm-project/pull/85566.diff 2 Files Affected:
diff --git a/llvm/docs/CommandGuide/llvm-debuginfo-analyzer.rst b/llvm/docs/CommandGuide/llvm-debuginfo-analyzer.rst
index 00c070cedb479c..54622cc61fdfda 100644
--- a/llvm/docs/CommandGuide/llvm-debuginfo-analyzer.rst
+++ b/llvm/docs/CommandGuide/llvm-debuginfo-analyzer.rst
@@ -1982,7 +1982,7 @@ level and debug info format.
llvm-debuginfo-analyzer --attribute=level,format
--output-sort=offset
--print=scopes,symbols,types,lines,instructions
- test-clang.wasm
+ test-clang.o
or
@@ -1991,7 +1991,7 @@ or
llvm-debuginfo-analyzer --attribute=level,format
--output-sort=offset
--print=elements
- test-clang.wasm
+ test-clang.o
Each row represents an element that is present within the debug
information. The first column represents the scope level, followed by
@@ -2001,7 +2001,7 @@ the element.
.. code-block:: none
Logical View:
- [000] {File} 'test-clang.wasm' -> WASM
+ [000] {File} 'test-clang.o' -> WASM
[001] {CompileUnit} 'test.cpp'
[002] 2 {Function} extern not_inlined 'foo' -> 'int'
@@ -2099,10 +2099,10 @@ layout and given the number of matches.
--select=BLOCK --select=.store
--report=list
--print=symbols,types,instructions,summary
- test-clang.wasm
+ test-clang.o
Logical View:
- [000] {File} 'test-clang.wasm'
+ [000] {File} 'test-clang.o'
[001] {CompileUnit} 'test.cpp'
[003] {Code} 'block'
@@ -2139,10 +2139,10 @@ with the printing mode to obtain the following logical view output.
--select-regex --select-nocase --select=INTe
--report=list
--print=symbols,types
- test-clang.wasm test-dwarf-gcc.o
+ test-clang.o test-dwarf-gcc.o
Logical View:
- [000] {File} 'test-clang.wasm'
+ [000] {File} 'test-clang.o'
[001] {CompileUnit} 'test.cpp'
[003] 4 {TypeAlias} 'INTEGER' -> 'int'
@@ -2175,13 +2175,13 @@ giving more context by swapping the reference and target object files.
--compare=types
--report=view
--print=symbols,types
- test-clang.wasm test-dwarf-gcc.o
+ test-clang.o test-dwarf-gcc.o
- Reference: 'test-clang.wasm'
+ Reference: 'test-clang.o'
Target: 'test-dwarf-gcc.o'
Logical View:
- [000] {File} 'test-clang.wasm'
+ [000] {File} 'test-clang.o'
[001] {CompileUnit} 'test.cpp'
[002] 1 {TypeAlias} 'INTPTR' -> '* const int'
@@ -2209,9 +2209,9 @@ includes the name, source code location, type, lexical scope level.
--compare=types
--report=list
--print=symbols,types,summary
- test-clang.wasm test-dwarf-gcc.o
+ test-clang.o test-dwarf-gcc.o
- Reference: 'test-clang.wasm'
+ Reference: 'test-clang.o'
Target: 'test-dwarf-gcc.o'
(1) Missing Types:
@@ -2238,10 +2238,10 @@ Changing the *Reference* and *Target* order:
--compare=types
--report=list
--print=symbols,types,summary
- test-dwarf-gcc.o test-clang.wasm
+ test-dwarf-gcc.o test-clang.o
Reference: 'test-dwarf-gcc.o'
- Target: 'test-clang.wasm'
+ Target: 'test-clang.o'
(1) Missing Types:
-[004] 4 {TypeAlias} 'INTEGER' -> 'int'
diff --git a/llvm/tools/llvm-debuginfo-analyzer/README.txt b/llvm/tools/llvm-debuginfo-analyzer/README.txt
index e6c20db7cd7121..d5b636c0f2d985 100644
--- a/llvm/tools/llvm-debuginfo-analyzer/README.txt
+++ b/llvm/tools/llvm-debuginfo-analyzer/README.txt
@@ -210,9 +210,6 @@ The following DWARF debug location operands are not supported:
//===----------------------------------------------------------------------===//
// Add support for additional binary formats.
//===----------------------------------------------------------------------===//
-- WebAssembly (Wasm).
- https://github.com/llvm/llvm-project/issues/57040#issuecomment-1211336680
-
- Extended COFF (XCOFF)
//===----------------------------------------------------------------------===//
|
jryans
approved these changes
Mar 17, 2024
There was a problem hiding this comment.
Looks good, thanks!
As a side note, this README.txt is a bit odd since it only lists issues and problems without talking about what works. It’s also hard to read on the GitHub web view. Perhaps consider (in a separate PR) converting to Markdown and linking to the command docs (https://llvm.org/docs/CommandGuide/llvm-debuginfo-analyzer.html). Or maybe leave it as-is but rename it to “TODO.txt”…?
I think the conversion and linking is a good option. |
CarlosAlbertoEnciso
added a commit
to CarlosAlbertoEnciso/llvm-project
that referenced
this pull request
Mar 23, 2024
As part of the WebAssembly support work llvm#85566 The README.txt is a bit odd since it only lists issues and problems without talking about what works. It’s also hard to read on the GitHub web view. - Convert to Markdown and linking to the command docs https://llvm.org/docs/CommandGuide/llvm-debuginfo-analyzer - Rename some left 'elf reader' to 'DWARF reader'.
CarlosAlbertoEnciso
added a commit
to CarlosAlbertoEnciso/llvm-project
that referenced
this pull request
Mar 25, 2024
As part of the WebAssembly support work llvm#85566 The README.txt is a bit odd since it only lists issues and problems without talking about what works. It’s also hard to read on the GitHub web view. - Use monospace instead of emphasis style.
CarlosAlbertoEnciso
added a commit
to CarlosAlbertoEnciso/llvm-project
that referenced
this pull request
Mar 26, 2024
As part of the WebAssembly support work llvm#85566 The README.txt is a bit odd since it only lists issues and problems without talking about what works. It’s also hard to read on the GitHub web view. - Address more feedback in relation to the correct Use of monospace. - Keep DWARF, CodeView, PDB as plain text.
CarlosAlbertoEnciso
added a commit
that referenced
this pull request
Mar 27, 2024
) As part of the WebAssembly support work #85566 The README.txt is a bit odd since it only lists issues and problems without talking about what works. It’s also hard to read on the GitHub web view. - Convert to Markdown and linking to the command docs https://llvm.org/docs/CommandGuide/llvm-debuginfo-analyzer - Rename some left 'elf reader' to 'DWARF reader'.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of the WebAssembly support work
#82588
As the object files used in the test cases are a single object (just produced by clang without being processed by wasm-ld), it was determined to use .o intead of .wasm.
Update the README.txt to reflect that the tool now supports WebAssembly.