saagarjha created this revision.
saagarjha added a reviewer: lldb-commits.
saagarjha set the repository for this revision to rL LLVM.
saagarjha added a project: LLDB.
I've gone through the GDB To LLDB Command Map and tried to improve it:
- Fix obvious typos (e.g. `<cope>` → `<code>`, "object C" to "Objective C")
- Wrap code and program names in `<code>` tags
- Convert names (e.g. "Mac OS X" → "macOS", "ObjC" → "Objective C"
- Reword a couple parts where (IMHO) the phrasing could be a bit better
Repository:
rL LLVM
https://reviews.llvm.org/D28758
Files:
www/lldb-gdb.html
Index: www/lldb-gdb.html
===================================================================
--- www/lldb-gdb.html
+++ www/lldb-gdb.html
@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="style.css" rel="stylesheet" type="text/css" />
-<title>LLDB to GDB Command Map</title>
+<title>GDB to LLDB Command Map</title>
</head>
<body>
@@ -20,10 +20,10 @@
<h1 class ="postheader">GDB to LLDB Command Map</h1>
<div class="post">
- <p>Below is a table of GDB commands with the LLDB counterparts.
+ <p>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 "<b>breakpoint set</b>",
+ unique short form can be used. For example, instead of "<b>breakpoint set</b>",
"<b>br se</b>" is also acceptable.</p>
</div>
<div class="postfooter"></div>
@@ -63,7 +63,7 @@
</td>
</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></tr>
+ <tr><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>
<td class="content">
<b>%</b> gdb --args a.out 1 2 3<br>
<b>(gdb)</b> run<br>
@@ -97,7 +97,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Launch a process with arguments in new terminal window (Mac OS X only).</td></tr>
+ <tr><td class="header" colspan="2">Launch a process with arguments in new terminal window (macOS only).</td></tr>
<td class="content">
</td>
<td class="content">
@@ -106,7 +106,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Launch a process with arguments in existing terminal <cope>/dev/ttys006</code> (Mac OS X only).</td></tr>
+ <tr><td class="header" colspan="2">Launch a process with arguments <code><args></code> in existing terminal <code>/dev/ttys006</code> (macOS only).</td></tr>
<td class="content">
</td>
<td class="content">
@@ -159,7 +159,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Attach to a process with process ID 123.</td></tr>
+ <tr><td class="header" colspan="2">Attach to the process with process ID 123.</td></tr>
<tr>
<td class="content">
<b>(gdb)</b> attach 123
@@ -333,7 +333,7 @@
<td class="hed" width="50%">LLDB</td>
</tr>
- <tr><td class="header" colspan="2">Set a breakpoint at all functions named <b>main</b>.</td></tr>
+ <tr><td class="header" colspan="2">Set a breakpoint at all functions named <b><code>main</code></b>.</td></tr>
<tr>
<td class="content">
<b>(gdb)</b> break main
@@ -345,7 +345,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Set a breakpoint in file <b>test.c</b> at line <b>12</b>.</td></tr>
+ <tr><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">
<b>(gdb)</b> break test.c:12
@@ -357,7 +357,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Set a breakpoint at all C++ methods whose basename is <b>main</b>.</td></tr>
+ <tr><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">
<b>(gdb)</b> break main<br>
@@ -369,7 +369,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Set a breakpoint at and object C function: <b>-[NSString stringWithFormat:]</b>.</td></tr>
+ <tr><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">
<b>(gdb)</b> break -[NSString stringWithFormat:]<br>
@@ -380,7 +380,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Set a breakpoint at all Objective C methods whose selector is <b>count</b>.</td></tr>
+ <tr><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">
<b>(gdb)</b> break count<br>
@@ -403,7 +403,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Ensure that breakpoints by file and line work for #included .c/.cpp/.m files.</td></tr>
+ <tr><td class="header" colspan="2">Ensure that breakpoints by file and line work for <code>#include</code>d .c/.cpp/.m files.</td></tr>
<tr>
<td class="content">
@@ -428,7 +428,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Set a conditional breakpoint</td></tr>
+ <tr><td class="header" colspan="2">Set a conditional breakpoint.</td></tr>
<tr>
<td class="content">
@@ -639,7 +639,7 @@
</td>
</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></tr>
+ <tr><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">
</td>
@@ -649,7 +649,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Display the variable "*this" only when you stop in c class named <b>MyClass</b>.</td></tr>
+ <tr><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">
</td>
@@ -708,7 +708,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Printing the ObjC "description" of an object.</td></tr>
+ <tr><td class="header" colspan="2">Printing the Objective C "description" of an object.</td></tr>
<tr>
<td class="content">
<b>(gdb)</b> po [SomeClass returnAnObject]<br>
@@ -735,7 +735,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Calling a function so you can stop at a breakpoint in the function.</td></tr>
+ <tr><td class="header" colspan="2">Call a function so you can stop at a breakpoint in it.</td></tr>
<tr>
<td class="content">
<b>(gdb)</b> set unwindonsignal 0<br>
@@ -746,7 +746,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Calling a function that crashes, and stopping when the function crashes.</td></tr>
+ <tr><td class="header" colspan="2">Call a function that crashes, then stop when it does.</td></tr>
<tr>
<td class="content">
<b>(gdb)</b> set unwindonsignal 0<br>
@@ -896,7 +896,7 @@
</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></tr>
+ 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">
</td>
@@ -945,7 +945,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Read memory from address 0xbffff3c0 and show 4 hex uint32_t values.</td></tr>
+ <tr><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">
<b>(gdb)</b> x/4xw 0xbffff3c0<br>
@@ -974,7 +974,7 @@
</td>
</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></tr>
+ <tr><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">
<b>(gdb)</b> set logging on<br>
@@ -999,7 +999,7 @@
<b>(lldb)</b> me r -o /tmp/mem.bin -b 0x1000 0x2000<br>
</td>
</tr>
- <tr><td class="header" colspan="2">Get information about a specific heap allocation (available on Mac OS X only).</td></tr>
+ <tr><td class="header" colspan="2">Get information about a specific heap allocation (available on macOS only).</td></tr>
<tr>
<td class="content">
<b>(gdb)</b> info malloc 0x10010d680
@@ -1010,7 +1010,7 @@
<b>(lldb)</b> malloc_info --stack-history 0x10010d680<br>
</td>
</tr>
- <tr><td class="header" colspan="2">Get information about a specific heap allocation and cast the result to any dynamic type that can be deduced (available on Mac OS X only)</td></tr>
+ <tr><td class="header" colspan="2">Get information about a specific heap allocation and cast the result to any dynamic type that can be deduced (available on macOS only).</td></tr>
<tr>
<td class="content">
</td>
@@ -1019,7 +1019,7 @@
<b>(lldb)</b> malloc_info --type 0x10010d680<br>
</td>
</tr>
- <tr><td class="header" colspan="2">Find all heap blocks that contain a pointer specified by an expression EXPR (available on Mac OS X only).</td></tr>
+ <tr><td class="header" colspan="2">Find all heap blocks that contain a pointer specified by expression EXPR (available on macOS only).</td></tr>
<tr>
<td class="content">
</td>
@@ -1028,7 +1028,7 @@
<b>(lldb)</b> ptr_refs EXPR <br>
</td>
</tr>
- <tr><td class="header" colspan="2">Find all heap blocks that contain a C string anywhere in the block (available on Mac OS X only).</td></tr>
+ <tr><td class="header" colspan="2">Find all heap blocks that contain a C string anywhere in the block (available on macOS only).</td></tr>
<tr>
<td class="content">
</td>
@@ -1048,7 +1048,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Disassemble any functions named <b>main</b>.</td></tr>
+ <tr><td class="header" colspan="2">Disassemble any functions named <b><code>main</code></b>.</td></tr>
<tr>
<td class="content">
<b>(gdb)</b> disassemble main
@@ -1179,7 +1179,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Look up information for an address in <b>a.out</b> only.</td></tr>
+ <tr><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">
</td>
@@ -1210,7 +1210,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Dump all sections in the <b>a.out</b> module.</td></tr>
+ <tr><td class="header" colspan="2">Dump all sections in the <b><code>a.out</code></b> module.</td></tr>
<tr>
<td class="content">
</td>
@@ -1228,7 +1228,7 @@
</td>
</tr>
- <tr><td class="header" colspan="2">Dump all symbols in <b>a.out</b> and <b>liba.so</b>.</td></tr>
+ <tr><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">
</td>
@@ -1260,7 +1260,7 @@
</td>
</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 different 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="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 different 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">
<b>(gdb)</b> set pathname-substitutions /buildbot/path /my/path<br>
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
