Skip to content

Commit d25b2c8

Browse files
committed
[lldb][docs] Plain text format some things in remote debug guide
This emphasises that lldb-server and debugserver are binaries rather than generic terms. Format some option values too while I'm here.
1 parent acff049 commit d25b2c8

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

lldb/docs/use/remote.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ Remote system
3636
*************
3737

3838
On Linux and Android, all required remote functionality is contained in the
39-
lldb-server binary. This binary combines the functionality of the platform and
39+
``lldb-server binary``. This binary combines the functionality of the platform and
4040
gdb-remote stub. A single binary facilitates deployment and reduces code size,
41-
since the two functions share a lot of code. The lldb-server binary is also
42-
statically linked with the rest of LLDB (unlike lldb, which dynamically links
43-
to liblldb.so by default), so it does not have any dependencies on the rest of
41+
since the two functions share a lot of code. The ``lldb-server`` binary is also
42+
statically linked with the rest of LLDB (unlike ``lldb``, which dynamically links
43+
to ``liblldb.so`` by default), so it does not have any dependencies on the rest of
4444
lldb. On macOS and iOS, the remote-gdb functionality is implemented by the
45-
debugserver binary, which you will need to deploy alongside lldb-server.
45+
``debugserver`` binary, which you will need to deploy alongside ``lldb-server``.
4646

4747
The binaries mentioned above need to be present on the remote system to enable
4848
remote debugging. You can either compile on the remote system directly or copy
@@ -51,17 +51,17 @@ differs from the local one, you will need to cross-compile the correct version
5151
of the binaries. More information on cross-compiling LLDB can be found on the
5252
build page.
5353

54-
Once the binaries are in place, you just need to run the lldb-server in
55-
platform mode and specify the port it should listen on. For example, the
54+
Once the binaries are in place, you just need to run the ``lldb-server`` in
55+
``platform`` mode and specify the port it should listen on. For example, the
5656
command
5757

5858
::
5959

6060
remote% lldb-server platform --listen "*:1234" --server
6161

6262
will start the LLDB platform and wait for incoming connections from any address
63-
to port 1234. Specifying an address instead of * will only allow connections
64-
originating from that address. Adding a --server parameter to the command line
63+
to port ``1234``. Specifying an address instead of ``*`` will only allow connections
64+
originating from that address. Adding a ``--server`` parameter to the command line
6565
will fork off a new process for every incoming connection, allowing multiple
6666
parallel debug sessions.
6767

0 commit comments

Comments
 (0)