[Lldb-commits] [lldb] b68545a - [lldb] Improve the documentation (#42017)

[Jonas Devlieghere via lldb-commits]

Author: Sushma Unnibhavi
Date: 2021-04-08T10:58:02-07:00
New Revision: b68545acf9771b6b205647b8028d9e042ede8838

URL: https://github.com/llvm/llvm-project/commit/b68545acf9771b6b205647b8028d9e042ede8838
DIFF: https://github.com/llvm/llvm-project/commit/b68545acf9771b6b205647b8028d9e042ede8838.diff

LOG: [lldb] Improve the documentation (#42017)

Added punctuation and changed "So for instance" to "For instance".

Fixes https://llvm.org/PR42017

Differential revision: https://reviews.llvm.org/D100053

Added: 
    

Modified: 
    lldb/docs/use/tutorial.rst

Removed: 
    


################################################################################
diff  --git a/lldb/docs/use/tutorial.rst b/lldb/docs/use/tutorial.rst
index 30c25fa4381fa..3c552a341e024 100644
--- a/lldb/docs/use/tutorial.rst
+++ b/lldb/docs/use/tutorial.rst
@@ -28,7 +28,7 @@ may have to quote some arguments in lldb that you wouldn't in gdb.
 
 Options can be placed anywhere on the command line, but if the arguments begin
 with a "-" then you have to tell lldb that you're done with options for the
-current command by adding an option termination: "--" So for instance if you
+current command by adding an option termination: "--". So for instance, if you
 want to launch a process and give the "process launch" command the
 "--stop-at-entry" option, yet you want the process you are about to launch to
 be launched with the arguments "-program_arg value", you would type:
@@ -121,7 +121,7 @@ command:
 
 lldb also supports command completion for source file names, symbol names, file
 names, etc. Completion is initiated by a hitting a TAB. Individual options in a
-command can have 
diff erent completers, so for instance the "--file <path>"
+command can have 
diff erent completers, so for instance, the "--file <path>"
 option in "breakpoint" completes to source files, the "--shlib <path>" option
 to currently loaded shared libraries, etc. We can even do things like if you
 specify "--shlib <path>", and are completing on "--file <path>", we will only
@@ -134,7 +134,7 @@ help text for all commands for a particular word and dump a summary help string
 for each matching command.
 
 Finally, there is a mechanism to construct aliases for commonly used commands.
-So for instance if you get annoyed typing:
+For instance, if you get annoyed typing:
 
 ::
 
@@ -162,10 +162,10 @@ set up.
 One alias of note that we do include by popular demand is a weak emulator of
 gdb's "break" command. It doesn't try to do everything that gdb's break command
 does (for instance, it doesn't handle foo.c::bar. But it mostly works, and
-makes the transition easier. Also by popular demand, it is aliased to b. If you
+makes the transition easier. Also, by popular demand, it is aliased to b. If you
 actually want to learn the lldb command set natively, that means it will get in
 the way of the rest of the breakpoint commands. Fortunately, if you don't like
-one of our aliases, you an easily get rid of it by running (for example):
+one of our aliases, you can easily get rid of it by running (for example):
 
 ::
 
@@ -183,7 +183,7 @@ The lldb command parser also supports "raw" commands, where, after command
 options are stripped off, the rest of the command string is passed
 uninterpreted to the command. This is convenient for commands whose arguments
 might be some complex expression that would be painful to backslash protect.
-For instance the "expression" command is a "raw" command for obvious reasons.
+For instance, the "expression" command is a "raw" command for obvious reasons.
 The "help" output for a command will tell you if it is "raw" or not, so you
 know what to expect. The one thing you have to watch out for is that since raw
 commands still can have options, if your command string has dashes in it,
@@ -248,9 +248,9 @@ locations if that file and line were inlined in 
diff erent places in your code.
 
 The logical breakpoint has an integer id, and its locations have an id within
 their parent breakpoint (the two are joined by a ".", e.g. 1.1 in the example
-above.)
+above).
 
-Also the logical breakpoints remain live so that if another shared library were
+Also, the logical breakpoints remain live so that if another shared library were
 to be loaded that had another implementation of the "alignLeftEdges:" selector,
 the new location would be added to breakpoint 1 (e.g. a "1.2" breakpoint would
 be set on the newly loaded selector).
@@ -284,7 +284,7 @@ locations were found:
 
 You can delete, disable, set conditions and ignore counts either on all the
 locations generated by your logical breakpoint, or on any one of the particular
-locations your specification resolved to. For instance if we wanted to add a
+locations your specification resolved to. For instance, if we wanted to add a
 command to print a backtrace when we hit this breakpoint we could do:
 
 ::
@@ -299,7 +299,7 @@ commands. You can also specify this explicitly by passing the "--command"
 option. Use "--script" if you want to implement your breakpoint command using
 the Python script instead.
 
-This is an convenient point to bring up another feature of the lldb command
+This is a convenient point to bring up another feature of the lldb command
 help. Do:
 
 ::