Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Add llvm --error-display to dwarfdump documentation #110922

Merged

Conversation

bd1976bris
Copy link
Collaborator

This adds documentation for --error-display, see: https://github.com/llvm/llvm-project/pull/79648/files.

Note: GitHub won't seem to allow me add the original author @kevinfrei as a reviewer for some reason.

@llvmbot
Copy link
Member

llvmbot commented Oct 2, 2024

@llvm/pr-subscribers-llvm-binary-utilities

Author: bd1976bris (bd1976bris)

Changes

This adds documentation for --error-display, see: https://github.com/llvm/llvm-project/pull/79648/files.

Note: GitHub won't seem to allow me add the original author @kevinfrei as a reviewer for some reason.


Full diff: https://github.com/llvm/llvm-project/pull/110922.diff

1 Files Affected:

  • (modified) llvm/docs/CommandGuide/llvm-dwarfdump.rst (+10)
diff --git a/llvm/docs/CommandGuide/llvm-dwarfdump.rst b/llvm/docs/CommandGuide/llvm-dwarfdump.rst
index 8adccf1c0c0a31..4c86b2cc351435 100644
--- a/llvm/docs/CommandGuide/llvm-dwarfdump.rst
+++ b/llvm/docs/CommandGuide/llvm-dwarfdump.rst
@@ -45,6 +45,16 @@ OPTIONS
 
             Use colors in output.
 
+.. option:: --error-display=<value>       
+
+            Set the level of detail and summary to display when verifying.
+            Implies :option:`--verify`. The supported values are:
+
+            `quiet`   - Only display whether errors occurred.
+            `summary` - Display only a summary of the errors found.
+            `details` - Display each error in detail but no summary.
+            `full`    - Display each error as well as a summary. [default]
+
 .. option:: -f <name>, --find=<name>
 
             Search for the exact text <name> in the accelerator tables

@kevinfrei
Copy link
Contributor

My coworkers can't add me, either, either. I think it's because I've just not bothered getting commit privileges.

The change looks correct. Thanks for doing this. Hopefully someone else (@clayborg or @dwblaikie ?) can approve the diff.

@bd1976bris bd1976bris merged commit 23c02a4 into llvm:main Oct 4, 2024
11 checks passed
@bd1976bris bd1976bris deleted the bd1976bris/main/dwarfdump-doc-error-display branch October 4, 2024 12:27
xgupta pushed a commit to xgupta/llvm-project that referenced this pull request Oct 4, 2024
Comment on lines +53 to +56
`quiet` - Only display whether errors occurred.
`summary` - Display only a summary of the errors found.
`details` - Display each error in detail but no summary.
`full` - Display each error as well as a summary. [default]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This list isn't formatted correctly and doesn't display like you probably intended. See https://llvm.org/docs/CommandGuide/llvm-dwarfdump.html#cmdoption-llvm-dwarfdump-error-display

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Doesn't look too bad actually but definitely not what was intended. Fix: #111693.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants