[Lldb-commits] [lldb] 93ccccb - [lldb] Fix typos and update "GDB To LLDB Command Map" to be a bit more clear
Jonas Devlieghere via lldb-commits
lldb-commits at lists.llvm.org
Sun Jan 15 11:11:17 PST 2023
Author: Saagar Jha
Date: 2023-01-15T11:10:52-08:00
New Revision: 93ccccb00d9717b58ba93f0942a243ba6dac4ef6
URL: https://github.com/llvm/llvm-project/commit/93ccccb00d9717b58ba93f0942a243ba6dac4ef6
DIFF: https://github.com/llvm/llvm-project/commit/93ccccb00d9717b58ba93f0942a243ba6dac4ef6.diff
LOG: [lldb] Fix typos and update "GDB To LLDB Command Map" to be a bit more clear
I've gone through the GDB To LLDB Command Map and tried to improve it:
- Fix obvious typos (e.g. <cope> → <code>)
- Wrap code and program names in <code> tags
- Reword a couple parts where (IMHO) the phrasing could be a bit better
Differential revision: https://reviews.llvm.org/D28758
Added:
Modified:
lldb/docs/use/map.rst
Removed:
################################################################################
diff --git a/lldb/docs/use/map.rst b/lldb/docs/use/map.rst
index fd02fb8ac15c6..b11d583a22749 100644
--- a/lldb/docs/use/map.rst
+++ b/lldb/docs/use/map.rst
@@ -1,7 +1,7 @@
GDB to LLDB command map
=======================
-Below is a table of GDB commands with the LLDB counterparts. The built in
+Below is a table of GDB commands with their LLDB counterparts. The built in
GDB-compatibility aliases in LLDB are also listed. The full lldb command names
are often long, but any unique short form can be used. Instead of "**breakpoint
set**", "**br se**" is also acceptable.
@@ -58,7 +58,7 @@ Execution Commands
</tr>
<tr>
- <td class="header" colspan="2">Launch a process for with arguments <b><code>a.out 1 2 3</code></b> without having to supply the args every time.</td>
+ <td class="header" colspan="2">Launch process <b><code>a.out</code></b> with arguments <b><code>1 2 3</code></b> without having to supply the args every time.</td>
</tr>
<tr>
<td class="content">
@@ -124,9 +124,7 @@ Execution Commands
</tr>
<tr>
- <td class="header" colspan="2">Launch a process with arguments in existing terminal
- <cope>/dev/ttys006 (macOS only).</cope>
- </td>
+ <td class="header" colspan="2">Launch a process with arguments <code><args></code> in existing terminal <code>/dev/ttys006</code> (macOS only).</td>
</tr>
<tr>
<td class="content">
@@ -205,7 +203,7 @@ Execution Commands
</tr>
<tr>
- <td class="header" colspan="2">Attach to a process with process ID 123.</td>
+ <td class="header" colspan="2">Attach to the process with process ID 123.</td>
</tr>
<tr>
<td class="content">
@@ -219,7 +217,7 @@ Execution Commands
</tr>
<tr>
- <td class="header" colspan="2">Attach to a process named "a.out".</td>
+ <td class="header" colspan="2">Attach to the process named "a.out".</td>
</tr>
<tr>
<td class="content">
@@ -443,7 +441,7 @@ Breakpoint Commands
</tr>
<tr>
- <td class="header" colspan="2">Set a breakpoint at all functions named <b>main</b>.</td>
+ <td class="header" colspan="2">Set a breakpoint at all functions named <b><code>main</code></b>.</td>
</tr>
<tr>
<td class="content">
@@ -459,7 +457,7 @@ Breakpoint Commands
</tr>
<tr>
- <td class="header" colspan="2">Set a breakpoint in file <b>test.c</b> at line <b>12</b>.</td>
+ <td class="header" colspan="2">Set a breakpoint in file <b><code>test.c</code></b> at line <b>12</b>.</td>
</tr>
<tr>
<td class="content">
@@ -475,7 +473,7 @@ Breakpoint Commands
</tr>
<tr>
- <td class="header" colspan="2">Set a breakpoint at all C++ methods whose basename is <b>main</b>.</td>
+ <td class="header" colspan="2">Set a breakpoint at all C++ methods whose basename is <b><code>main</code></b>.</td>
</tr>
<tr>
<td class="content">
@@ -492,7 +490,7 @@ Breakpoint Commands
</tr>
<tr>
- <td class="header" colspan="2">Set a breakpoint at and object C function: <b>-[NSString stringWithFormat:]</b>.</td>
+ <td class="header" colspan="2">Set a breakpoint at an Objective-C function <b><code>-[NSString stringWithFormat:]</code></b>.</td>
</tr>
<tr>
<td class="content">
@@ -508,7 +506,7 @@ Breakpoint Commands
</tr>
<tr>
- <td class="header" colspan="2">Set a breakpoint at all Objective-C methods whose selector is <b>count</b>.</td>
+ <td class="header" colspan="2">Set a breakpoint at all Objective-C methods whose selector is <b><code>count</code></b>.</td>
</tr>
<tr>
<td class="content">
@@ -541,7 +539,7 @@ Breakpoint Commands
</tr>
<tr>
- <td class="header" colspan="2">Ensure that breakpoints by file and line work for #included .c/.cpp/.m files.</td>
+ <td class="header" colspan="2">Ensure that breakpoints by file and line work for <code>#include</code> .c/.cpp/.m files.</td>
</tr>
<tr>
@@ -577,7 +575,7 @@ Breakpoint Commands
</tr>
<tr>
- <td class="header" colspan="2">Set a conditional breakpoint</td>
+ <td class="header" colspan="2">Set a conditional breakpoint.</td>
</tr>
<tr>
@@ -901,7 +899,7 @@ Examining Variables
</tr>
<tr>
- <td class="header" colspan="2">Display the variables "argc" and "argv" only when you stop in the function named <b>main</b>.</td>
+ <td class="header" colspan="2">Display the variables "argc" and "argv" only when you stop in the function named <b><code>main</code></b>.</td>
</tr>
<tr>
<td class="content">
@@ -915,7 +913,7 @@ Examining Variables
</tr>
<tr>
- <td class="header" colspan="2">Display the variable "*this" only when you stop in c class named <b>MyClass</b>.</td>
+ <td class="header" colspan="2">Display the variable "*this" only when you stop in c class named <b><code>MyClass</code></b>.</td>
</tr>
<tr>
<td class="content">
@@ -1043,7 +1041,7 @@ Evaluating Expressions
</tr>
<tr>
- <td class="header" colspan="2">Calling a function so you can stop at a breakpoint in the function.</td>
+ <td class="header" colspan="2">Call a function so you can stop at a breakpoint in it.</td>
</tr>
<tr>
<td class="content">
@@ -1059,7 +1057,7 @@ Evaluating Expressions
</tr>
<tr>
- <td class="header" colspan="2">Calling a function that crashes, and stopping when the function crashes.</td>
+ <td class="header" colspan="2">Call a function that crashes, then stop when it does.</td>
</tr>
<tr>
<td class="content">
@@ -1292,7 +1290,7 @@ Examining Thread State
</tr>
<tr>
- <td class="header" colspan="2">Show the general purpose registers for the current thread formatted as <b>signed decimal</b>. LLDB tries to use the same format characters as <b>printf(3)</b> when possible. Type "help format" to see the full list of format specifiers.</td>
+ <td class="header" colspan="2">Show the general purpose registers for the current thread formatted as <b>signed decimal</b>. LLDB tries to use the same format characters as <b><code>printf(3)</code></b> when possible. Type "help format" to see the full list of format specifiers.</td>
</tr>
<tr>
<td class="content">
@@ -1364,7 +1362,7 @@ Examining Thread State
</tr>
<tr>
- <td class="header" colspan="2">Read memory from address 0xbffff3c0 and show 4 hex uint32_t values.</td>
+ <td class="header" colspan="2">Read memory from address 0xbffff3c0 and show 4 hex <code>uint32_t</code> values.</td>
</tr>
<tr>
<td class="content">
@@ -1409,7 +1407,7 @@ Examining Thread State
</tr>
<tr>
- <td class="header" colspan="2">Read 512 bytes of memory from address 0xbffff3c0 and save results to a local file as <b>text</b>.</td>
+ <td class="header" colspan="2">Read 512 bytes of memory from address 0xbffff3c0 and save the results to a local file as <b>text</b>.</td>
</tr>
<tr>
<td class="content">
@@ -1516,7 +1514,7 @@ Examining Thread State
</tr>
<tr>
- <td class="header" colspan="2">Disassemble any functions named <b>main</b>.</td>
+ <td class="header" colspan="2">Disassemble any functions named <b><code>main</code></b>.</td>
</tr>
<tr>
<td class="content">
@@ -1687,7 +1685,7 @@ Executable and Shared Library Query Commands
</tr>
<tr>
- <td class="header" colspan="2">Look up information for an address in <b>a.out</b> only.</td>
+ <td class="header" colspan="2">Look up information for an address in <b><code>a.out</code></b> only.</td>
</tr>
<tr>
<td class="content">
@@ -1731,7 +1729,7 @@ Executable and Shared Library Query Commands
</tr>
<tr>
- <td class="header" colspan="2">Dump all sections in the <b>a.out</b> module.</td>
+ <td class="header" colspan="2">Dump all sections in the <b><code>a.out</code></b> module.</td>
</tr>
<tr>
<td class="content">
@@ -1755,7 +1753,7 @@ Executable and Shared Library Query Commands
</tr>
<tr>
- <td class="header" colspan="2">Dump all symbols in <b>a.out</b> and <b>liba.so</b>.</td>
+ <td class="header" colspan="2">Dump all symbols in <b><code>a.out</code></b> and <b><code>liba.so</code></b>.</td>
</tr>
<tr>
<td class="content">
@@ -1810,7 +1808,7 @@ Miscellaneous
</tr>
<tr>
- <td class="header" colspan="2">Remap source file pathnames for the debug session. If your source files are no longer located in the same location as when the program was built --- maybe the program was built on a
diff erent computer --- you need to tell the debugger how to find the sources at their local file path instead of the build system's file path.</td>
+ <td class="header" colspan="2">Remap source file pathnames for the debug session. If your source files are no longer located in the same location as when the program was built (for example, if the program was built on a
diff erent computer) you need to tell the debugger how to find the sources at their local file path instead of the build system's file path.</td>
</tr>
<tr>
<td class="content">
More information about the lldb-commits
mailing list