diff mbox

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

Message ID 1495714361-17422-1-git-send-email-simon.marchi@ericsson.com
State New, archived
Headers

Commit Message

Simon Marchi May 25, 2017, 12:12 p.m. UTC 
  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(-)

Comments

Eli Zaretskii May 25, 2017, 3:24 p.m. UTC | #1 
> 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.
Simon Marchi May 28, 2017, 9:18 p.m. UTC | #2 
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
Eli Zaretskii May 29, 2017, 2:35 a.m. UTC | #3 
> 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.
Simon Marchi May 29, 2017, 5:25 a.m. UTC | #4 
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.
Eli Zaretskii May 30, 2017, 7:35 a.m. UTC | #5 
> 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.
diff mbox

Patch

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*