summaryrefslogtreecommitdiffstats
path: root/lldb
diff options
context:
space:
mode:
authorJonas Devlieghere <jonas@devlieghere.com>2019-05-17 01:38:16 +0000
committerJonas Devlieghere <jonas@devlieghere.com>2019-05-17 01:38:16 +0000
commit65cab8c639942b84c9c4d9aca17670482cf28e2d (patch)
treea333e4638d3fa917702cd9fe346192d50cab6723 /lldb
parent19871f848bbe92fc304a1e5ac55b8475e6d2571f (diff)
downloadbcm5719-llvm-65cab8c639942b84c9c4d9aca17670482cf28e2d.tar.gz
bcm5719-llvm-65cab8c639942b84c9c4d9aca17670482cf28e2d.zip
[Docs] Fix headings in remote debugging
Add the proper headings instead of using just a bold font. Also add the local ToC. llvm-svn: 360971
Diffstat (limited to 'lldb')
-rw-r--r--lldb/docs/use/remote.rst26
1 files changed, 18 insertions, 8 deletions
diff --git a/lldb/docs/use/remote.rst b/lldb/docs/use/remote.rst
index 2ce0639bc10..ea18bc14a18 100644
--- a/lldb/docs/use/remote.rst
+++ b/lldb/docs/use/remote.rst
@@ -23,8 +23,11 @@ communicating with it over the loopback interface. In the case of local
debugging this whole process is transparent to the user. The platform binary is
not used in this case, since no file transfers are needed.
+.. contents::
+ :local:
+
Preparation for Remote Debugging
---------------------------------
+---------------------------------
While the process of actual debugging (stepping, backtraces, evaluating
expressions) is same as in the local case, in the case of remote debugging,
@@ -32,7 +35,8 @@ more preparation is needed as the required binaries cannot started on the
remote system automatically. Also, if the remote system runs a different OS or
architecture, the server component needs to be compiled separately.
-**Remote system**
+Remote system
+*************
On Linux and Android, all required remote functionality is contained in the
lldb-server binary. This binary combines the functionality of the platform and
@@ -64,7 +68,8 @@ originating from that address. Adding a --server parameter to the command line
will fork off a new process for every incoming connection, allowing multiple
parallel debug sessions.
-**Local system**
+Local system
+************
On the local system, you need to let LLDB know that you intend to do remote
debugging. This is achieved through the platform command and its sub-commands.
@@ -130,9 +135,11 @@ application needs additional files, you can transfer them using the platform
commands: get-file, put-file, mkdir, etc. The environment can be prepared
further using the platform shell command.
-**Launching a locally built process on the remote machine**
+Launching a locally built process on the remote machine
+-------------------------------------------------------
-*Install and run in the platform working directory*
+Install and run in the platform working directory
+*************************************************
To launch a locally built process on the remote system in the platform working
directory:
@@ -151,7 +158,8 @@ changed. LLDB will automatically launch a lldb-server in gdbremote mode to
allow you to debug this executable, connect to it and start your debug session
for you.
-*Changing the platform working directory*
+Changing the platform working directory
+***************************************
You can change the platform working directory while connected to the platform
with:
@@ -173,7 +181,8 @@ And you can verify it worked using "platform status":
If we run again, the program will be installed into ``/usr/local/bin``.
-*Install and run by specifying a remote install path*
+Install and run by specifying a remote install path
+***************************************************
If you want the "a.out" executable to be installed into "/bin/a.out" instead of
the platform's current working directory, we can set the platform file
@@ -201,7 +210,8 @@ specification:
(lldb) script lldb.target.module['libbar.so'].SetPlatformFileSpec("/usr/local/lib/libbar.so")
(lldb) run
-*Attaching to a remote process*
+Attaching to a remote process
+*****************************
If you want to attach to a remote process, you can first list the processes on
the remote system:
OpenPOWER on IntegriCloud