Merge pull request #905 from jclsn/fix-spelling-errors

Fix spelling errors in docs

Author: puremourning

README.md

@@ -249,7 +249,7 @@ Which Linux versions? I only test on Ubuntu 20.04 and later and RHEL 7.
 
 ### Neovim limitations
 
-neovim doesn't implement mouse hover balloons. Instead there is the
+Neovim doesn't implement mouse hover balloons. Instead there is the
 `<Plug>VimspectorBalloonEval` mapping. There is no default mapping for this, so
 I recommend something like this to get variable display in a popup:
 
@@ -354,7 +354,7 @@ though the default behaviours are slightly different. For supported languages,
 they will:
 
 * Download the relevant debug adapter at a version that's been tested from the
-  internet, either as a 'vsix' (Visusal Studio plugin), or clone from GitHub. If
+  internet, either as a 'vsix' (Visual Studio plugin), or clone from GitHub. If
   you're in a corporate environment and this is a problem, you may need to
   install the gadgets manually.
 * Perform any necessary post-installation actions, such as:
@@ -557,7 +557,7 @@ Vimspector is not:
 * comprehensive. It's limited by DAP, and limited by my time. I implement the
   features I think most users will need, not every feature possible.
 * for everyone. Vimspector intentionally provides a "one size fits all" UI and
-  aproach. This means that it can only provide essential/basic debugging
+  approach. This means that it can only provide essential/basic debugging
   features for a given language. This makes it convenient for everyday usage,
   but not ideal for power users or those with very precise or specific
   requirements. See [motivation](#motivation) for more info.
@@ -653,7 +653,7 @@ features to set your own mappings. To that end, Vimspector defines the following
 | ---                                           | ---                                                                 | ---                                                               |
 | `<Plug>VimspectorContinue`                    | When debugging, continue. Otherwise start debugging.                | `vimspector#Continue()`                                           |
 | `<Plug>VimspectorStop`                        | Stop debugging.                                                     | `vimspector#Stop()`                                               |
-| `<Plug>VimpectorRestart`                      | Restart debugging with the same configuration.                      | `vimspector#Restart()`                                            |
+| `<Plug>VimspectorRestart`                      | Restart debugging with the same configuration.                      | `vimspector#Restart()`                                            |
 | `<Plug>VimspectorPause`                       | Pause debuggee.                                                     | `vimspector#Pause()`                                              |
 | `<Plug>VimspectorBreakpoints`                 | Show/hide the breakpoints window                                    | `vimspector#ListBreakpoints()`                                    |
 | `<Plug>VimspectorToggleBreakpoint`            | Toggle line breakpoint on the current line.                         | `vimspector#ToggleBreakpoint()`                                   |
@@ -684,7 +684,7 @@ nmap <F5> <Plug>VimspectorContinue
 
 In addition, many users probably want to only enable certain Vimspector mappings
 while debugging is active. This is also possible, though it requires writing
-[some vimscipt](#custom-mappings-while-debugging).
+[some vimscript](#custom-mappings-while-debugging).
 
 That said, many people are familiar with particular debuggers, so the following
 mappings can be enabled by setting `g:vimspector_enable_mappings` to the
@@ -776,7 +776,7 @@ users, the [mappings](#mappings) section contains the most common commands and
 default usage. This section can be used as a reference to create your own
 mappings or custom behaviours.
 
-All the below instructions assume a single debugging session. For deatils on how
+All the below instructions assume a single debugging session. For details on how
 to debug multiple independent apps at the same time, see
 [multiple debugging sessions][#multiple-debugging-sessions].
 
@@ -981,7 +981,7 @@ breakpoints. This section describes the full API in vimscript functions.
 
 Breakpoints are associated with the current
 [debugging session][#multiple-debugging-sessions]. When switching between
-sessions, the breakpont signs for the previous session are removed and the
+sessions, the breakpoint signs for the previous session are removed and the
 breakpoints for the newly activated session are displayed. While it might be
 useful to see breakpoints for all sessions, this can be very confusing.
 
@@ -1102,7 +1102,7 @@ deletes a breakpoint. If you wish to 'disable' breakpoints, use the
   remove a breakpoint at a specific file/line
 * Use `vimspector#ClearBreakpoints()` to clear all breakpoints
 * Use `vimspector#ResetExceptionBreakpoints()` to clear the exception breakpoints
-  configuration and re-anser the various questions like "Break on C++ Throw"
+  configuration and re-answer the various questions like "Break on C++ Throw"
 * Use `:VimspectorMkSession` and `:VimspectorLoadSession` to save and restore
   breakpoints
 * `call vimspector#ListBreakpoints()` - toggle breakpoints window
@@ -1192,8 +1192,8 @@ In both cases, the file/dir name argument is optional. By default, the file is
 named `.vimspector.session`, but this can be changed globally by setting
 `g:vimspector_session_file_name` to something else, or by manually specifying a
 path when calling the command. If you supply a directory, the default or
-configured session file name is read fron or written to that directory.
-Othewise, the file is read based on the currently open buffer or written to the
+configured session file name is read from or written to that directory.
+Otherwise, the file is read based on the currently open buffer or written to the
 current working directory.
 
 Advanced users may wish to automate the process of loading and saving, for
@@ -1321,25 +1321,25 @@ let g:ycm_semantic_triggers =  {
 
 ## Disassembly
 
-* Dispplay disassembly around current PC
+* Display disassembly around current PC
 * Step over/into/out by instruction (contextually, or using the WinBar)
 * `:VimspectorDisassemble`, `vimspector#ShowDisassembly()` or
   `<Plug>VimspectorDisassemble`
 
 [![Demo](https://asciinema.org/a/esEncAxP45CJmo8Em1sQtxRYe.svg)](https://asciinema.org/a/esEncAxP45CJmo8Em1sQtxRYe)
 
 Some debug adapters (few!) support disassembly. The way this works in DAP is a
-little wierd, but in practice vimspector will ask to disassemble a number of
+little weird, but in practice vimspector will ask to disassemble a number of
 instructions around the current stack frame's PC. This is then shown in a window
 with a WinBar similar to the Code window, but with instruction stepping
 granularity. There's a sign for the current instruction and the syntax
-highighting defaults to "asm" which mostly works ok for x86 and ARM.
+highlighting defaults to "asm" which mostly works ok for x86 and ARM.
 
 ![disassembly-view](https://user-images.githubusercontent.com/10584846/194766584-d798c96b-6e4e-4914-9d4a-991c219f78d0.png)
 
 As mentioned above, when your current window is the disassembly windows and you
 use the default "step" commands (e.g. `<F10>`), the stepping is automatically
-chnged to per-instruction rather than per statement.
+changed to per-instruction rather than per statement.
 
 Each time the process stops, vimspector requests about 2 windows full of
 instructions around the current PC. To see more, you can scroll the window.
@@ -1348,8 +1348,8 @@ scrolls to the top or near the bottom. This isn't perfect. Sometimes you have to
 scroll a bit more to make it page in (e.g. ctrl-e ctrl-y at the top).
 This is not ideal, and may be improved in future.
 
-You can control the intial height of the disassembly window with
-`let g:vimspector_disassembly_height = 10` (or whatver number of lines).
+You can control the initial height of the disassembly window with
+`let g:vimspector_disassembly_height = 10` (or whatever number of lines).
 
 The filetype (and syntax) of the buffers in the disassembly window is
 `vimspector-disassembly`. You can use `FileType` autocommands to customise
@@ -1520,7 +1520,7 @@ At any time there is a single "active" root session. Breakpoints are associated
 with the current session, and all UI and API commands are applied to the
 currently active session.
 
-When switching between root sessions, the breakpont signs for the previous
+When switching between root sessions, the breakpoint signs for the previous
 session are removed and the breakpoints for the newly activated session are
 displayed.  While it might be useful to see breakpoints for all sessions, this
 can be very confusing.
@@ -1535,7 +1535,7 @@ A typical workflow might be:
    `:VimspectorNewSession client` (`client` is now the active session).
 4. Add a breakpoint in the `client` session and start debugging with `<F5>`.
 
-You now have 2 vimspector tabs. Intuitively, wwitching to a particular tab will
+You now have 2 vimspector tabs. Intuitively, switching to a particular tab will
 make its session active. You can also manually switch the active session with
 `:VimspectorSwitchToSession <name>`.
 
@@ -1985,7 +1985,7 @@ use:
 
 ```
 
-for examk
+for example
 
 ## TCL
 
@@ -2457,8 +2457,8 @@ There is very limited support for customisation of the UI.
 
 ## Changing the default signs
 
-Vimsector uses the following signs internally. If they are defined before
-Vimsector uses them, they will not be replaced. So to customise the signs,
+Vimspector uses the following signs internally. If they are defined before
+Vimspector uses them, they will not be replaced. So to customise the signs,
 define them in your `vimrc`.
 
 
@@ -2552,14 +2552,14 @@ if changing the default priorities, it's recommended that:
 
 ## Presentation Hints
 
-***NOTE:*** This customisation point is currently ***unsable*** and may change
+***NOTE:*** This customisation point is currently ***unusable*** and may change
 at any time.
 
 Sometimes the Debug Adapter provides hints as to how the UI should display
 certain things. This includes stack frames, variables etc.
 
 Vimspector provides a simple way to customise how these are displayed, by
-setting values in the dictionary `g:vimsepctor_presentation_hint_hl`.
+setting values in the dictionary `g:vimspector_presentation_hint_hl`.
 
 The following keys are supported with the mentioned default highlight group.
 
@@ -2582,7 +2582,7 @@ The following keys are supported with the mentioned default highlight group.
 In addition, any value supplied in the DAP `VariablePresentationHint` can be set
 which will be used if supplied by the debug adapter.
 
-A silly example; the defaults should probably be OK for most colour scehemes:
+A silly example; the defaults should probably be OK for most colour schemes:
 
 ```viml
 let g:vimspector_presentation_hint_hl = {
@@ -2812,7 +2812,7 @@ function s:SetUpTerminal()
   set norelativenumber nonumber
 endfunction
 
-augroup MyVimspectorUICustomistaion
+augroup MyVimspectorUICustomisation
   autocmd!
   autocmd User VimspectorUICreated call s:CustomiseUI()
   autocmd User VimspectorTerminalOpened call s:SetUpTerminal()

docs/configuration.md

@@ -533,7 +533,7 @@ will point to the parent folder of the file that is currently open in vim.
 When starting debugging, you can specify which debug configuration to launch
 with `call vimspector#LaunchWithSettings( #{ configuration: 'name here' } )`.
 
-Otherwise, vimspector tries to work out which one to laucnh.
+Otherwise, vimspector tries to work out which one to launch.
 
 First it finds the configurations for the current filetype from the files, or
 ad-hoc dictionary, mentioned above.  Configurations are ignored if they specify
@@ -595,7 +595,7 @@ Setting `autoselect` to `false` overrides setting `default` to `true`.
 
 If you have a number of different types of files, say some Python and some
 javascript/node, you can specify the `filetypes` list in the `configuration`
-section.  As noted above, vimsepector will filter the list of configurations
+section.  As noted above, vimspector will filter the list of configurations
 based on the filetypes of the current buffer. If the `filetypes` entry is not
 provided, it's assume to apply to all buffer filetypes.
 
@@ -794,7 +794,7 @@ For example:
 }
 ```
 
-The resulting "derived" configuraition ends up like this:
+The resulting "derived" configuration ends up like this:
 
 ```jsonc
 {
@@ -836,7 +836,7 @@ Vimspector has in-built support for executing remote debuggers (such as
 where the development is done on one host and the runtime is
 some other host, account, container, etc.
 
-In order for it to work, it is preferred to have set up paswordless SSH between
+In order for it to work, it is preferred to have set up passwordless SSH between
 the local and remote machines/accounts. Then just tell Vimspector how to remotely
 launch and/or attach to the app. By default, 'ssh' command is being used.
 Optionally, the custom ssh command can be specified with cmd property which gives
@@ -918,7 +918,7 @@ Vimspector then orchestrates the various tools to set you up.
             //
             // Remember that you can use ${var} to ask for input. I use this to
             // call a custom command to return the PID for a named service, so
-            // here's an examle:
+            // here's an example:
             //
             "/path/to/secret/script/GetPIDForService", "${ServiceName}"
           ],
@@ -1112,7 +1112,7 @@ port.
       "port": "${port}",
       "launch": {
         "remote": {
-          "container": "${container}", // Docker container id or name to exec into to.
+          "container": "${container}", // Docker container id or name to exec into.
 
           // Command to launch the debuggee and attach the debugger;
           // %CMD% replaced with the remote-cmdLine configured in the launch
@@ -1146,7 +1146,7 @@ port.
             //
             // Remember that you can use ${var} to ask for input. I use this to
             // call a custom command to return the PID for a named service, so
-            // here's an examle:
+            // here's an example:
             //
             "sh", "-c", "pgrep", "-f", "${filename}"
           ],
@@ -1234,7 +1234,7 @@ Comments are "c-style", i.e.:
 
 There is much debate about whether JSON files should contain comments. I have
 added them because they are useful in the context of configuration files.
-Unforutnately this may mean your editor doesn't like them (they are strictly
+Unfortunately this may mean your editor doesn't like them (they are strictly
 invalid JSON) so it's up to you if you use them.
 
 Technically, Vimspector uses [JSON

docs/schema/index.md

@@ -7,13 +7,13 @@ configuration objects used for configuring Vimspector. For more information on
 JSON Schema, check out [Understanding JSON
 Schema](http://json-schema.org/understanding-json-schema)
 
-Vimsepctor specification  is based on [Draft 7][draft-7] of JSON Schema
+Vimspector specification  is based on [Draft 7][draft-7] of JSON Schema
 standard.
 
 ## The schemas
 
 * [`vimspector.schema.json`](vimspector.schema.json) - contains the full
-  configuration defnition (`.vimspector.json`).
+  configuration definition (`.vimspector.json`).
 * [`gadgets.schema.json`](gadgets.schema.json) - contains the specification for
   gadget-only objects (`.gadgets.json`).