This is an archive of the discontinued LLVM Phabricator instance.

[lldb] Add a page to the documentation with (external) links on how to use LLDB
ClosedPublic

Authored by JDevlieghere on Oct 11 2020, 5:01 PM.

Details

Summary

In a discussion with Jim last week we came to the realization that often we get asked about things that might not be documented on the website, but that have been pretty well explained elsewhere. In those situations it's often easier to quickly answer the question than searching for that presentation you gave 3 years ago if you remember at all. This often results in us having to answer the same questions over and over again. We could add the questions and their answer to the website, but that means we (1) have to duplicate the work and (2) now have to maintain it. A more efficient solution is to add a page with external resources with the caveat that they might be outdated. That's exactly the purpose of this patch.

I've added a few links that came to mind, but I don't want to be the arbiter of what should and should not be included. I'd hope that over time the community can crowdsource the best resources.

Diff Detail

Event Timeline

JDevlieghere created this revision.Oct 11 2020, 5:01 PM
JDevlieghere requested review of this revision.Oct 11 2020, 5:01 PM
vsk added a subscriber: vsk.Oct 12 2020, 10:50 AM

+ 1, this looks good to me.

I think there might be room to include a short (~1 sentence) summary next to each extension entry, so readers know what to expect before clicking on one.

  • Use markdown
  • Add a little text snippet to the links
vsk accepted this revision as: vsk.Oct 20 2020, 11:38 AM
This revision is now accepted and ready to land.Oct 20 2020, 11:38 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 20 2020, 11:43 AM