Fix subject verb agreement in the description of several debug settings.

Message ID 1453482228-10587-1-git-send-email-jhb@FreeBSD.org
State New, archived
Headers

Commit Message

John Baldwin Jan. 22, 2016, 5:03 p.m. UTC
  gdb/doc/ChangeLog:

	* gdb.texinfo (Debugging Output): Fix subject verb disagreements.
---
 gdb/doc/ChangeLog   |  4 ++++
 gdb/doc/gdb.texinfo | 14 +++++++-------
 2 files changed, 11 insertions(+), 7 deletions(-)
  

Comments

Joel Brobecker Jan. 26, 2016, 12:38 p.m. UTC | #1
Adding [doco] to the subject, to alert Eli, our doc reviewer...

On Fri, Jan 22, 2016 at 09:03:48AM -0800, John Baldwin wrote:
> gdb/doc/ChangeLog:
> 
> 	* gdb.texinfo (Debugging Output): Fix subject verb disagreements.

By the way, I also replaced "PATCH" by "RFA", as "PATCH" has always
been a confusing term in our community, where we weren't sue that
the patch is being pushed (eg, as obvious), or whether it is waiting
for approval.

That's why some people use things like "commit" or "ob", or both...
Some people have also used "FYI", and then added an explicit line
in the email both to say that the patch has been pushed.

> ---
>  gdb/doc/ChangeLog   |  4 ++++
>  gdb/doc/gdb.texinfo | 14 +++++++-------
>  2 files changed, 11 insertions(+), 7 deletions(-)
> 
> diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
> index 990f2ec..09c6257 100644
> --- a/gdb/doc/ChangeLog
> +++ b/gdb/doc/ChangeLog
> @@ -1,3 +1,7 @@
> +2016-01-22  John Baldwin  <jhb@FreeBSD.org>
> +
> +	* gdb.texinfo (Debugging Output): Fix subject verb disagreements.
> +
>  2016-01-19  John Baldwin  <jhb@FreeBSD.org>
>  
>  	* gdb.texinfo (Debugging Output): Document "set/show debug fbsd-lwp".
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index cd311db..de3fe57 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -23622,7 +23622,7 @@ Displays the current state of displaying @value{GDBN} frame debugging
>  info.
>  @item set debug gnu-nat
>  @cindex @sc{gnu}/Hurd debug messages
> -Turns on or off debugging messages from the @sc{gnu}/Hurd debug support.
> +Turn on or off debugging messages from the @sc{gnu}/Hurd debug support.
>  @item show debug gnu-nat
>  Show the current state of @sc{gnu}/Hurd debugging messages.
>  @item set debug infrun
> @@ -23634,18 +23634,18 @@ for implementing operations such as single-stepping the inferior.
>  Displays the current state of @value{GDBN} inferior debugging.
>  @item set debug jit
>  @cindex just-in-time compilation, debugging messages
> -Turns on or off debugging messages from JIT debug support.
> +Turn on or off debugging messages from JIT debug support.
>  @item show debug jit
>  Displays the current state of @value{GDBN} JIT debugging.
>  @item set debug lin-lwp
>  @cindex @sc{gnu}/Linux LWP debug messages
>  @cindex Linux lightweight processes
> -Turns on or off debugging messages from the Linux LWP debug support.
> +Turn on or off debugging messages from the Linux LWP debug support.
>  @item show debug lin-lwp
>  Show the current state of Linux LWP debugging messages.
>  @item set debug linux-namespaces
>  @cindex @sc{gnu}/Linux namespaces debug messages
> -Turns on or off debugging messages from the Linux namespaces debug support.
> +Turn on or off debugging messages from the Linux namespaces debug support.
>  @item show debug linux-namespaces
>  Show the current state of Linux namespaces debugging messages.
>  @item set debug mach-o
> @@ -23657,7 +23657,7 @@ Displays the current state of displaying debugging messages related to
>  reading of COFF/PE exported symbols.
>  @item set debug notification
>  @cindex remote async notification debugging info
> -Turns on or off debugging messages about remote async notification.
> +Turn on or off debugging messages about remote async notification.
>  The default is off.
>  @item show debug notification
>  Displays the current state of remote async notification debugging messages.
> @@ -23703,7 +23703,7 @@ Displays the current state of displaying @value{GDBN} serial debugging
>  info.
>  @item set debug solib-frv
>  @cindex FR-V shared-library debugging
> -Turns on or off debugging messages for FR-V shared-library code.
> +Turn on or off debugging messages for FR-V shared-library code.
>  @item show debug solib-frv
>  Display the current state of FR-V shared-library code debugging
>  messages.
> @@ -23755,7 +23755,7 @@ Displays the current state of displaying @value{GDBN} variable object
>  debugging info.
>  @item set debug xml
>  @cindex XML parser debugging
> -Turns on or off debugging messages for built-in XML parsers.
> +Turn on or off debugging messages for built-in XML parsers.
>  @item show debug xml
>  Displays the current state of XML debugging messages.
>  @end table
> -- 
> 2.7.0
> 
> Alternatively, these descriptions could instead be reworded as
> "Turns on or off display of debugging messages..." which is a pattern
> followed by several other knobs.  I'm open to whichever you think
> would be most consistent.
  
Eli Zaretskii Jan. 26, 2016, 3:01 p.m. UTC | #2
> Date: Tue, 26 Jan 2016 16:38:09 +0400
> From: Joel Brobecker <brobecker@adacore.com>
> Cc: gdb-patches@sourceware.org, eliz@gnu.org
> 
> Adding [doco] to the subject, to alert Eli, our doc reviewer...
> 
> On Fri, Jan 22, 2016 at 09:03:48AM -0800, John Baldwin wrote:
> > gdb/doc/ChangeLog:
> > 
> > 	* gdb.texinfo (Debugging Output): Fix subject verb disagreements.

Fine with me, thanks.

(I did think it was being committed as obvious.)
  

Patch

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 990f2ec..09c6257 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,7 @@ 
+2016-01-22  John Baldwin  <jhb@FreeBSD.org>
+
+	* gdb.texinfo (Debugging Output): Fix subject verb disagreements.
+
 2016-01-19  John Baldwin  <jhb@FreeBSD.org>
 
 	* gdb.texinfo (Debugging Output): Document "set/show debug fbsd-lwp".
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index cd311db..de3fe57 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -23622,7 +23622,7 @@  Displays the current state of displaying @value{GDBN} frame debugging
 info.
 @item set debug gnu-nat
 @cindex @sc{gnu}/Hurd debug messages
-Turns on or off debugging messages from the @sc{gnu}/Hurd debug support.
+Turn on or off debugging messages from the @sc{gnu}/Hurd debug support.
 @item show debug gnu-nat
 Show the current state of @sc{gnu}/Hurd debugging messages.
 @item set debug infrun
@@ -23634,18 +23634,18 @@  for implementing operations such as single-stepping the inferior.
 Displays the current state of @value{GDBN} inferior debugging.
 @item set debug jit
 @cindex just-in-time compilation, debugging messages
-Turns on or off debugging messages from JIT debug support.
+Turn on or off debugging messages from JIT debug support.
 @item show debug jit
 Displays the current state of @value{GDBN} JIT debugging.
 @item set debug lin-lwp
 @cindex @sc{gnu}/Linux LWP debug messages
 @cindex Linux lightweight processes
-Turns on or off debugging messages from the Linux LWP debug support.
+Turn on or off debugging messages from the Linux LWP debug support.
 @item show debug lin-lwp
 Show the current state of Linux LWP debugging messages.
 @item set debug linux-namespaces
 @cindex @sc{gnu}/Linux namespaces debug messages
-Turns on or off debugging messages from the Linux namespaces debug support.
+Turn on or off debugging messages from the Linux namespaces debug support.
 @item show debug linux-namespaces
 Show the current state of Linux namespaces debugging messages.
 @item set debug mach-o
@@ -23657,7 +23657,7 @@  Displays the current state of displaying debugging messages related to
 reading of COFF/PE exported symbols.
 @item set debug notification
 @cindex remote async notification debugging info
-Turns on or off debugging messages about remote async notification.
+Turn on or off debugging messages about remote async notification.
 The default is off.
 @item show debug notification
 Displays the current state of remote async notification debugging messages.
@@ -23703,7 +23703,7 @@  Displays the current state of displaying @value{GDBN} serial debugging
 info.
 @item set debug solib-frv
 @cindex FR-V shared-library debugging
-Turns on or off debugging messages for FR-V shared-library code.
+Turn on or off debugging messages for FR-V shared-library code.
 @item show debug solib-frv
 Display the current state of FR-V shared-library code debugging
 messages.
@@ -23755,7 +23755,7 @@  Displays the current state of displaying @value{GDBN} variable object
 debugging info.
 @item set debug xml
 @cindex XML parser debugging
-Turns on or off debugging messages for built-in XML parsers.
+Turn on or off debugging messages for built-in XML parsers.
 @item show debug xml
 Displays the current state of XML debugging messages.
 @end table