[Lldb-commits] [lldb] de6f3d1 - [lldb] Add a page to the docs with (external) links on how to use LLDB

Tue Oct 20 11:43:39 PDT 2020

Author: Jonas Devlieghere
Date: 2020-10-20T11:43:31-07:00
New Revision: de6f3d1c71332b2c0ba00a2792c02be72b245d22

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

LOG: [lldb] Add a page to the docs with (external) links on how to use LLDB

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 crowd-source the best resources.

Differential revision: https://reviews.llvm.org/D89215

Added: 
    lldb/docs/use/links.md

Modified: 
    lldb/docs/index.rst

Removed: 
    


################################################################################
diff  --git a/lldb/docs/index.rst b/lldb/docs/index.rst
index 2bd66c9f49e1..442e9b9f7b65 100644

--- a/lldb/docs/index.rst
+++ b/lldb/docs/index.rst
@@ -135,6 +135,7 @@ interesting areas to contribute to lldb.
    use/remote
    use/qemu-testing
    use/troubleshooting
+   use/links
 
 .. toctree::
    :hidden:

diff  --git a/lldb/docs/use/links.md b/lldb/docs/use/links.md
new file mode 100644
index 000000000000..8c125a26cb46
--- /dev/null
+++ b/lldb/docs/use/links.md
@@ -0,0 +1,56 @@
+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/)
+
+A high level overview of LLDB with a focus on debugging Objective-C code.
+
+## Videos
+
+### [LLDB: Beyond "po" (2019)](https://developer.apple.com/videos/play/wwdc2019/429/)
+
+LLDB is a powerful tool for exploring and debugging your app at runtime.
+Discover the various ways to display values in your app, how to format custom
+data types, and how to extend LLDB using your own Python 3 scripts.
+
+### [Advanced Debugging with Xcode and LLDB (2018)](https://developer.apple.com/videos/play/wwdc2018/412/)
+
+Discover advanced techniques, and tips and tricks for enhancing your Xcode
+debugging workflows. Learn how to take advantage of LLDB and custom breakpoints
+for more powerful debugging. Get the most out of Xcode's view debugging tools
+to solve UI issues in your app more efficiently.
+
+### [Debugging with LLDB (2012)](https://developer.apple.com/videos/play/wwdc2012/415/)
+
+LLDB is the next-generation debugger for macOS and iOS. Get an introduction to
+using LLDB via the console interface and within Xcode's graphical debugger. The
+team that created LLDB will demonstrate the latest features and improvements,
+helping you track down bugs more efficiently than ever before.
+
+### [Migrating from GDB to LLDB (2011)](https://developer.apple.com/videos/play/wwdc2011/321/)
+
+LLDB is the next-generation debugger for macOS and iOS. Discover why you'll
+want to start using LLDB in your own development, get expert tips from the team
+that created LLDB, and see how it will help you track down bugs more
+efficiently than ever before.
+
+## Books
+
+### [Advanced Apple Debugging & Reverse Engineering (2018)](https://www.raywenderlich.com/books/advanced-apple-debugging-reverse-engineering/)
+
+A book about using LLDB on Apple platforms.
+
+## Extensions
+
+### [facebook/chisel](https://github.com/facebook/chisel)
+
+Chisel is a collection of LLDB commands to assist in the debugging of iOS apps.
+
+### [DerekSelander/LLDB](https://github.com/DerekSelander/LLDB)
+
+A collection of LLDB aliases/regexes and Python scripts.


        
