Merge pull request #165 from vapniks/remake-4-3

rocky · web-flow · commit cd83d72ccb52 · 2025-05-11T12:01:13.000-04:00
Grammar corrections in debugger documentation.
diff --git a/doc/readthedocs/debugger/commands/data/write.rst b/doc/readthedocs/debugger/commands/data/write.rst
@@ -8,9 +8,9 @@ Write the Commands of a Target (`write`)
 
 Use this to write the command portion of a target with `remake`s
 internal variables expanded.  If a filename is given that is the file
-where the expanded commands are written. If the filename is `here`
-then it is not written to a file but output inside the debugger as
-other debugger commands behave. And if no file name is given a
+where the expanded commands are written. If the filename is "here"
+then it is not written to a file but output inside the debugger like how
+other debugger commands behave. If no file name is given, a
 filename based on the target name is created.
 
 
diff --git a/doc/readthedocs/debugger/commands/files/edit.rst b/doc/readthedocs/debugger/commands/files/edit.rst
@@ -6,12 +6,12 @@ Edit Makefile (`edit`)
 
 **edit**
 
-Edit Make at the current target location.
+Edit the Makefile at the current target location.
 
 The editing program of your choice is invoked with the current line set to
 the active line in the program.
 
-You can customize to use any editor you want by using the `EDITOR`
+You can customize it to use any editor you want by using the `EDITOR`
 environment variable. The only restriction is that your editor, .e.g.
 `ex`, recognizes the following command-line syntax:
 
@@ -22,7 +22,7 @@ environment variable. The only restriction is that your editor, .e.g.
 The optional numeric value *+number* specifies the number of the
 line in the file where to start editing.  For example, to configure
 `remake` to use the `emacs` editor, you could use these commands
-with the in a POSIX shell:
+in a POSIX shell:
 
 ::
 
diff --git a/doc/readthedocs/debugger/commands/files/list.rst b/doc/readthedocs/debugger/commands/files/list.rst
@@ -8,7 +8,7 @@ List Makefile target (`list`)
 
 **list** *line-number* | **-**
 
-List target dependencies and commands for *target* or *line-number*
+List the dependencies and commands for a *target* or *line-number*
 
 Without a target name or line number, use the current target.
 A target name of `-` will use the parent target on the target stack.
diff --git a/doc/readthedocs/debugger/commands/files/load.rst b/doc/readthedocs/debugger/commands/files/load.rst
@@ -8,15 +8,15 @@ Read and Evaluate Makefile (`load`)
 
 Read in and evaluate GNU Makefile *file-glob*..
 
-*file-glob* should resolve after glob expansion to single GNU
+*file-glob* should resolve after glob expansion to a single GNU
 Makefile. Target dependencies are updated after reading in the file.
 
 Here are several possible uses of this command.
 
-In debug sessions you can fix the source code and the run `load` to have the code reread in, to test out the fix.
+In debug sessions you can fix the source code and then run `load` to have the code reread in, to test out the fix.
 
-Another use is to have pecific "debug"-oriented Makefiles that aren't
-normally used, but when you want to trace things are avialable.
+Another use is to have specific "debug"-oriented Makefiles that aren't
+normally used, but are available when you want to trace things.
 This is an aspect of aspect-oriented_ programming
 
 .. _aspect-oriented: https://en.wikipedia.org/wiki/Aspect-oriented_programming
diff --git a/doc/readthedocs/debugger/commands/info.rst b/doc/readthedocs/debugger/commands/info.rst
@@ -8,7 +8,7 @@ Information from the Debugged Session (`break`, `files`, `line`, `program`, `rul
 
 Gets various pieces of information about the program being debugged.
 
-You can give unique prefix of the name of a subcommand to get
+You can give a unique prefix of the name of a subcommand to get
 information about just that subcommand.
 
 Type `info` for a list of info subcommands and what they do. Type ``help info`` for a summary list of info subcommands.
diff --git a/doc/readthedocs/debugger/commands/info/break.rst b/doc/readthedocs/debugger/commands/info/break.rst
@@ -8,11 +8,11 @@ List all Breakpoints (`info break`)
 
 Show status of user-settable breakpoints.
 
-The columns in a line show are as follows:
+The columns in the output lines are as follows:
 
 * The \"Num\" column is the breakpoint number which can be used in a `delete` command.
-* The \"Disp\" column contains one of \"keep\", \"del\", the disposition of the breakpoint after it gets hit.
-* The \"mask\" at which points within the target that we stop
+* The \"Disp\" column contains one of \"keep\", \"del\"; the disposition of the breakpoint after it gets hit.
+* The \"mask\" column indicates at which points of the breakpoint execution is stopped (0x01=prereq, 0x02=run, 0x04=end, 0x07=all).
 * The \"Where\" column indicates where the breakpoint is located.
 
 Example:
diff --git a/doc/readthedocs/debugger/commands/os/cd.rst b/doc/readthedocs/debugger/commands/os/cd.rst
@@ -8,7 +8,7 @@ Set the Current Working Directory (`cd`)
 
 Set the working directory to *dir*.
 
-Changing this changes will the working directory in any subsequent
+Changing this changes the working directory for any subsequent
 build commands that are invoked.
 
 .. seealso::
diff --git a/doc/readthedocs/debugger/commands/os/pwd.rst b/doc/readthedocs/debugger/commands/os/pwd.rst
@@ -6,9 +6,9 @@ Print POSIX Working Directory (`pwd`)
 
 **pwd**
 
-Print working directory.
+Print the working directory.
 
-By default, this is the working directory for in any commands that run from the build.
+By default, this is the working directory for any commands that run from the build.
 
 .. seealso::
 
diff --git a/doc/readthedocs/debugger/commands/running.rst b/doc/readthedocs/debugger/commands/running.rst
@@ -13,7 +13,7 @@ program execution. You can:
 * restart the program
 * continue its execution until it would normally terminate or until a
   breakpoint is hit
-* step exection which is runs for a limited amount of code before stopping
+* step exection which runs for a limited amount of code before stopping
 
 .. toctree::
    :maxdepth: 1
diff --git a/doc/readthedocs/debugger/commands/running/continue.rst b/doc/readthedocs/debugger/commands/running/continue.rst
@@ -10,7 +10,7 @@ Continue executing debugged Makefile until another breakpoint or
 stopping point. If a target is given and valid we set a breakpoint at
 that target before continuing.
 
-As with the `break` command, the place in a target is in can be
+As with the `break` command, the precise stopping place within a target line can be
 specified. See :ref:`break <break>` for a list of the meanings of the
 target phases.
 
diff --git a/doc/readthedocs/debugger/commands/running/next.rst b/doc/readthedocs/debugger/commands/running/next.rst
@@ -15,7 +15,7 @@ Argument *count* means do this *count* times or until there's another reason to
 
    If you want more fine-grained stepping use :ref:`skip <step>`.
 
-   If you want to not stop at any of targets the current target depends
-   on, but instead run until after this target is remade, :ref:`finish <finish>`.
+   If you want to not stop at any dependencies of the current target, 
+   but instead run until after this target is remade use :ref:`finish <finish>`.
 
-   :ref:`skip <skip>`, and :ref:`continue <continue>`, provide other ways to progress execution.
+   :ref:`skip <skip>`, and :ref:`continue <continue>`, provide other ways to continue execution.
diff --git a/doc/readthedocs/debugger/commands/running/step.rst b/doc/readthedocs/debugger/commands/running/step.rst
@@ -12,7 +12,7 @@ Stepping is like `next` but it is more fine-grained. However we
 still don't stop at targets for which there is no rule.
 
 Argument *count* means do this *count* times (or until there's another
-reason to stop.
+reason to stop).
 
 Examples:
 +++++++++
diff --git a/doc/readthedocs/debugger/commands/set.rst b/doc/readthedocs/debugger/commands/set.rst
@@ -5,7 +5,7 @@
 
 Modifies parts of the debugger environment.
 
-You can give unique prefix of the name of a subcommand to get information about just that subcommand.
+You can give a unique prefix of the name of a subcommand to get information about just that subcommand.
 
 Type `set` for a list of set subcommands and what they do. Type ``help set``
 for a summary list of set subcommands.
diff --git a/doc/readthedocs/debugger/commands/show.rst b/doc/readthedocs/debugger/commands/show.rst
@@ -4,8 +4,8 @@
 
 **show**  [ *subcommand* ]
 
-A command for showing things about the debugger. You can give unique prefix of the name of a subcommand to get information about just that subcommand.
-nn
+A command for showing things about the debugger. You can give a unique prefix of the name of a subcommand to get information about just that subcommand.
+
 Type `show` for a list of show subcommands and what they do. Type ``help show`` for a summmary list of show subcommands.  Many of the "show"
 commands have a corresponding :ref:`set <set>` command.
 
diff --git a/doc/readthedocs/debugger/commands/show/keep-going.rst b/doc/readthedocs/debugger/commands/show/keep-going.rst
@@ -6,7 +6,7 @@ Show the value of the GNU Make `-k` flag (`show keep-going`)
 
 **show keep-going**
 
-Set value of GNU Make `--keep-going` (or `-k`) flag.
+Show the value of the GNU Make `--keep-going` (or `-k`) flag.
 
 .. seealso::
 
diff --git a/doc/readthedocs/debugger/commands/stack/down.rst b/doc/readthedocs/debugger/commands/stack/down.rst
@@ -6,13 +6,13 @@ Relative Motion towards a More-Recent Target (`down`)
 
 **down** [ *count* ]
 
-Select and print the target this one caused to be examined.
+Select and print the target that the current target caused to be examined (and is dependent on).
 
 If *count* is given then select that many targets down; the default is 1.
 
 When you enter the debugger this command doesn't make a lot of sense
 because you are at the most-recently frame. However if you issue
-`down` and `frame` commands, this can change.
+`up` and `frame` commands, this can change.
 
 .. seealso::
 
diff --git a/doc/readthedocs/debugger/commands/support/help.rst b/doc/readthedocs/debugger/commands/support/help.rst
@@ -10,10 +10,10 @@ Get help for a debugger command or subcommand.
 
 Without an argument, print the list of available debugger commands.
 
-When an argument is given, it is first checked to see if it is command
+When an argument is given, it is first checked to see if it is a command
 name.
 
 Some commands like `info`, `set`, and `show` can accept an
-additional subcommand to give help just about that particular
-subcommand. For example `help set basename` give help about the
+additional subcommand to give help about just that particular
+subcommand. For example `help set basename` gives help about the
 `basename` subcommand of `set`.
diff --git a/doc/readthedocs/debugger/commands/support/source.rst b/doc/readthedocs/debugger/commands/support/source.rst
@@ -8,7 +8,7 @@ Read and Run Debugger Commands from a File (`source`)
 
 Read debugger commands from the glob expansion of *file-glob*;
 
-*file-glob* should resolve after glob expansion to single file.
+*file-glob* should resolve to a single file after glob expansion.
 
 Examples:
 +++++++++
