1804515 - Add a note to the lldb setup instructions - Documentation issue on mobile/android/geckoview/contributor/native-debugging

Status: NEW

(Developer Infrastructure :: Firefox Source Docs: Content, enhancement)

Description

[Anna Yeddi [:ayeddi]]

URL = https://firefox-source-docs.mozilla.org/mobile/android/geckoview/contributor/native-debugging.html

Consider adding a note, to clarify which objdir-android-opt is expected to be used for the Set up lldb to find your symbols section to streamline debugging setup for less versed in the mozilla-unified codebase users.

The section could be as follows:

Set up lldb to find your symbols
--------------------------------

Edit your ``~/.lldbinit`` file (or create one if one does not already
exist) and add the following lines.

The first line tells LLDB to enable inline breakpoints - Android Studio
will need this if you want to use visual breakpoints.

The remaining lines tell LLDB where to go to find the symbols for
debugging.

.. code:: bash

   settings set target.inline-breakpoint-strategy always
   settings append target.exec-search-paths <PATH>/objdir-android-opt/toolkit/library/build
   settings append target.exec-search-paths <PATH>/objdir-android-opt/mozglue/build
   settings append target.exec-search-paths <PATH>/objdir-android-opt/security

The `objdir-android-opt` would be a platform-specific sub-directory from the project's main location, for instance, `obj-aarch64-apple-darwin21.6.0` in `mozilla-unified` could be used while on M1 macOS machine.