Fix typos and update "GDB To LLDB Command Map" to be a bit more clear

[saagarjha]

Summary

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

[jingham]

This looks fine to me. Thanks for cleaning this up!

[saagarjha]

@jingham Sorry if this is a stupid question, but it's been a while and it doesn't appear that anything has happened with this patch; what should I do with it? Should I be sending this patch to lldb-commits to be merged? Or will this all happen automatically? (Please bear with me–I've never committed to LLVM before, and I'm still trying to figure out how reviews work.)

[JDevlieghere]

Thanks Saagar!

lldb/docs/use/map.rst

 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.
 
 .. contents::
    :local:
 
 Execution Commands
<table class="mapping" cellspacing="0">
                   <br>
                   <b>(lldb)</b> run &lt;args&gt;
                   <br>
                   <b>(lldb)</b> r &lt;args&gt;
                </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>
+               <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">
                   <b>%</b> gdb --args a.out 1 2 3
                   <br>
                   <b>(gdb)</b> run
                   <br> ...
                   <br>
<table class="mapping" cellspacing="0">
                   <b>(lldb)</b> process launch --tty -- &lt;args&gt;
                   <br>
                   <b>(lldb)</b> pro la -t -- &lt;args&gt;
                   <br>
                </td>
          </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>&lt;args&gt;</code> in existing terminal <code>/dev/ttys006</code> (macOS only).</td>
          </tr>
          <tr>
                <td class="content">
                </td>
                <td class="content">
                   <b>(lldb)</b> process launch --tty=/dev/ttys006 -- &lt;args&gt;
                   <br>
                   <b>(lldb)</b> pro la -t/dev/ttys006 -- &lt;args&gt;
<table class="mapping" cellspacing="0">
                </td>
                <td class="content">
                   <b>(lldb)</b> process launch -E DEBUG=1
                   <br>
                </td>
          </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">
                   <b>(gdb)</b> attach 123
                </td>
                <td class="content">
                   <b>(lldb)</b> process attach --pid 123
                   <br>
                   <b>(lldb)</b> attach -p 123
                </td>
          </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">
                   <b>(gdb)</b> attach a.out
                </td>
                <td class="content">
                   <b>(lldb)</b> process attach --name a.out
                   <br>
.. raw:: html
    <table class="mapping" cellspacing="0">
       <tbody>
          <tr>
                <td class="hed" width="50%">GDB</td>
                <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>
+               <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
                </td>
                <td class="content">
                   <b>(lldb)</b> breakpoint set --name main
                   <br>
                   <b>(lldb)</b> br s -n main
                   <br>
                   <b>(lldb)</b> b main
                </td>
          </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">
                   <b>(gdb)</b> break test.c:12
                </td>
                <td class="content">
                   <b>(lldb)</b> breakpoint set --file test.c --line 12
                   <br>
                   <b>(lldb)</b> br s -f test.c -l 12
                   <br>
                   <b>(lldb)</b> b test.c:12
                </td>
          </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">
                   <b>(gdb)</b> break main
                   <br>
                   <i>(Hope that there are no C functions named <b>main</b>)</i>.
                </td>
                <td class="content">
                   <b>(lldb)</b> breakpoint set --method main
                   <br>
                   <b>(lldb)</b> br s -M main
                   <br>
                </td>
          </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">
                   <b>(gdb)</b> break -[NSString stringWithFormat:]
                   <br>
                </td>
                <td class="content">
                   <b>(lldb)</b> breakpoint set --name "-[NSString stringWithFormat:]"
                   <br>
                   <b>(lldb)</b> b -[NSString stringWithFormat:]
                   <br>
                </td>
          </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">
                   <b>(gdb)</b> break count
                   <br>
                   <i>(Hope that there are no C or C++ functions named <b>count</b>)</i>.
                </td>
                <td class="content">
<table class="mapping" cellspacing="0">
                   <b>(lldb)</b> breakpoint set --func-regex regular-expression
                   <br>
                   <b>(lldb)</b> br s -r regular-expression
                   <br>
                </td>
          </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>
                <td class="content">
                   <b>(gdb)</b> b foo.c:12
                   <br>
                </td>
                <td class="content">
<table class="mapping" cellspacing="0">
                   <b>(lldb)</b> breakpoint set --source-pattern regular-expression --file SourceFile
                   <br>
                   <b>(lldb)</b> br s -p regular-expression -f file
                   <br>
                </td>
          </tr>
 
          <tr>
-               <td class="header" colspan="2">Set a conditional breakpoint</td>
+               <td class="header" colspan="2">Set a conditional breakpoint.</td>
          </tr>
 
          <tr>
                <td class="content">
                   <b>(gdb)</b> break foo if strcmp(y,"hello") == 0
                   <br>
                </td>
                <td class="content">
<table class="mapping" cellspacing="0">
                   <b>(lldb)</b> display argc
                   <br>
                   <b>(lldb)</b> display argv
                   <br>
                </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>
+               <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>
                <td class="content">
                   <b>(lldb)</b> target stop-hook add --name main --one-liner "frame variable argc argv"
                   <br>
                   <b>(lldb)</b> ta st a -n main -o "fr v argc argv"
                   <br>
                </td>
          </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">
                </td>
                <td class="content">
                   <b>(lldb)</b> target stop-hook add --classname MyClass --one-liner "frame variable *this"
                   <br>
                   <b>(lldb)</b> ta st a -c MyClass -o "fr v *this"
<table class="mapping" cellspacing="0">
                   <b>(lldb)</b> expr -d 1 -- someCPPObjectPtrOrReference
                   <br> or set dynamic type printing to be the default:
                   <b>(lldb)</b> settings set target.prefer-dynamic run-target
                   <br>
                </td>
          </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">
                   <b>(gdb)</b> set unwindonsignal 0
                   <br>
                   <b>(gdb)</b> p function_with_a_breakpoint()
                   <br>
                </td>
                <td class="content">
                   <b>(lldb)</b> expr -i 0 -- function_with_a_breakpoint()
                   <br>
                </td>
          </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">
                   <b>(gdb)</b> set unwindonsignal 0
                   <br>
                   <b>(gdb)</b> p function_which_crashes()
                   <br>
                </td>
<table class="mapping" cellspacing="0">
                </td>
                <td class="content">
                   <b>(lldb)</b> register write pc `$pc+8`
                   <br>
                </td>
          </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">
                </td>
                <td class="content">
                   <b>(lldb)</b> register read --format i
                   <br>
                   <b>(lldb)</b> re r -f i
<table class="mapping" cellspacing="0">
                   <b>(lldb)</b> register read/t rax
                   <br>
                   <b>(lldb)</b> p/t $rax
                   <br>
                </td>
          </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">
                   <b>(gdb)</b> x/4xw 0xbffff3c0
                   <br>
                </td>
                <td class="content">
                   <b>(lldb)</b> memory read --size 4 --format x --count 4 0xbffff3c0
<table class="mapping" cellspacing="0">
                   <i><b>NOTE:</b> any command can inline a scalar expression result (as long as the target is stopped) using backticks around any expression:</i>
                   <br>
                   <b>(lldb)</b> memory read --size `sizeof(int)` `argv[0]`
                   <br>
                </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>
+               <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>
                   <b>(gdb)</b> set logging file /tmp/mem.txt
                   <br>
                   <b>(gdb)</b> x/512bx 0xbffff3c0
<table class="mapping" cellspacing="0">
                <td class="content">
                   <b>(lldb)</b> disassemble --frame
                   <br>
                   <b>(lldb)</b> di -f
                </td>
          </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">
                   <b>(gdb)</b> disassemble main
                </td>
                <td class="content">
                   <b>(lldb)</b> disassemble --name main
                   <br>
<table class="mapping" cellspacing="0">
                   <b>(lldb)</b> image lookup -v --address 0x1ec4
                   <br>
                   <br> and look for the LineEntry line, which will have the full source path and line range information.
                   <br>
                </td>
          </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">
                </td>
                <td class="content">
                   <b>(lldb)</b> image lookup --address 0x1ec4 a.out
                   <br>
                   <b>(lldb)</b> im loo -a 0x1ec4 a.out
<table class="mapping" cellspacing="0">
                </td>
                <td class="content">
                   <b>(lldb)</b> image dump sections
                   <br>
                </td>
          </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">
                </td>
                <td class="content">
                   <b>(lldb)</b> image dump sections a.out
                   <br>
                </td>
          </tr>
 
          <tr>
                <td class="header" colspan="2">Dump all symbols from the main executable and any shared libraries.</td>
          </tr>
          <tr>
                <td class="content">
                </td>
                <td class="content">
                   <b>(lldb)</b> image dump symtab
                   <br>
                </td>
          </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">
                </td>
                <td class="content">
                   <b>(lldb)</b> image dump symtab a.out liba.so
                   <br>
                </td>
<table class="mapping" cellspacing="0">
                </td>
                <td class="content">
                   <b>(lldb)</b> script print "Here is some text"
                   <br>
                </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>
+               <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>
                </td>
                <td class="content">
                   <b>(lldb)</b> settings set target.source-map /buildbot/path /my/path