This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] gdb: ADI support


> Cc: gdb-patches@sourceware.org
> From: Wei-min Pan <weimin.pan@oracle.com>
> Date: Wed, 14 Jun 2017 10:15:28 -0700
> 
> > Do we need a NEWS entry for these new commands?
> 
> Is there any guideline as to when such an entry should be added?

Basically, any significant change in user-visible behavior should be
mentioned in NEWS.  New commands certainly belong to that class.

> I can add something like this:
> 
>          * NEWS: Add "adi examine" and "adi assign" commands for printing
>          and modifying values of ADI version tag on Sparc64 platform.

This is a ChangeLog entry.  The actual text in NEWS should go under
the "New commands" section, and it should say something like

  adi examine
    Examine ADI version tags.

  adi assign
    Assign new ADI version tags.

You will see similar examples where we announce other new commands.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]