Author: jdevlieghere Date: Thu May 16 18:38:16 2019 New Revision: 360971 URL: http://llvm.org/viewvc/llvm-project?rev=360971&view=rev Log: [Docs] Fix headings in remote debugging
Add the proper headings instead of using just a bold font. Also add the local ToC. Modified: lldb/trunk/docs/use/remote.rst Modified: lldb/trunk/docs/use/remote.rst URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/use/remote.rst?rev=360971&r1=360970&r2=360971&view=diff ============================================================================== --- lldb/trunk/docs/use/remote.rst (original) +++ lldb/trunk/docs/use/remote.rst Thu May 16 18:38:16 2019 @@ -23,8 +23,11 @@ communicating with it over the loopback 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 requir 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 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 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 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 "plat 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: _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits