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] Fix the rendering of recent changes to llvm-dwarfdump.rst #111693

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bd1976bris
Copy link
Collaborator

No description provided.

@llvmbot
Copy link
Collaborator

llvmbot commented Oct 9, 2024

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

Author: bd1976bris (bd1976bris)

Changes

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

1 Files Affected:

  • (modified) llvm/docs/CommandGuide/llvm-dwarfdump.rst (+5-5)
diff --git a/llvm/docs/CommandGuide/llvm-dwarfdump.rst b/llvm/docs/CommandGuide/llvm-dwarfdump.rst
index 426a6d596a1b89..2ec1034591304a 100644
--- a/llvm/docs/CommandGuide/llvm-dwarfdump.rst
+++ b/llvm/docs/CommandGuide/llvm-dwarfdump.rst
@@ -50,10 +50,10 @@ OPTIONS
             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]
+            - `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>
 
@@ -217,7 +217,7 @@ For aggregated values, the following keys are used:
 FORMAT OF VERIFY JSON OUTPUT
 ----------------------------
 
-The format of the JSON output created by the :option:`--verify-json` is::
+The format of the JSON output created by the option :option:`--verify-json` is::
 
   { 
     "error-categories": { 

Copy link
Collaborator

@jh7370 jh7370 left a comment

Choose a reason for hiding this comment

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

LGTM. You might want to consider building the docs locally to make sure the rendering looks correct before merging, if you haven't already.

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.

3 participants