[Lldb-commits] [PATCH] D151668: Wrong link target in the documentation #62990

[Eddie Phillips via Phabricator via lldb-commits]

eddiep24 created this revision.
Herald added a project: All.
eddiep24 requested review of this revision.
Herald added a project: LLDB.
Herald added a subscriber: lldb-commits.

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.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D151668

Files:
  lldb/docs/use/variable.rst


Index: lldb/docs/use/variable.rst
===================================================================
--- lldb/docs/use/variable.rst
+++ lldb/docs/use/variable.rst
@@ -132,8 +132,8 @@
 
 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
@@ -249,6 +249,8 @@
 Finally, this is a list of formatting options available out of which you can
 pick:
 
+.. _`format name`:
+
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+
 | **Format name**                               | **Abbreviation** | **Description**                                                          |
 +-----------------------------------------------+------------------+--------------------------------------------------------------------------+


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D151668.526485.patch
Type: text/x-patch
Size: 1178 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20230530/1de1da3c/attachment.bin>