[Lldb-commits] [lldb] r169997 - in /lldb/trunk: source/Commands/CommandObjectHelp.cpp www/tutorial.html

[Sean Callanan]

Author: spyffe
Date: Wed Dec 12 12:02:47 2012
New Revision: 169997

URL: http://llvm.org/viewvc/llvm-project?rev=169997&view=rev
Log:
Minor grammar and style fixes in documentation.

<rdar://problem/12861963>
<rdar://problem/12861904>

Modified:
    lldb/trunk/source/Commands/CommandObjectHelp.cpp
    lldb/trunk/www/tutorial.html

Modified: lldb/trunk/source/Commands/CommandObjectHelp.cpp
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Commands/CommandObjectHelp.cpp?rev=169997&r1=169996&r2=169997&view=diff
==============================================================================
--- lldb/trunk/source/Commands/CommandObjectHelp.cpp (original)
+++ lldb/trunk/source/Commands/CommandObjectHelp.cpp Wed Dec 12 12:02:47 2012
@@ -173,8 +173,9 @@
                     {
                             // Also emit a warning about using "--" in case you are using a command that takes options and arguments.
                             m_interpreter.OutputFormattedHelpText (output_strm, "", "",
-                                                                   "\nThis command takes options and arguments, if your arguments look like option specifiers"
-                                                                   " you must use '--' to terminate the options before starting to give the arguments.", 1);
+                                                                   "\nThis command takes options and free-form arguments.  If your arguments resemble"
+                                                                   " option specifiers (i.e., they start with a - or --), you must use ' -- ' between"
+                                                                   " the end of the command options and the beginning of the arguments.", 1);
                     }
 
                     // Mark this help command with a success status.

Modified: lldb/trunk/www/tutorial.html
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/www/tutorial.html?rev=169997&r1=169996&r2=169997&view=diff
==============================================================================
--- lldb/trunk/www/tutorial.html (original)
+++ lldb/trunk/www/tutorial.html Wed Dec 12 12:02:47 2012
@@ -136,10 +136,12 @@
                    things like if you specify "<code>--shlib <path></code>", and are completing on "<code>--file <path></code>", we will only
                    list source files in the shared library specified by "<code>--shlib <path></code>".</p>
 
-                   <p>The individual commands are pretty extensively documented, using
-                   the <code>help</code> command.  And there is an <code>apropos</code> command that will
-                   search the help for a particular word and dump a summary help string
-                   for each matching command.</p>
+                   <p>The individual commands are pretty extensively documented.  You can
+                   use the <code>help</code> command to get an overview of which commands are
+                   available or to obtain details about specific commands.  There is also an
+                   <code>apropos</code> command that will search the help text for all commands
+                   for a particular word and dump a summary help string for each matching
+                   command.</p>
 
                    <p>Finally, there is a mechanism to construct aliases for commonly used
                    commands.  So for instance if you get annoyed typing:</p>