Skip to content

[lldb][Docs] Update links in Data Formatter section #66474

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

Merged
merged 1 commit into from
Sep 15, 2023

Conversation

DavidSpickett
Copy link
Collaborator

Neither actually linked anywhere, but I did find a good target for the introduction.

For the architecture side I don't see a page that would fit, so I've just removed the sentence.

Neither actually linked anywhere, but I did find a good target
for the introduction.

For the architecture side I don't see a page that would fit,
so I've just removed the sentence.
@llvmbot
Copy link
Member

llvmbot commented Sep 15, 2023

@llvm/pr-subscribers-lldb

Changes Neither actually linked anywhere, but I did find a good target for the introduction.

For the architecture side I don't see a page that would fit, so I've just removed the sentence.

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

1 Files Affected:

  • (modified) lldb/docs/resources/overview.rst (+3-5)
diff --git a/lldb/docs/resources/overview.rst b/lldb/docs/resources/overview.rst
index b76af384e08b978..054fcbfea2164c2 100644
--- a/lldb/docs/resources/overview.rst
+++ b/lldb/docs/resources/overview.rst
@@ -80,8 +80,8 @@ wide variety of classes are implemented:
 - Source manager
 - Value objects
 
-Dataformatters
---------------
+Data Formatters
+---------------
 
 A collection of classes that implement the data formatters subsystem.
 
@@ -92,9 +92,7 @@ layers to the implementation: DataVisualization at the highest end of the
 spectrum, backed by classes implementing individual formatters, matching rules,
 etc.
 
-For a general user-level introduction to data formatters, you can look here.
-
-More details on the architecture are to be found here.
+For an introduction to data formatters, see :doc:`/use/variable`.
 
 Expression
 ----------

@DavidSpickett
Copy link
Collaborator Author

Would skip review, but it's here on the off chance @JDevlieghere knows where the second link was supposed to go to.

The original commit was edb874b.

@DavidSpickett DavidSpickett merged commit 1d75d42 into llvm:main Sep 15, 2023
@DavidSpickett DavidSpickett deleted the lldb-data-formatter-docs branch September 15, 2023 15:39
@JDevlieghere
Copy link
Member

JDevlieghere commented Sep 15, 2023

Would skip review, but it's here on the off chance @JDevlieghere knows where the second link was supposed to go to.

The original HTML had the following links:

<p>For a general user-level introduction to data formatters, you can look <a href="../varformats.html">here</a>.
<p>More details on the architecture are to be found <a href="../architecture/varformats.html">here</a>.```

The new link is correct but it seems like I didn't port over the other page, probably because I didn't realize there were two pages with the same name. I didn't read through the second page yet, so I can't tell yet how relevant it still is, but I'll put up a PR and we can iterate on it.

ZijunZhaoCCK pushed a commit to ZijunZhaoCCK/llvm-project that referenced this pull request Sep 19, 2023
Neither actually linked anywhere, but I did find a good target for the
introduction.

For the architecture side I don't see a page that would fit, so I've
just removed the sentence.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants