[PATCH master/8.0] Fix NEWS formatting in GDB 8.0 section

[PATCH master/8.0] Fix NEWS formatting in GDB 8.0 section

[Simon Marchi]

There are two "New commands" sub-sections in the 8.0 release section,
merge them.  Remove an extra empty line.

This patch is for master and the 8.0 branch.

gdb/ChangeLog:

	* NEWS (Changes in GDB 8.0): Merge duplicate "New commands"
	sub-sections.  Remove extra empty line.
---
 gdb/NEWS | 23 ++++++++++-------------
 1 file changed, 10 insertions(+), 13 deletions(-)

diff --git a/gdb/NEWS b/gdb/NEWS
index eb1a589..23443eb 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -72,7 +72,6 @@
 
 FreeBSD/mips			mips*-*-freebsd
 
-
 * New targets
 
 Synopsys ARC			arc*-*-elf32
@@ -83,18 +82,6 @@ FreeBSD/mips			mips*-*-freebsd
 flash-erase
   Erases all the flash memory regions reported by the target.
 
-* New MI commands
-
--target-flash-erase
-  Erases all the flash memory regions reported by the target.  This is
-  equivalent to the CLI command flash-erase.
-
--file-list-shared-libraries
-  List the shared libraries in the program.  This is
-  equivalent to the CLI command "info shared".
-
-* New commands
-
 set disassembler-options
 show disassembler-options
   Controls the passing of target specific information to the disassembler.
@@ -106,6 +93,16 @@ show disassembler-options
 maint print arc arc-instruction address
   Print internal disassembler information about instruction at a given address.
 
+* New MI commands
+
+-target-flash-erase
+  Erases all the flash memory regions reported by the target.  This is
+  equivalent to the CLI command flash-erase.
+
+-file-list-shared-libraries
+  List the shared libraries in the program.  This is
+  equivalent to the CLI command "info shared".
+
 * Removed targets and native configurations
 
 Alpha running FreeBSD         alpha*-*-freebsd*
-- 
2.7.4

Re: [PATCH master/8.0] Fix NEWS formatting in GDB 8.0 section

[Eli Zaretskii]

> From: Simon Marchi <simon.marchi@ericsson.com>
> CC: Simon Marchi <simon.marchi@ericsson.com>
> Date: Thu, 25 May 2017 14:12:41 +0200
> 
> There are two "New commands" sub-sections in the 8.0 release section,
> merge them.  Remove an extra empty line.

Thanks for catching this.

I think we want it the other way around, though: move flash-erase
entry to the "New commands" section that comes after "New MI
commands", to be consistent with what we did in previous releases.

Re: [PATCH master/8.0] Fix NEWS formatting in GDB 8.0 section

[Simon Marchi]

On 2017-05-25 17:24, Eli Zaretskii wrote:
> Thanks for catching this.
> 
> I think we want it the other way around, though: move flash-erase
> entry to the "New commands" section that comes after "New MI
> commands", to be consistent with what we did in previous releases.

Hmm do you have an example of this?  There hasn't been new MI commands 
in a while from what I can see.

I put it this way because CLI commands are of interest to way more 
people than MI commands, so I think they should be higher in the list.  
But AFAIK, the order of NEWS is usually just the chronological order in 
which things were added (unless adding an item to an existing 
subsection), we don't follow a defined structure.

Simon

Re: [PATCH master/8.0] Fix NEWS formatting in GDB 8.0 section

[Eli Zaretskii]

> Date: Sun, 28 May 2017 23:18:08 +0200
> From: Simon Marchi <simon.marchi@polymtl.ca>
> Cc: Simon Marchi <simon.marchi@ericsson.com>, gdb-patches@sourceware.org
> 
> On 2017-05-25 17:24, Eli Zaretskii wrote:
> > Thanks for catching this.
> > 
> > I think we want it the other way around, though: move flash-erase
> > entry to the "New commands" section that comes after "New MI
> > commands", to be consistent with what we did in previous releases.
> 
> Hmm do you have an example of this?

I just looked further in NEWS, and the order I saw appears to be what
I described.

Re: [PATCH master/8.0] Fix NEWS formatting in GDB 8.0 section

[Simon Marchi]

On 2017-05-29 04:35, Eli Zaretskii wrote:
> I just looked further in NEWS, and the order I saw appears to be what
> I described.

Could you please point to specific instances?  When I search for "New MI 
commands" or variations, it brings me to GDB 6.8, for which MI commands 
are after CLI commands.

Re: [PATCH master/8.0] Fix NEWS formatting in GDB 8.0 section

[Eli Zaretskii]

> Date: Mon, 29 May 2017 07:25:09 +0200
> From: Simon Marchi <simon.marchi@polymtl.ca>
> Cc: simon.marchi@ericsson.com, gdb-patches@sourceware.org
> 
> On 2017-05-29 04:35, Eli Zaretskii wrote:
> > I just looked further in NEWS, and the order I saw appears to be what
> > I described.
> 
> Could you please point to specific instances?  When I search for "New MI 
> commands" or variations, it brings me to GDB 6.8, for which MI commands 
> are after CLI commands.

Sorry, you are right.  I've misread NEWS.

It seems our convention was to use this pattern:

 * Changes
 * New commands
 * New options
 * MI changes

So please make the 8.0 order consistent with that.

Thanks.

[PATCH v3] Fix NEWS formatting in GDB 8.0 section

[Simon Marchi]

Change the GDB 8.0 section of the NEWS file to try to follow this order:

  * Functional changes
  * Added and removed configurations and targets
  * New commands
  * New options
  * MI changes

In particular, there were two "New commands" sections.

gdb/ChangeLog:

	* NEWS (Changes in GDB 8.0): Remove extra empty line.  Move
	"Removed targets and native configurations" up.  Merge duplicate
	"New commands" sub-sections.  Add "New options" sub-sections.
---
 gdb/NEWS | 31 +++++++++++++++----------------
 1 file changed, 15 insertions(+), 16 deletions(-)

diff --git a/gdb/NEWS b/gdb/NEWS
index eb1a589..112aa2f 100644
--- a/gdb/NEWS
+++ b/gdb/NEWS
@@ -72,28 +72,25 @@
 
 FreeBSD/mips			mips*-*-freebsd
 
-
 * New targets
 
 Synopsys ARC			arc*-*-elf32
 FreeBSD/mips			mips*-*-freebsd
 
+* Removed targets and native configurations
+
+Alpha running FreeBSD         alpha*-*-freebsd*
+Alpha running GNU/kFreeBSD    alpha*-*-kfreebsd*-gnu
+
 * New commands
 
 flash-erase
   Erases all the flash memory regions reported by the target.
 
-* New MI commands
-
--target-flash-erase
-  Erases all the flash memory regions reported by the target.  This is
-  equivalent to the CLI command flash-erase.
-
--file-list-shared-libraries
-  List the shared libraries in the program.  This is
-  equivalent to the CLI command "info shared".
+maint print arc arc-instruction address
+  Print internal disassembler information about instruction at a given address.
 
-* New commands
+* New options
 
 set disassembler-options
 show disassembler-options
@@ -103,13 +100,15 @@ show disassembler-options
   The default value is the empty string.  Currently, the only supported
   targets are ARM, PowerPC and S/390.
 
-maint print arc arc-instruction address
-  Print internal disassembler information about instruction at a given address.
+* New MI commands
 
-* Removed targets and native configurations
+-target-flash-erase
+  Erases all the flash memory regions reported by the target.  This is
+  equivalent to the CLI command flash-erase.
 
-Alpha running FreeBSD         alpha*-*-freebsd*
-Alpha running GNU/kFreeBSD    alpha*-*-kfreebsd*-gnu
+-file-list-shared-libraries
+  List the shared libraries in the program.  This is
+  equivalent to the CLI command "info shared".
 
 *** Changes in GDB 7.12
 
-- 
2.7.4

Re: [PATCH v3] Fix NEWS formatting in GDB 8.0 section

[Eli Zaretskii]

> From: Simon Marchi <simon.marchi@ericsson.com>
> CC: Eli Zaretskii <eliz@gnu.org>, Simon Marchi <simon.marchi@ericsson.com>
> Date: Tue, 30 May 2017 11:12:35 +0200
> 
> Change the GDB 8.0 section of the NEWS file to try to follow this order:
> 
>   * Functional changes
>   * Added and removed configurations and targets
>   * New commands
>   * New options
>   * MI changes
> 
> In particular, there were two "New commands" sections.
> 
> gdb/ChangeLog:
> 
> 	* NEWS (Changes in GDB 8.0): Remove extra empty line.  Move
> 	"Removed targets and native configurations" up.  Merge duplicate
> 	"New commands" sub-sections.  Add "New options" sub-sections.

Thanks, this is OK.

Re: [PATCH v3] Fix NEWS formatting in GDB 8.0 section

[Simon Marchi]

On 2017-05-30 11:22, Eli Zaretskii wrote:
>> From: Simon Marchi <simon.marchi@ericsson.com>
>> CC: Eli Zaretskii <eliz@gnu.org>, Simon Marchi 
>> <simon.marchi@ericsson.com>
>> Date: Tue, 30 May 2017 11:12:35 +0200
>> 
>> Change the GDB 8.0 section of the NEWS file to try to follow this 
>> order:
>> 
>>   * Functional changes
>>   * Added and removed configurations and targets
>>   * New commands
>>   * New options
>>   * MI changes
>> 
>> In particular, there were two "New commands" sections.
>> 
>> gdb/ChangeLog:
>> 
>> 	* NEWS (Changes in GDB 8.0): Remove extra empty line.  Move
>> 	"Removed targets and native configurations" up.  Merge duplicate
>> 	"New commands" sub-sections.  Add "New options" sub-sections.
> 
> Thanks, this is OK.

Thanks, pushed to both master and gdb-8.0-branch.

(Just noticed I went directly from v1 to v3, whoops)