[Lldb-commits] [PATCH] D89215: [lldb] Add a page to the documentation with (external) links on how to use LLDB

[Jonas Devlieghere via Phabricator via lldb-commits]

JDevlieghere created this revision.
JDevlieghere added a reviewer: LLDB.
Herald added a subscriber: arphaman.
JDevlieghere requested review of this revision.

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.


https://reviews.llvm.org/D89215

Files:
  lldb/docs/index.rst
  lldb/docs/use/links.rst


Index: lldb/docs/use/links.rst
===================================================================
--- /dev/null
+++ lldb/docs/use/links.rst
@@ -0,0 +1,29 @@
+Links
+=====
+
+This page contains links to external resources on how to use LLDB. Being listed
+on this page is not an endorsement.
+
+Blog Posts
+----------
+
+ - `Dancing in the Debugger — A Waltz with LLDB (2014) <https://www.objc.io/issues/19-debugging/lldb-debugging/>`_
+
+Videos
+------
+
+ - `LLDB: Beyond "po" (2019) <https://developer.apple.com/videos/play/wwdc2019/429/>`_
+ - `Advanced Debugging with Xcode and LLDB (2018) <https://developer.apple.com/videos/play/wwdc2018/412/>`_
+ - `Debugging with LLDB (2012) <https://developer.apple.com/videos/play/wwdc2012/415/>`_
+ - `Migrating from GDB to LLDB (2011) <https://developer.apple.com/videos/play/wwdc2011/321/>`_
+
+Books
+-----
+
+ - `Advanced Apple Debugging & Reverse Engineering (2018) <https://www.raywenderlich.com/books/advanced-apple-debugging-reverse-engineering/>`_
+
+Extensions
+----------
+
+ - `facebook/chisel <https://github.com/facebook/chisel>`_
+ - `DerekSelander/LLDB <https://github.com/DerekSelander/LLDB>`_
Index: lldb/docs/index.rst
===================================================================
--- lldb/docs/index.rst
+++ lldb/docs/index.rst
@@ -135,6 +135,7 @@
    use/remote
    use/qemu-testing
    use/troubleshooting
+   use/links
 
 .. toctree::
    :hidden:


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D89215.297491.patch
Type: text/x-patch
Size: 1425 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20201012/3a443c47/attachment.bin>