[Lldb-commits] [lldb] 9ce82a1 - Wrong link target in the documentation #62990

David Spickett via lldb-commits lldb-commits at lists.llvm.org
Fri Sep 8 07:38:34 PDT 2023


Author: Author: Eddie Phillips
Date: 2023-09-08T15:38:28+01:00
New Revision: 9ce82a10a32203746cef70541de4807fb5c008a5

URL: https://github.com/llvm/llvm-project/commit/9ce82a10a32203746cef70541de4807fb5c008a5
DIFF: https://github.com/llvm/llvm-project/commit/9ce82a10a32203746cef70541de4807fb5c008a5.diff

LOG: Wrong link target in the documentation #62990

In the LDDB documentation you have the following sentence:

"The --format (which you can shorten to -f) option accepts a format name."

The link points to the wrong place.

I pointed it to the table that precedes the Type summary section.

Reviewed By: DavidSpickett

Differential Revision: https://reviews.llvm.org/D151668

Added: 
    

Modified: 
    lldb/docs/use/variable.rst

Removed: 
    


################################################################################
diff  --git a/lldb/docs/use/variable.rst b/lldb/docs/use/variable.rst
index 7e7b4fd0b67c248..8eaed6405315b43 100644
--- a/lldb/docs/use/variable.rst
+++ b/lldb/docs/use/variable.rst
@@ -129,8 +129,8 @@ This is done by typing
 
 at the LLDB command line.
 
-The ``--format`` (which you can shorten to -f) option accepts a :doc:`format
-name<formatting>`. Then, you provide one or more types to which you want the
+The ``--format`` (which you can shorten to -f) option accepts a `format
+name`_. Then, you provide one or more types to which you want the
 new format applied.
 
 A frequent scenario is that your program has a typedef for a numeric type that
@@ -246,6 +246,8 @@ format or till you let your program run again.
 Finally, this is a list of formatting options available out of which you can
 pick:
 
+.. _`format name`:
+
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | **Format name**                               | **Abbreviation** | **Description**                                                          |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+


        


More information about the lldb-commits mailing list