-
Notifications
You must be signed in to change notification settings - Fork 12.6k
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
[doc] Add llvm --error-display to dwarfdump documentation #110922
Conversation
@llvm/pr-subscribers-llvm-binary-utilities Author: bd1976bris (bd1976bris) ChangesThis 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:
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
|
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. |
This adds documentation for --error-display, see: llvm#79648
`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] |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
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.