Document style behavior in batch mode.

Message ID 20190221132331.19849-1-alan.hayward@arm.com
State New
Headers show
Series
  • Document style behavior in batch mode.
Related show

Commit Message

Alan Hayward Feb. 21, 2019, 1:23 p.m.
Style is disabled when running in batch mode.

gdb/ChangeLog:

2019-02-21  Alan Hayward  <alan.hayward@arm.com>

	* NEWS: Update style defaults.

gdb/doc/ChangeLog:

2019-02-21  Alan Hayward  <alan.hayward@arm.com>

	* gdb.texinfo: Update style defaults.
---
 gdb/NEWS            | 2 +-
 gdb/doc/gdb.texinfo | 5 +++--
 2 files changed, 4 insertions(+), 3 deletions(-)

-- 
2.17.2 (Apple Git-113)

Comments

Eli Zaretskii Feb. 21, 2019, 3:11 p.m. | #1
> From: Alan Hayward <Alan.Hayward@arm.com>

> CC: nd <nd@arm.com>, Alan Hayward <Alan.Hayward@arm.com>

> Date: Thu, 21 Feb 2019 13:23:44 +0000

> 

> Style is disabled when running in batch mode.

> 

> gdb/ChangeLog:

> 

> 2019-02-21  Alan Hayward  <alan.hayward@arm.com>

> 

> 	* NEWS: Update style defaults.

> 

> gdb/doc/ChangeLog:

> 

> 2019-02-21  Alan Hayward  <alan.hayward@arm.com>

> 

> 	* gdb.texinfo: Update style defaults.


This is OK, but:

> --- a/gdb/doc/gdb.texinfo

> +++ b/gdb/doc/gdb.texinfo

> @@ -24514,8 +24514,9 @@ Show the current pagination mode.

>  @kindex set style

>  @kindex show style

>  @value{GDBN} can style its output on a capable terminal.  This is

> -enabled by default on most systems.  Various style settings are

> -available; and styles can also be disabled entirely.

> +enabled by default on most systems, but disabled by default when in

> +batch mode.  Various style settings are available; and styles can

> +also be disabled entirely.


Please insert "(@pxref{Mode Options})" (without the quotes) after
"batch mode", to provide the readers of the manual with a hyperlink to
where that mode is described.

Thanks.
Alan Hayward Feb. 21, 2019, 6:26 p.m. | #2
> On 21 Feb 2019, at 15:11, Eli Zaretskii <eliz@gnu.org> wrote:

> 

>> From: Alan Hayward <Alan.Hayward@arm.com>

>> CC: nd <nd@arm.com>, Alan Hayward <Alan.Hayward@arm.com>

>> Date: Thu, 21 Feb 2019 13:23:44 +0000

>> 

>> Style is disabled when running in batch mode.

>> 

>> gdb/ChangeLog:

>> 

>> 2019-02-21  Alan Hayward  <alan.hayward@arm.com>

>> 

>> 	* NEWS: Update style defaults.

>> 

>> gdb/doc/ChangeLog:

>> 

>> 2019-02-21  Alan Hayward  <alan.hayward@arm.com>

>> 

>> 	* gdb.texinfo: Update style defaults.

> 

> This is OK, but:

> 

>> --- a/gdb/doc/gdb.texinfo

>> +++ b/gdb/doc/gdb.texinfo

>> @@ -24514,8 +24514,9 @@ Show the current pagination mode.

>> @kindex set style

>> @kindex show style

>> @value{GDBN} can style its output on a capable terminal.  This is

>> -enabled by default on most systems.  Various style settings are

>> -available; and styles can also be disabled entirely.

>> +enabled by default on most systems, but disabled by default when in

>> +batch mode.  Various style settings are available; and styles can

>> +also be disabled entirely.

> 

> Please insert "(@pxref{Mode Options})" (without the quotes) after

> "batch mode", to provide the readers of the manual with a hyperlink to

> where that mode is described.

> 

> Thanks.



Thanks!
Patch pushed as:


diff --git a/gdb/NEWS b/gdb/NEWS
index eaef6aa384..8fe961b3f3 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -141,7 +141,7 @@ show tui tab-width NCHARS
 set style enabled [on|off]
 show style enabled
   Enable or disable terminal styling.  Styling is enabled by default
-  on most hosts.
+  on most hosts, but disabled by default when in batch mode.

 set style filename foreground COLOR
 set style filename background COLOR
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 6b47026aa0..977cc7bbdb 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -24514,8 +24514,9 @@ Show the current pagination mode.
 @kindex set style
 @kindex show style
 @value{GDBN} can style its output on a capable terminal.  This is
-enabled by default on most systems.  Various style settings are
-available; and styles can also be disabled entirely.
+enabled by default on most systems, but disabled by default when in
+batch mode (@pxref{Mode Options}).  Various style settings are available;
+and styles can also be disabled entirely.

 @table @code
 @item set style enabled @samp{on|off}

Patch

diff --git a/gdb/NEWS b/gdb/NEWS
index eaef6aa384..8fe961b3f3 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -141,7 +141,7 @@  show tui tab-width NCHARS
 set style enabled [on|off]
 show style enabled
   Enable or disable terminal styling.  Styling is enabled by default
-  on most hosts.
+  on most hosts, but disabled by default when in batch mode.
 
 set style filename foreground COLOR
 set style filename background COLOR
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 173d18be6f..cea1476a9a 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -24514,8 +24514,9 @@  Show the current pagination mode.
 @kindex set style
 @kindex show style
 @value{GDBN} can style its output on a capable terminal.  This is
-enabled by default on most systems.  Various style settings are
-available; and styles can also be disabled entirely.
+enabled by default on most systems, but disabled by default when in
+batch mode.  Various style settings are available; and styles can
+also be disabled entirely.
 
 @table @code
 @item set style enabled @samp{on|off}