You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nuttx.apache.org by Nathan Hartman <ha...@gmail.com> on 2020/03/29 16:16:09 UTC
[DISCUSS] Release Notes
Earlier, in the thread "The Release"...
On Sun, Mar 29, 2020 at 11:44 AM Gregory Nutt <sp...@gmail.com> wrote:
> Do we plan to generate Release Notes? In my experience that is the most
> difficult part of the release (the rest is fun). Abdelatif tells me that
> there are 1051 commits. That is a much lower number that I expecteded,
> lower than most old 2 month cycles, but probably still more than anyone
> really wants to dig into in detail.
>
> We can control this level of effort. Perhaps we just want to list major
> new architectures and boards supported. And any major new OS features?
> That would be a relatively low effort. it would be nice to list the
> major bugs that have been fixed but I don't know of any easy way to get
> that.
I think we should have Release Notes.
But NOT in excruciating detail!!
Release Notes are for people who want to know:
* "What's new in this release?"
* "Why would I want to upgrade?"
* "What changes must I make in my application?"
* etc.
It's a very different thing than a Changelog. A Changelog contains
every detail of what changed and in my opinion that's an outdated
concept because interested parties can list the Git log, if they
really want to study every single change.
I think the Release Notes should be on the website, not bundled with
the release tarballs. Rationale: This will allow us to update the
release notes after the release is made. That would be done, e.g.,
when known problems are discovered in a release, or to document any
security issue(s) that the release fixes.
When new releases are made, Release Notes should only be added, never
removed, so that people will be able to access release notes for older
versions at any time.
The release notes could be structured according to the major parts of
the OS. Something like this:
(1) What's New In This Release
(A) Maybe a paragraph or two listing the most major new features/changes.
(B) Highlights of project news since last release.
(2) Compatibility Concerns
Point out any major changes that require changes by downstream users.
(3) Major Changes to Core OS
(A) New or significantly changed
(4) Major Changes to Build System
(A) New or significantly changed
(5) Architectural Support
(A) List new architectures
(B) List architectures with significant improvements
(C) List removed architectures
(6) Driver Support
(A) List major new drivers
(B) List drivers with significant improvements
(C) List removed drivers
(7) Security Issues Fixed in this Release
(8) Known Problems in this Release
(If any)
(9) More Information
(A) Where to find the release
(B) How to clone git repository and list full changelog
(C) How to contact the community
(10) Call to action: Invitation to get involved in Apache NuttX
community and development!
Thoughts?
Cheers,
Nathan
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
> Release notes are already pulled from the source code and placed on the
> webpage with the release.
>
Awesome!
-adam
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Brennan Ashton <ba...@brennanashton.com>.
On Sun, Mar 29, 2020 at 1:00 PM Adam Feuer <ad...@starcat.io> wrote:
> Having the release notes living apart from the software doesn't sound good
> to me– they could get out of sync. We can have copy the release notes to a
> web page manually or by a script if we need to.
>
Release notes are already pulled from the source code and placed on the
webpage with the release.
There are scripts to help with this that I used for all the previous
releases.
https://nuttx.apache.org/releases/8.2/
--Brennan
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
What I meant by the release notes want to live in source control is that
that they are fixed to that point in the software version control
repository. They can be updated later as necessary, but if someone needs to
check out that version (to find a bug, for particular vendor support, etc.)
the notes will be there.
Having the release notes living apart from the software doesn't sound good
to me– they could get out of sync. We can have copy the release notes to a
web page manually or by a script if we need to.
I just wanted to put a draft in the wiki so we could quickly iterate on
them, then put them in version control.
-adam
-adam
On Sun, Mar 29, 2020 at 12:49 PM Nathan Hartman <ha...@gmail.com>
wrote:
> On Sun, Mar 29, 2020 at 2:43 PM Gregory Nutt <sp...@gmail.com> wrote:
>
> >
> > > The release notes really want to be in source control,
> >
> > That is the reason that I always kept the ReleaseNotes in the
> > repository. Then there is no possibility that the ReleaseNotes can ever
> > become decouple from the release even after years and changes in ISPs.
> >
> > That is the same reason that I keep all of the Documentation in the
> > repository, so that we have versioned documentation for the release.
> >
> > Lots of advantages to keeping version related stuff inside the release!
>
>
> Okay I agree, but for purposes of being able to correct/update release
> notes later, can we write in the release notes that a newer more updated
> version of them may be on the website, and provide a link? That way, you'll
> always have a release notes in the release, but with the possibility to
> make corrections later.
>
> Cheers,
> Nathan
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Nathan Hartman <ha...@gmail.com>.
On Sun, Mar 29, 2020 at 2:43 PM Gregory Nutt <sp...@gmail.com> wrote:
>
> > The release notes really want to be in source control,
>
> That is the reason that I always kept the ReleaseNotes in the
> repository. Then there is no possibility that the ReleaseNotes can ever
> become decouple from the release even after years and changes in ISPs.
>
> That is the same reason that I keep all of the Documentation in the
> repository, so that we have versioned documentation for the release.
>
> Lots of advantages to keeping version related stuff inside the release!
Okay I agree, but for purposes of being able to correct/update release
notes later, can we write in the release notes that a newer more updated
version of them may be on the website, and provide a link? That way, you'll
always have a release notes in the release, but with the possibility to
make corrections later.
Cheers,
Nathan
Re: [DISCUSS] Release Notes
Posted by Gregory Nutt <sp...@gmail.com>.
> The release notes really want to be in source control,
That is the reason that I always kept the ReleaseNotes in the
repository. Then there is no possibility that the ReleaseNotes can ever
become decouple from the release even after years and changes in ISPs.
That is the same reason that I keep all of the Documentation in the
repository, so that we have versioned documentation for the release.
Lots of advantages to keeping version related stuff inside the release!
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
Hi,
I put Nathan's outline into the NuttX Wiki here:
https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
The release notes really want to be in source control, but maybe having the
outline here would help– we could copy this to a text file once it's done.
Wiki pages are great for getting a bunch of people to contribute quickly.
We could all put our ideas on this page, then once it stabilizes, copy it
to a text file like previous releases?
-adam
On Sun, Mar 29, 2020 at 9:16 AM Nathan Hartman <ha...@gmail.com>
wrote:
> Earlier, in the thread "The Release"...
>
> On Sun, Mar 29, 2020 at 11:44 AM Gregory Nutt <sp...@gmail.com> wrote:
> > Do we plan to generate Release Notes? In my experience that is the most
> > difficult part of the release (the rest is fun). Abdelatif tells me that
> > there are 1051 commits. That is a much lower number that I expecteded,
> > lower than most old 2 month cycles, but probably still more than anyone
> > really wants to dig into in detail.
> >
> > We can control this level of effort. Perhaps we just want to list major
> > new architectures and boards supported. And any major new OS features?
> > That would be a relatively low effort. it would be nice to list the
> > major bugs that have been fixed but I don't know of any easy way to get
> > that.
>
> I think we should have Release Notes.
>
> But NOT in excruciating detail!!
>
> Release Notes are for people who want to know:
> * "What's new in this release?"
> * "Why would I want to upgrade?"
> * "What changes must I make in my application?"
> * etc.
>
> It's a very different thing than a Changelog. A Changelog contains
> every detail of what changed and in my opinion that's an outdated
> concept because interested parties can list the Git log, if they
> really want to study every single change.
>
> I think the Release Notes should be on the website, not bundled with
> the release tarballs. Rationale: This will allow us to update the
> release notes after the release is made. That would be done, e.g.,
> when known problems are discovered in a release, or to document any
> security issue(s) that the release fixes.
>
> When new releases are made, Release Notes should only be added, never
> removed, so that people will be able to access release notes for older
> versions at any time.
>
> The release notes could be structured according to the major parts of
> the OS. Something like this:
>
> (1) What's New In This Release
>
> (A) Maybe a paragraph or two listing the most major new
> features/changes.
> (B) Highlights of project news since last release.
>
> (2) Compatibility Concerns
>
> Point out any major changes that require changes by downstream users.
>
> (3) Major Changes to Core OS
>
> (A) New or significantly changed
>
> (4) Major Changes to Build System
>
> (A) New or significantly changed
>
> (5) Architectural Support
>
> (A) List new architectures
> (B) List architectures with significant improvements
> (C) List removed architectures
>
> (6) Driver Support
>
> (A) List major new drivers
> (B) List drivers with significant improvements
> (C) List removed drivers
>
> (7) Security Issues Fixed in this Release
>
> (8) Known Problems in this Release
>
> (If any)
>
> (9) More Information
>
> (A) Where to find the release
> (B) How to clone git repository and list full changelog
> (C) How to contact the community
>
> (10) Call to action: Invitation to get involved in Apache NuttX
> community and development!
>
> Thoughts?
>
> Cheers,
> Nathan
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
I created the PR with the release notes from Confluence. It's here:
https://github.com/apache/incubator-nuttx/pull/801
If there is anything to add/remove/replace let me know.
On Wed, Apr 15, 2020 at 12:49 PM Alin Jerpelea <je...@gmail.com> wrote:
>
> Looks good in my opinion
> Thanks!
>
> Alin
>
>
> On Tue, Apr 14, 2020, 23:13 Abdelatif Guettouche <
> abdelatif.guettouche@gmail.com> wrote:
>
> > Are there any concerns or additions to the release notes?
> > I did some re-organisation yesterday. Mainly I put network related
> > changes to their own section and moved some other points that were not
> > where they belong.
> > I don't know what we should put in the first item "What's New In This
> > Release". Maybe a word that this is the first Apache release and
> > highlight some notable changes/additions like the x86_64 port.
> > Is this ready for a PR?
> >
> > On Fri, Apr 10, 2020 at 4:42 PM Abdelatif Guettouche
> > <ab...@gmail.com> wrote:
> > >
> > > > I don't need them anymore.
> > >
> > > Okay. I removed them.
> > >
> > > I also tried to re-organize a little bit. Please refer to this
> > > version of the document to have a look at the original organization:
> > >
> > https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=148645728
> > >
> > > "Bug fixes" under "Major Changes to Core OS" should only contain bug
> > > fixes to the OS not arch or drivers.
> > > Similarly, "Security Issues Fixed in this Release" should contain only
> > > security vulnerabilities.
> > >
> > >
> > > On Fri, Apr 10, 2020 at 2:58 AM Nathan Hartman <ha...@gmail.com>
> > wrote:
> > > >
> > > > On Thu, Apr 9, 2020 at 7:09 PM Abdelatif Guettouche <
> > > > abdelatif.guettouche@gmail.com> wrote:
> > > >
> > > > > Also, I didn't want to remove the PRs number, maybe Nathan still
> > needs
> > > > > them.
> > > >
> > > >
> > > > I don't need them anymore.
> > > >
> > > > Initially I thought that when writing the release notes, we could (in
> > > > parenthesis) link to the corresponding PR and/or Issue number(s) for
> > anyone
> > > > reading the release notes who might be interested in seeing more about
> > a
> > > > particular change. But I forgot to mention that so we can go ahead and
> > > > remove them.
> > > >
> > > > Cheers,
> > > > Nathan
> >
Re: [DISCUSS] Release Notes
Posted by Alin Jerpelea <je...@gmail.com>.
Looks good in my opinion
Thanks!
Alin
On Tue, Apr 14, 2020, 23:13 Abdelatif Guettouche <
abdelatif.guettouche@gmail.com> wrote:
> Are there any concerns or additions to the release notes?
> I did some re-organisation yesterday. Mainly I put network related
> changes to their own section and moved some other points that were not
> where they belong.
> I don't know what we should put in the first item "What's New In This
> Release". Maybe a word that this is the first Apache release and
> highlight some notable changes/additions like the x86_64 port.
> Is this ready for a PR?
>
> On Fri, Apr 10, 2020 at 4:42 PM Abdelatif Guettouche
> <ab...@gmail.com> wrote:
> >
> > > I don't need them anymore.
> >
> > Okay. I removed them.
> >
> > I also tried to re-organize a little bit. Please refer to this
> > version of the document to have a look at the original organization:
> >
> https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=148645728
> >
> > "Bug fixes" under "Major Changes to Core OS" should only contain bug
> > fixes to the OS not arch or drivers.
> > Similarly, "Security Issues Fixed in this Release" should contain only
> > security vulnerabilities.
> >
> >
> > On Fri, Apr 10, 2020 at 2:58 AM Nathan Hartman <ha...@gmail.com>
> wrote:
> > >
> > > On Thu, Apr 9, 2020 at 7:09 PM Abdelatif Guettouche <
> > > abdelatif.guettouche@gmail.com> wrote:
> > >
> > > > Also, I didn't want to remove the PRs number, maybe Nathan still
> needs
> > > > them.
> > >
> > >
> > > I don't need them anymore.
> > >
> > > Initially I thought that when writing the release notes, we could (in
> > > parenthesis) link to the corresponding PR and/or Issue number(s) for
> anyone
> > > reading the release notes who might be interested in seeing more about
> a
> > > particular change. But I forgot to mention that so we can go ahead and
> > > remove them.
> > >
> > > Cheers,
> > > Nathan
>
Re: [DISCUSS] Release Notes
Posted by Nathan Hartman <ha...@gmail.com>.
On Tue, Apr 14, 2020 at 5:13 PM Abdelatif Guettouche
<ab...@gmail.com> wrote:
> Are there any concerns or additions to the release notes?
I just made some minor changes (most notably, describing the DNS Dual
Host support where there was previously a note "what is this? No PR
description").
> I don't know what we should put in the first item "What's New In This
> Release". Maybe a word that this is the first Apache release and
> highlight some notable changes/additions like the x86_64 port.
> Is this ready for a PR?
I added some text there. It's just a suggestion. Feel free to edit it
(or expand/remove/etc) !!! :-)
Cheers,
Nathan
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
Are there any concerns or additions to the release notes?
I did some re-organisation yesterday. Mainly I put network related
changes to their own section and moved some other points that were not
where they belong.
I don't know what we should put in the first item "What's New In This
Release". Maybe a word that this is the first Apache release and
highlight some notable changes/additions like the x86_64 port.
Is this ready for a PR?
On Fri, Apr 10, 2020 at 4:42 PM Abdelatif Guettouche
<ab...@gmail.com> wrote:
>
> > I don't need them anymore.
>
> Okay. I removed them.
>
> I also tried to re-organize a little bit. Please refer to this
> version of the document to have a look at the original organization:
> https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=148645728
>
> "Bug fixes" under "Major Changes to Core OS" should only contain bug
> fixes to the OS not arch or drivers.
> Similarly, "Security Issues Fixed in this Release" should contain only
> security vulnerabilities.
>
>
> On Fri, Apr 10, 2020 at 2:58 AM Nathan Hartman <ha...@gmail.com> wrote:
> >
> > On Thu, Apr 9, 2020 at 7:09 PM Abdelatif Guettouche <
> > abdelatif.guettouche@gmail.com> wrote:
> >
> > > Also, I didn't want to remove the PRs number, maybe Nathan still needs
> > > them.
> >
> >
> > I don't need them anymore.
> >
> > Initially I thought that when writing the release notes, we could (in
> > parenthesis) link to the corresponding PR and/or Issue number(s) for anyone
> > reading the release notes who might be interested in seeing more about a
> > particular change. But I forgot to mention that so we can go ahead and
> > remove them.
> >
> > Cheers,
> > Nathan
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
> I don't need them anymore.
Okay. I removed them.
I also tried to re-organize a little bit. Please refer to this
version of the document to have a look at the original organization:
https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=148645728
"Bug fixes" under "Major Changes to Core OS" should only contain bug
fixes to the OS not arch or drivers.
Similarly, "Security Issues Fixed in this Release" should contain only
security vulnerabilities.
On Fri, Apr 10, 2020 at 2:58 AM Nathan Hartman <ha...@gmail.com> wrote:
>
> On Thu, Apr 9, 2020 at 7:09 PM Abdelatif Guettouche <
> abdelatif.guettouche@gmail.com> wrote:
>
> > Also, I didn't want to remove the PRs number, maybe Nathan still needs
> > them.
>
>
> I don't need them anymore.
>
> Initially I thought that when writing the release notes, we could (in
> parenthesis) link to the corresponding PR and/or Issue number(s) for anyone
> reading the release notes who might be interested in seeing more about a
> particular change. But I forgot to mention that so we can go ahead and
> remove them.
>
> Cheers,
> Nathan
Re: [DISCUSS] Release Notes
Posted by Nathan Hartman <ha...@gmail.com>.
On Thu, Apr 9, 2020 at 7:09 PM Abdelatif Guettouche <
abdelatif.guettouche@gmail.com> wrote:
> Also, I didn't want to remove the PRs number, maybe Nathan still needs
> them.
I don't need them anymore.
Initially I thought that when writing the release notes, we could (in
parenthesis) link to the corresponding PR and/or Issue number(s) for anyone
reading the release notes who might be interested in seeing more about a
particular change. But I forgot to mention that so we can go ahead and
remove them.
Cheers,
Nathan
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
I didn't track bugfixes when I looked through the PRs, I'll go back and
look at them, should be able to do it tomorrow.
-adam
On Thu, Apr 9, 2020 at 5:02 PM Abdelatif Guettouche <
abdelatif.guettouche@gmail.com> wrote:
> I don't know how you and Nathan proceeded, but I went through all the
> PRs and kept those with significant changes.
> Only the "Major Changes to Core OS" bullet has a "bugfixes" list.
> The other have "significant improvements" lists, so I put everything
> other than "new" or "removed" there.
>
> On Fri, Apr 10, 2020 at 12:33 AM Adam Feuer <ad...@starcat.io> wrote:
> >
> > Abdelatif,
> >
> > Looks good to me. Thanks!
> >
> > Are we ready to work on summarizing the bugfixes now?
> >
> > -adam
> >
> > On Thu, Apr 9, 2020 at 4:09 PM Abdelatif Guettouche <
> > abdelatif.guettouche@gmail.com> wrote:
> >
> > > The list of the PRs where all under "Features Added" so we lost some
> > > organization in the page. I guess this is what you referred to when
> > > you said that we want them in order.
> > > Here how it looked before:
> > >
> https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=148645728
> > >
> > > I tried to put everything in the right place and added other notes
> > > from my range of PRs.
> > > Please take a look.
> > >
> > > Also, I didn't want to remove the PRs number, maybe Nathan still needs
> > > them.
> > >
> > > On Thu, Apr 9, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
> > > >
> > > > Ok, I categorized the features to try to add some meaning to them:
> > > >
> > > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> > > >
> > > > What do you think? If this is good, we can go on to listing bugs, and
> > > split
> > > > the PRs up...
> > > >
> > > > -adam
> > > >
> > > > On Thu, Apr 9, 2020 at 12:39 PM Adam Feuer <ad...@starcat.io> wrote:
> > > >
> > > > > I think putting them in some kind of order is helpful, to give them
> > > > > meaning... that's helpful for users. I would rather not look
> through a
> > > > > 20-point list to have to pick out the important things... I want
> > > someone
> > > > > else to do that for me, or at least try. :)
> > > > >
> > > > > -adam
> > > > >
> > > > > On Thu, Apr 9, 2020 at 12:29 PM Abdelatif Guettouche <
> > > > > abdelatif.guettouche@gmail.com> wrote:
> > > > >
> > > > >> > It would be a GREAT help if in the future all contributors fill
> out
> > > the
> > > > >> PR
> > > > >> > description with a little bit of info. Most PRs had nothing or
> very
> > > > >> little,
> > > > >> > which meant I was going by title or looking at code which was
> hard.
> > > > >> I had the exact same experience, having to go through the code to
> > > > >> determine what the PR was actually about was no fun. Maybe it's
> time
> > > > >> to put in a PR_TEMPLATE.
> > > > >>
> > > > >> > Now for features, now we need to prioritize the features by
> > > importance.
> > > > >> Who
> > > > >> > can do that?
> > > > >> Why do we want to prioritize them?
> > > > >> I guess we can just pick them as they arrived.
> > > > >>
> > > > >>
> > > > >> On Thu, Apr 9, 2020 at 8:05 PM Adam Feuer <ad...@starcat.io>
> wrote:
> > > > >> >
> > > > >> > I did PRs 466-761. Lots of bugfixes, not many true added
> features. I
> > > > >> added
> > > > >> > the feature info to the 9.0 release notes wiki page
> > > > >> > <https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0>.
> > > > >> >
> > > > >> > It would be a GREAT help if in the future all contributors fill
> out
> > > the
> > > > >> PR
> > > > >> > description with a little bit of info. Most PRs had nothing or
> very
> > > > >> little,
> > > > >> > which meant I was going by title or looking at code which was
> hard.
> > > > >> >
> > > > >> > Now for features, now we need to prioritize the features by
> > > importance.
> > > > >> Who
> > > > >> > can do that?
> > > > >> >
> > > > >> > And for bug fixes... shall we take a run through the lists
> again and
> > > > >> pull
> > > > >> > out important bug fixes? Or does anyone have another idea?
> > > > >> >
> > > > >> > -adam
> > > > >> >
> > > > >> >
> > > > >> > On Tue, Apr 7, 2020 at 4:30 PM Abdelatif Guettouche <
> > > > >> > abdelatif.guettouche@gmail.com> wrote:
> > > > >> >
> > > > >> > > I skimmed my range of PRs and created a draft PR[1] where I
> > > updated
> > > > >> the
> > > > >> > > ReleaseNote document. I basically went through all the PRs and
> > > > >> selected
> > > > >> > > only those with significant changes. This is also a work in
> > > > >> progress, I'll
> > > > >> > > wait for Nathan to sort his notes in the wiki before I move
> mine
> > > > >> there.
> > > > >> > >
> > > > >> > > To go back to the release notes discussion and where they
> should
> > > be,
> > > > >> if we
> > > > >> > > keep only the latest release notes in the top level
> ReleaseNote
> > > file
> > > > >> they
> > > > >> > > will never be decoupled from the release. Brennan's script can
> > > also be
> > > > >> > > updated to fetch them out.
> > > > >> > > The current ReleaseNote file has 26620 lines, it's hard to
> focus
> > > > >> there.
> > > > >> > >
> > > > >> > > On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <
> > > > >> hartman.nathan@gmail.com>
> > > > >> > > wrote:
> > > > >> > >
> > > > >> > > > On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io>
> > > wrote:
> > > > >> > > > > Ok, so let's split up the PRs with the three people we
> have
> > > now,
> > > > >> > > > Abdelatif,
> > > > >> > > > > Nathan, and me. As new people join, we can give them
> ranges to
> > > > >> look at.
> > > > >> > > > >
> > > > >> > > > > Let's do features first:
> > > > >> > > > >
> > > > >> > > > > - Abdelatif: PRs: 1-232
> > > > >> > > > > - Nathan: PRs: 233-465
> > > > >> > > > > - Adam: PRs: 466-697
> > > > >> > > > >
> > > > >> > > > > Read the PRs, take notes as a bulleted list, and add to
> the
> > > wiki
> > > > >> here
> > > > >> > > > under
> > > > >> > > > > 2b Features:
> > > > >> > > > >
> > > > >> > > > >
> https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> > > > >> > > >
> > > > >> > > > I added a very INITIAL list of PRs from 233 to 465 that I
> think
> > > are
> > > > >> > > > new features. This is a WORK IN PROGRESS! It's by no means
> > > finished
> > > > >> > > > text and will obviouslyneed a lot of refinement. At this
> point,
> > > I'll
> > > > >> > > > need to study each of those PRs in more detail to decide
> how the
> > > > >> > > > description should be worded and whether they should be
> moved to
> > > > >> other
> > > > >> > > > sections. But for now, my work-in-progress is there...
> > > > >> > > >
> > > > >> > > > Cheers,
> > > > >> > > > Nathan
> > > > >> > > >
> > > > >> > >
> > > > >> >
> > > > >> >
> > > > >> > --
> > > > >> > Adam Feuer <ad...@starcat.io>
> > > > >>
> > > > >
> > > > >
> > > > > --
> > > > > Adam Feuer <ad...@starcat.io>
> > > > >
> > > >
> > > >
> > > > --
> > > > Adam Feuer <ad...@starcat.io>
> > >
> >
> >
> > --
> > Adam Feuer <ad...@starcat.io>
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
I don't know how you and Nathan proceeded, but I went through all the
PRs and kept those with significant changes.
Only the "Major Changes to Core OS" bullet has a "bugfixes" list.
The other have "significant improvements" lists, so I put everything
other than "new" or "removed" there.
On Fri, Apr 10, 2020 at 12:33 AM Adam Feuer <ad...@starcat.io> wrote:
>
> Abdelatif,
>
> Looks good to me. Thanks!
>
> Are we ready to work on summarizing the bugfixes now?
>
> -adam
>
> On Thu, Apr 9, 2020 at 4:09 PM Abdelatif Guettouche <
> abdelatif.guettouche@gmail.com> wrote:
>
> > The list of the PRs where all under "Features Added" so we lost some
> > organization in the page. I guess this is what you referred to when
> > you said that we want them in order.
> > Here how it looked before:
> > https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=148645728
> >
> > I tried to put everything in the right place and added other notes
> > from my range of PRs.
> > Please take a look.
> >
> > Also, I didn't want to remove the PRs number, maybe Nathan still needs
> > them.
> >
> > On Thu, Apr 9, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
> > >
> > > Ok, I categorized the features to try to add some meaning to them:
> > >
> > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> > >
> > > What do you think? If this is good, we can go on to listing bugs, and
> > split
> > > the PRs up...
> > >
> > > -adam
> > >
> > > On Thu, Apr 9, 2020 at 12:39 PM Adam Feuer <ad...@starcat.io> wrote:
> > >
> > > > I think putting them in some kind of order is helpful, to give them
> > > > meaning... that's helpful for users. I would rather not look through a
> > > > 20-point list to have to pick out the important things... I want
> > someone
> > > > else to do that for me, or at least try. :)
> > > >
> > > > -adam
> > > >
> > > > On Thu, Apr 9, 2020 at 12:29 PM Abdelatif Guettouche <
> > > > abdelatif.guettouche@gmail.com> wrote:
> > > >
> > > >> > It would be a GREAT help if in the future all contributors fill out
> > the
> > > >> PR
> > > >> > description with a little bit of info. Most PRs had nothing or very
> > > >> little,
> > > >> > which meant I was going by title or looking at code which was hard.
> > > >> I had the exact same experience, having to go through the code to
> > > >> determine what the PR was actually about was no fun. Maybe it's time
> > > >> to put in a PR_TEMPLATE.
> > > >>
> > > >> > Now for features, now we need to prioritize the features by
> > importance.
> > > >> Who
> > > >> > can do that?
> > > >> Why do we want to prioritize them?
> > > >> I guess we can just pick them as they arrived.
> > > >>
> > > >>
> > > >> On Thu, Apr 9, 2020 at 8:05 PM Adam Feuer <ad...@starcat.io> wrote:
> > > >> >
> > > >> > I did PRs 466-761. Lots of bugfixes, not many true added features. I
> > > >> added
> > > >> > the feature info to the 9.0 release notes wiki page
> > > >> > <https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0>.
> > > >> >
> > > >> > It would be a GREAT help if in the future all contributors fill out
> > the
> > > >> PR
> > > >> > description with a little bit of info. Most PRs had nothing or very
> > > >> little,
> > > >> > which meant I was going by title or looking at code which was hard.
> > > >> >
> > > >> > Now for features, now we need to prioritize the features by
> > importance.
> > > >> Who
> > > >> > can do that?
> > > >> >
> > > >> > And for bug fixes... shall we take a run through the lists again and
> > > >> pull
> > > >> > out important bug fixes? Or does anyone have another idea?
> > > >> >
> > > >> > -adam
> > > >> >
> > > >> >
> > > >> > On Tue, Apr 7, 2020 at 4:30 PM Abdelatif Guettouche <
> > > >> > abdelatif.guettouche@gmail.com> wrote:
> > > >> >
> > > >> > > I skimmed my range of PRs and created a draft PR[1] where I
> > updated
> > > >> the
> > > >> > > ReleaseNote document. I basically went through all the PRs and
> > > >> selected
> > > >> > > only those with significant changes. This is also a work in
> > > >> progress, I'll
> > > >> > > wait for Nathan to sort his notes in the wiki before I move mine
> > > >> there.
> > > >> > >
> > > >> > > To go back to the release notes discussion and where they should
> > be,
> > > >> if we
> > > >> > > keep only the latest release notes in the top level ReleaseNote
> > file
> > > >> they
> > > >> > > will never be decoupled from the release. Brennan's script can
> > also be
> > > >> > > updated to fetch them out.
> > > >> > > The current ReleaseNote file has 26620 lines, it's hard to focus
> > > >> there.
> > > >> > >
> > > >> > > On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <
> > > >> hartman.nathan@gmail.com>
> > > >> > > wrote:
> > > >> > >
> > > >> > > > On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io>
> > wrote:
> > > >> > > > > Ok, so let's split up the PRs with the three people we have
> > now,
> > > >> > > > Abdelatif,
> > > >> > > > > Nathan, and me. As new people join, we can give them ranges to
> > > >> look at.
> > > >> > > > >
> > > >> > > > > Let's do features first:
> > > >> > > > >
> > > >> > > > > - Abdelatif: PRs: 1-232
> > > >> > > > > - Nathan: PRs: 233-465
> > > >> > > > > - Adam: PRs: 466-697
> > > >> > > > >
> > > >> > > > > Read the PRs, take notes as a bulleted list, and add to the
> > wiki
> > > >> here
> > > >> > > > under
> > > >> > > > > 2b Features:
> > > >> > > > >
> > > >> > > > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> > > >> > > >
> > > >> > > > I added a very INITIAL list of PRs from 233 to 465 that I think
> > are
> > > >> > > > new features. This is a WORK IN PROGRESS! It's by no means
> > finished
> > > >> > > > text and will obviouslyneed a lot of refinement. At this point,
> > I'll
> > > >> > > > need to study each of those PRs in more detail to decide how the
> > > >> > > > description should be worded and whether they should be moved to
> > > >> other
> > > >> > > > sections. But for now, my work-in-progress is there...
> > > >> > > >
> > > >> > > > Cheers,
> > > >> > > > Nathan
> > > >> > > >
> > > >> > >
> > > >> >
> > > >> >
> > > >> > --
> > > >> > Adam Feuer <ad...@starcat.io>
> > > >>
> > > >
> > > >
> > > > --
> > > > Adam Feuer <ad...@starcat.io>
> > > >
> > >
> > >
> > > --
> > > Adam Feuer <ad...@starcat.io>
> >
>
>
> --
> Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
Abdelatif,
Looks good to me. Thanks!
Are we ready to work on summarizing the bugfixes now?
-adam
On Thu, Apr 9, 2020 at 4:09 PM Abdelatif Guettouche <
abdelatif.guettouche@gmail.com> wrote:
> The list of the PRs where all under "Features Added" so we lost some
> organization in the page. I guess this is what you referred to when
> you said that we want them in order.
> Here how it looked before:
> https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=148645728
>
> I tried to put everything in the right place and added other notes
> from my range of PRs.
> Please take a look.
>
> Also, I didn't want to remove the PRs number, maybe Nathan still needs
> them.
>
> On Thu, Apr 9, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
> >
> > Ok, I categorized the features to try to add some meaning to them:
> >
> > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> >
> > What do you think? If this is good, we can go on to listing bugs, and
> split
> > the PRs up...
> >
> > -adam
> >
> > On Thu, Apr 9, 2020 at 12:39 PM Adam Feuer <ad...@starcat.io> wrote:
> >
> > > I think putting them in some kind of order is helpful, to give them
> > > meaning... that's helpful for users. I would rather not look through a
> > > 20-point list to have to pick out the important things... I want
> someone
> > > else to do that for me, or at least try. :)
> > >
> > > -adam
> > >
> > > On Thu, Apr 9, 2020 at 12:29 PM Abdelatif Guettouche <
> > > abdelatif.guettouche@gmail.com> wrote:
> > >
> > >> > It would be a GREAT help if in the future all contributors fill out
> the
> > >> PR
> > >> > description with a little bit of info. Most PRs had nothing or very
> > >> little,
> > >> > which meant I was going by title or looking at code which was hard.
> > >> I had the exact same experience, having to go through the code to
> > >> determine what the PR was actually about was no fun. Maybe it's time
> > >> to put in a PR_TEMPLATE.
> > >>
> > >> > Now for features, now we need to prioritize the features by
> importance.
> > >> Who
> > >> > can do that?
> > >> Why do we want to prioritize them?
> > >> I guess we can just pick them as they arrived.
> > >>
> > >>
> > >> On Thu, Apr 9, 2020 at 8:05 PM Adam Feuer <ad...@starcat.io> wrote:
> > >> >
> > >> > I did PRs 466-761. Lots of bugfixes, not many true added features. I
> > >> added
> > >> > the feature info to the 9.0 release notes wiki page
> > >> > <https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0>.
> > >> >
> > >> > It would be a GREAT help if in the future all contributors fill out
> the
> > >> PR
> > >> > description with a little bit of info. Most PRs had nothing or very
> > >> little,
> > >> > which meant I was going by title or looking at code which was hard.
> > >> >
> > >> > Now for features, now we need to prioritize the features by
> importance.
> > >> Who
> > >> > can do that?
> > >> >
> > >> > And for bug fixes... shall we take a run through the lists again and
> > >> pull
> > >> > out important bug fixes? Or does anyone have another idea?
> > >> >
> > >> > -adam
> > >> >
> > >> >
> > >> > On Tue, Apr 7, 2020 at 4:30 PM Abdelatif Guettouche <
> > >> > abdelatif.guettouche@gmail.com> wrote:
> > >> >
> > >> > > I skimmed my range of PRs and created a draft PR[1] where I
> updated
> > >> the
> > >> > > ReleaseNote document. I basically went through all the PRs and
> > >> selected
> > >> > > only those with significant changes. This is also a work in
> > >> progress, I'll
> > >> > > wait for Nathan to sort his notes in the wiki before I move mine
> > >> there.
> > >> > >
> > >> > > To go back to the release notes discussion and where they should
> be,
> > >> if we
> > >> > > keep only the latest release notes in the top level ReleaseNote
> file
> > >> they
> > >> > > will never be decoupled from the release. Brennan's script can
> also be
> > >> > > updated to fetch them out.
> > >> > > The current ReleaseNote file has 26620 lines, it's hard to focus
> > >> there.
> > >> > >
> > >> > > On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <
> > >> hartman.nathan@gmail.com>
> > >> > > wrote:
> > >> > >
> > >> > > > On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io>
> wrote:
> > >> > > > > Ok, so let's split up the PRs with the three people we have
> now,
> > >> > > > Abdelatif,
> > >> > > > > Nathan, and me. As new people join, we can give them ranges to
> > >> look at.
> > >> > > > >
> > >> > > > > Let's do features first:
> > >> > > > >
> > >> > > > > - Abdelatif: PRs: 1-232
> > >> > > > > - Nathan: PRs: 233-465
> > >> > > > > - Adam: PRs: 466-697
> > >> > > > >
> > >> > > > > Read the PRs, take notes as a bulleted list, and add to the
> wiki
> > >> here
> > >> > > > under
> > >> > > > > 2b Features:
> > >> > > > >
> > >> > > > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> > >> > > >
> > >> > > > I added a very INITIAL list of PRs from 233 to 465 that I think
> are
> > >> > > > new features. This is a WORK IN PROGRESS! It's by no means
> finished
> > >> > > > text and will obviouslyneed a lot of refinement. At this point,
> I'll
> > >> > > > need to study each of those PRs in more detail to decide how the
> > >> > > > description should be worded and whether they should be moved to
> > >> other
> > >> > > > sections. But for now, my work-in-progress is there...
> > >> > > >
> > >> > > > Cheers,
> > >> > > > Nathan
> > >> > > >
> > >> > >
> > >> >
> > >> >
> > >> > --
> > >> > Adam Feuer <ad...@starcat.io>
> > >>
> > >
> > >
> > > --
> > > Adam Feuer <ad...@starcat.io>
> > >
> >
> >
> > --
> > Adam Feuer <ad...@starcat.io>
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
The list of the PRs where all under "Features Added" so we lost some
organization in the page. I guess this is what you referred to when
you said that we want them in order.
Here how it looked before:
https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=148645728
I tried to put everything in the right place and added other notes
from my range of PRs.
Please take a look.
Also, I didn't want to remove the PRs number, maybe Nathan still needs them.
On Thu, Apr 9, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
>
> Ok, I categorized the features to try to add some meaning to them:
>
> https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
>
> What do you think? If this is good, we can go on to listing bugs, and split
> the PRs up...
>
> -adam
>
> On Thu, Apr 9, 2020 at 12:39 PM Adam Feuer <ad...@starcat.io> wrote:
>
> > I think putting them in some kind of order is helpful, to give them
> > meaning... that's helpful for users. I would rather not look through a
> > 20-point list to have to pick out the important things... I want someone
> > else to do that for me, or at least try. :)
> >
> > -adam
> >
> > On Thu, Apr 9, 2020 at 12:29 PM Abdelatif Guettouche <
> > abdelatif.guettouche@gmail.com> wrote:
> >
> >> > It would be a GREAT help if in the future all contributors fill out the
> >> PR
> >> > description with a little bit of info. Most PRs had nothing or very
> >> little,
> >> > which meant I was going by title or looking at code which was hard.
> >> I had the exact same experience, having to go through the code to
> >> determine what the PR was actually about was no fun. Maybe it's time
> >> to put in a PR_TEMPLATE.
> >>
> >> > Now for features, now we need to prioritize the features by importance.
> >> Who
> >> > can do that?
> >> Why do we want to prioritize them?
> >> I guess we can just pick them as they arrived.
> >>
> >>
> >> On Thu, Apr 9, 2020 at 8:05 PM Adam Feuer <ad...@starcat.io> wrote:
> >> >
> >> > I did PRs 466-761. Lots of bugfixes, not many true added features. I
> >> added
> >> > the feature info to the 9.0 release notes wiki page
> >> > <https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0>.
> >> >
> >> > It would be a GREAT help if in the future all contributors fill out the
> >> PR
> >> > description with a little bit of info. Most PRs had nothing or very
> >> little,
> >> > which meant I was going by title or looking at code which was hard.
> >> >
> >> > Now for features, now we need to prioritize the features by importance.
> >> Who
> >> > can do that?
> >> >
> >> > And for bug fixes... shall we take a run through the lists again and
> >> pull
> >> > out important bug fixes? Or does anyone have another idea?
> >> >
> >> > -adam
> >> >
> >> >
> >> > On Tue, Apr 7, 2020 at 4:30 PM Abdelatif Guettouche <
> >> > abdelatif.guettouche@gmail.com> wrote:
> >> >
> >> > > I skimmed my range of PRs and created a draft PR[1] where I updated
> >> the
> >> > > ReleaseNote document. I basically went through all the PRs and
> >> selected
> >> > > only those with significant changes. This is also a work in
> >> progress, I'll
> >> > > wait for Nathan to sort his notes in the wiki before I move mine
> >> there.
> >> > >
> >> > > To go back to the release notes discussion and where they should be,
> >> if we
> >> > > keep only the latest release notes in the top level ReleaseNote file
> >> they
> >> > > will never be decoupled from the release. Brennan's script can also be
> >> > > updated to fetch them out.
> >> > > The current ReleaseNote file has 26620 lines, it's hard to focus
> >> there.
> >> > >
> >> > > On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <
> >> hartman.nathan@gmail.com>
> >> > > wrote:
> >> > >
> >> > > > On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io> wrote:
> >> > > > > Ok, so let's split up the PRs with the three people we have now,
> >> > > > Abdelatif,
> >> > > > > Nathan, and me. As new people join, we can give them ranges to
> >> look at.
> >> > > > >
> >> > > > > Let's do features first:
> >> > > > >
> >> > > > > - Abdelatif: PRs: 1-232
> >> > > > > - Nathan: PRs: 233-465
> >> > > > > - Adam: PRs: 466-697
> >> > > > >
> >> > > > > Read the PRs, take notes as a bulleted list, and add to the wiki
> >> here
> >> > > > under
> >> > > > > 2b Features:
> >> > > > >
> >> > > > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> >> > > >
> >> > > > I added a very INITIAL list of PRs from 233 to 465 that I think are
> >> > > > new features. This is a WORK IN PROGRESS! It's by no means finished
> >> > > > text and will obviouslyneed a lot of refinement. At this point, I'll
> >> > > > need to study each of those PRs in more detail to decide how the
> >> > > > description should be worded and whether they should be moved to
> >> other
> >> > > > sections. But for now, my work-in-progress is there...
> >> > > >
> >> > > > Cheers,
> >> > > > Nathan
> >> > > >
> >> > >
> >> >
> >> >
> >> > --
> >> > Adam Feuer <ad...@starcat.io>
> >>
> >
> >
> > --
> > Adam Feuer <ad...@starcat.io>
> >
>
>
> --
> Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
Ok, I categorized the features to try to add some meaning to them:
https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
What do you think? If this is good, we can go on to listing bugs, and split
the PRs up...
-adam
On Thu, Apr 9, 2020 at 12:39 PM Adam Feuer <ad...@starcat.io> wrote:
> I think putting them in some kind of order is helpful, to give them
> meaning... that's helpful for users. I would rather not look through a
> 20-point list to have to pick out the important things... I want someone
> else to do that for me, or at least try. :)
>
> -adam
>
> On Thu, Apr 9, 2020 at 12:29 PM Abdelatif Guettouche <
> abdelatif.guettouche@gmail.com> wrote:
>
>> > It would be a GREAT help if in the future all contributors fill out the
>> PR
>> > description with a little bit of info. Most PRs had nothing or very
>> little,
>> > which meant I was going by title or looking at code which was hard.
>> I had the exact same experience, having to go through the code to
>> determine what the PR was actually about was no fun. Maybe it's time
>> to put in a PR_TEMPLATE.
>>
>> > Now for features, now we need to prioritize the features by importance.
>> Who
>> > can do that?
>> Why do we want to prioritize them?
>> I guess we can just pick them as they arrived.
>>
>>
>> On Thu, Apr 9, 2020 at 8:05 PM Adam Feuer <ad...@starcat.io> wrote:
>> >
>> > I did PRs 466-761. Lots of bugfixes, not many true added features. I
>> added
>> > the feature info to the 9.0 release notes wiki page
>> > <https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0>.
>> >
>> > It would be a GREAT help if in the future all contributors fill out the
>> PR
>> > description with a little bit of info. Most PRs had nothing or very
>> little,
>> > which meant I was going by title or looking at code which was hard.
>> >
>> > Now for features, now we need to prioritize the features by importance.
>> Who
>> > can do that?
>> >
>> > And for bug fixes... shall we take a run through the lists again and
>> pull
>> > out important bug fixes? Or does anyone have another idea?
>> >
>> > -adam
>> >
>> >
>> > On Tue, Apr 7, 2020 at 4:30 PM Abdelatif Guettouche <
>> > abdelatif.guettouche@gmail.com> wrote:
>> >
>> > > I skimmed my range of PRs and created a draft PR[1] where I updated
>> the
>> > > ReleaseNote document. I basically went through all the PRs and
>> selected
>> > > only those with significant changes. This is also a work in
>> progress, I'll
>> > > wait for Nathan to sort his notes in the wiki before I move mine
>> there.
>> > >
>> > > To go back to the release notes discussion and where they should be,
>> if we
>> > > keep only the latest release notes in the top level ReleaseNote file
>> they
>> > > will never be decoupled from the release. Brennan's script can also be
>> > > updated to fetch them out.
>> > > The current ReleaseNote file has 26620 lines, it's hard to focus
>> there.
>> > >
>> > > On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <
>> hartman.nathan@gmail.com>
>> > > wrote:
>> > >
>> > > > On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io> wrote:
>> > > > > Ok, so let's split up the PRs with the three people we have now,
>> > > > Abdelatif,
>> > > > > Nathan, and me. As new people join, we can give them ranges to
>> look at.
>> > > > >
>> > > > > Let's do features first:
>> > > > >
>> > > > > - Abdelatif: PRs: 1-232
>> > > > > - Nathan: PRs: 233-465
>> > > > > - Adam: PRs: 466-697
>> > > > >
>> > > > > Read the PRs, take notes as a bulleted list, and add to the wiki
>> here
>> > > > under
>> > > > > 2b Features:
>> > > > >
>> > > > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
>> > > >
>> > > > I added a very INITIAL list of PRs from 233 to 465 that I think are
>> > > > new features. This is a WORK IN PROGRESS! It's by no means finished
>> > > > text and will obviouslyneed a lot of refinement. At this point, I'll
>> > > > need to study each of those PRs in more detail to decide how the
>> > > > description should be worded and whether they should be moved to
>> other
>> > > > sections. But for now, my work-in-progress is there...
>> > > >
>> > > > Cheers,
>> > > > Nathan
>> > > >
>> > >
>> >
>> >
>> > --
>> > Adam Feuer <ad...@starcat.io>
>>
>
>
> --
> Adam Feuer <ad...@starcat.io>
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
I think putting them in some kind of order is helpful, to give them
meaning... that's helpful for users. I would rather not look through a
20-point list to have to pick out the important things... I want someone
else to do that for me, or at least try. :)
-adam
On Thu, Apr 9, 2020 at 12:29 PM Abdelatif Guettouche <
abdelatif.guettouche@gmail.com> wrote:
> > It would be a GREAT help if in the future all contributors fill out the
> PR
> > description with a little bit of info. Most PRs had nothing or very
> little,
> > which meant I was going by title or looking at code which was hard.
> I had the exact same experience, having to go through the code to
> determine what the PR was actually about was no fun. Maybe it's time
> to put in a PR_TEMPLATE.
>
> > Now for features, now we need to prioritize the features by importance.
> Who
> > can do that?
> Why do we want to prioritize them?
> I guess we can just pick them as they arrived.
>
>
> On Thu, Apr 9, 2020 at 8:05 PM Adam Feuer <ad...@starcat.io> wrote:
> >
> > I did PRs 466-761. Lots of bugfixes, not many true added features. I
> added
> > the feature info to the 9.0 release notes wiki page
> > <https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0>.
> >
> > It would be a GREAT help if in the future all contributors fill out the
> PR
> > description with a little bit of info. Most PRs had nothing or very
> little,
> > which meant I was going by title or looking at code which was hard.
> >
> > Now for features, now we need to prioritize the features by importance.
> Who
> > can do that?
> >
> > And for bug fixes... shall we take a run through the lists again and pull
> > out important bug fixes? Or does anyone have another idea?
> >
> > -adam
> >
> >
> > On Tue, Apr 7, 2020 at 4:30 PM Abdelatif Guettouche <
> > abdelatif.guettouche@gmail.com> wrote:
> >
> > > I skimmed my range of PRs and created a draft PR[1] where I updated the
> > > ReleaseNote document. I basically went through all the PRs and selected
> > > only those with significant changes. This is also a work in progress,
> I'll
> > > wait for Nathan to sort his notes in the wiki before I move mine there.
> > >
> > > To go back to the release notes discussion and where they should be,
> if we
> > > keep only the latest release notes in the top level ReleaseNote file
> they
> > > will never be decoupled from the release. Brennan's script can also be
> > > updated to fetch them out.
> > > The current ReleaseNote file has 26620 lines, it's hard to focus there.
> > >
> > > On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <
> hartman.nathan@gmail.com>
> > > wrote:
> > >
> > > > On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io> wrote:
> > > > > Ok, so let's split up the PRs with the three people we have now,
> > > > Abdelatif,
> > > > > Nathan, and me. As new people join, we can give them ranges to
> look at.
> > > > >
> > > > > Let's do features first:
> > > > >
> > > > > - Abdelatif: PRs: 1-232
> > > > > - Nathan: PRs: 233-465
> > > > > - Adam: PRs: 466-697
> > > > >
> > > > > Read the PRs, take notes as a bulleted list, and add to the wiki
> here
> > > > under
> > > > > 2b Features:
> > > > >
> > > > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> > > >
> > > > I added a very INITIAL list of PRs from 233 to 465 that I think are
> > > > new features. This is a WORK IN PROGRESS! It's by no means finished
> > > > text and will obviouslyneed a lot of refinement. At this point, I'll
> > > > need to study each of those PRs in more detail to decide how the
> > > > description should be worded and whether they should be moved to
> other
> > > > sections. But for now, my work-in-progress is there...
> > > >
> > > > Cheers,
> > > > Nathan
> > > >
> > >
> >
> >
> > --
> > Adam Feuer <ad...@starcat.io>
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
> It would be a GREAT help if in the future all contributors fill out the PR
> description with a little bit of info. Most PRs had nothing or very little,
> which meant I was going by title or looking at code which was hard.
I had the exact same experience, having to go through the code to
determine what the PR was actually about was no fun. Maybe it's time
to put in a PR_TEMPLATE.
> Now for features, now we need to prioritize the features by importance. Who
> can do that?
Why do we want to prioritize them?
I guess we can just pick them as they arrived.
On Thu, Apr 9, 2020 at 8:05 PM Adam Feuer <ad...@starcat.io> wrote:
>
> I did PRs 466-761. Lots of bugfixes, not many true added features. I added
> the feature info to the 9.0 release notes wiki page
> <https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0>.
>
> It would be a GREAT help if in the future all contributors fill out the PR
> description with a little bit of info. Most PRs had nothing or very little,
> which meant I was going by title or looking at code which was hard.
>
> Now for features, now we need to prioritize the features by importance. Who
> can do that?
>
> And for bug fixes... shall we take a run through the lists again and pull
> out important bug fixes? Or does anyone have another idea?
>
> -adam
>
>
> On Tue, Apr 7, 2020 at 4:30 PM Abdelatif Guettouche <
> abdelatif.guettouche@gmail.com> wrote:
>
> > I skimmed my range of PRs and created a draft PR[1] where I updated the
> > ReleaseNote document. I basically went through all the PRs and selected
> > only those with significant changes. This is also a work in progress, I'll
> > wait for Nathan to sort his notes in the wiki before I move mine there.
> >
> > To go back to the release notes discussion and where they should be, if we
> > keep only the latest release notes in the top level ReleaseNote file they
> > will never be decoupled from the release. Brennan's script can also be
> > updated to fetch them out.
> > The current ReleaseNote file has 26620 lines, it's hard to focus there.
> >
> > On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <ha...@gmail.com>
> > wrote:
> >
> > > On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io> wrote:
> > > > Ok, so let's split up the PRs with the three people we have now,
> > > Abdelatif,
> > > > Nathan, and me. As new people join, we can give them ranges to look at.
> > > >
> > > > Let's do features first:
> > > >
> > > > - Abdelatif: PRs: 1-232
> > > > - Nathan: PRs: 233-465
> > > > - Adam: PRs: 466-697
> > > >
> > > > Read the PRs, take notes as a bulleted list, and add to the wiki here
> > > under
> > > > 2b Features:
> > > >
> > > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> > >
> > > I added a very INITIAL list of PRs from 233 to 465 that I think are
> > > new features. This is a WORK IN PROGRESS! It's by no means finished
> > > text and will obviouslyneed a lot of refinement. At this point, I'll
> > > need to study each of those PRs in more detail to decide how the
> > > description should be worded and whether they should be moved to other
> > > sections. But for now, my work-in-progress is there...
> > >
> > > Cheers,
> > > Nathan
> > >
> >
>
>
> --
> Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
I did PRs 466-761. Lots of bugfixes, not many true added features. I added
the feature info to the 9.0 release notes wiki page
<https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0>.
It would be a GREAT help if in the future all contributors fill out the PR
description with a little bit of info. Most PRs had nothing or very little,
which meant I was going by title or looking at code which was hard.
Now for features, now we need to prioritize the features by importance. Who
can do that?
And for bug fixes... shall we take a run through the lists again and pull
out important bug fixes? Or does anyone have another idea?
-adam
On Tue, Apr 7, 2020 at 4:30 PM Abdelatif Guettouche <
abdelatif.guettouche@gmail.com> wrote:
> I skimmed my range of PRs and created a draft PR[1] where I updated the
> ReleaseNote document. I basically went through all the PRs and selected
> only those with significant changes. This is also a work in progress, I'll
> wait for Nathan to sort his notes in the wiki before I move mine there.
>
> To go back to the release notes discussion and where they should be, if we
> keep only the latest release notes in the top level ReleaseNote file they
> will never be decoupled from the release. Brennan's script can also be
> updated to fetch them out.
> The current ReleaseNote file has 26620 lines, it's hard to focus there.
>
> On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <ha...@gmail.com>
> wrote:
>
> > On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io> wrote:
> > > Ok, so let's split up the PRs with the three people we have now,
> > Abdelatif,
> > > Nathan, and me. As new people join, we can give them ranges to look at.
> > >
> > > Let's do features first:
> > >
> > > - Abdelatif: PRs: 1-232
> > > - Nathan: PRs: 233-465
> > > - Adam: PRs: 466-697
> > >
> > > Read the PRs, take notes as a bulleted list, and add to the wiki here
> > under
> > > 2b Features:
> > >
> > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> >
> > I added a very INITIAL list of PRs from 233 to 465 that I think are
> > new features. This is a WORK IN PROGRESS! It's by no means finished
> > text and will obviouslyneed a lot of refinement. At this point, I'll
> > need to study each of those PRs in more detail to decide how the
> > description should be worded and whether they should be moved to other
> > sections. But for now, my work-in-progress is there...
> >
> > Cheers,
> > Nathan
> >
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
I skimmed my range of PRs and created a draft PR[1] where I updated the
ReleaseNote document. I basically went through all the PRs and selected
only those with significant changes. This is also a work in progress, I'll
wait for Nathan to sort his notes in the wiki before I move mine there.
To go back to the release notes discussion and where they should be, if we
keep only the latest release notes in the top level ReleaseNote file they
will never be decoupled from the release. Brennan's script can also be
updated to fetch them out.
The current ReleaseNote file has 26620 lines, it's hard to focus there.
On Fri, Apr 3, 2020 at 9:20 PM Nathan Hartman <ha...@gmail.com>
wrote:
> On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io> wrote:
> > Ok, so let's split up the PRs with the three people we have now,
> Abdelatif,
> > Nathan, and me. As new people join, we can give them ranges to look at.
> >
> > Let's do features first:
> >
> > - Abdelatif: PRs: 1-232
> > - Nathan: PRs: 233-465
> > - Adam: PRs: 466-697
> >
> > Read the PRs, take notes as a bulleted list, and add to the wiki here
> under
> > 2b Features:
> >
> > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
>
> I added a very INITIAL list of PRs from 233 to 465 that I think are
> new features. This is a WORK IN PROGRESS! It's by no means finished
> text and will obviouslyneed a lot of refinement. At this point, I'll
> need to study each of those PRs in more detail to decide how the
> description should be worded and whether they should be moved to other
> sections. But for now, my work-in-progress is there...
>
> Cheers,
> Nathan
>
Re: [DISCUSS] Release Notes
Posted by Nathan Hartman <ha...@gmail.com>.
On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io> wrote:
> Ok, so let's split up the PRs with the three people we have now, Abdelatif,
> Nathan, and me. As new people join, we can give them ranges to look at.
>
> Let's do features first:
>
> - Abdelatif: PRs: 1-232
> - Nathan: PRs: 233-465
> - Adam: PRs: 466-697
>
> Read the PRs, take notes as a bulleted list, and add to the wiki here under
> 2b Features:
>
> https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
I added a very INITIAL list of PRs from 233 to 465 that I think are
new features. This is a WORK IN PROGRESS! It's by no means finished
text and will obviouslyneed a lot of refinement. At this point, I'll
need to study each of those PRs in more detail to decide how the
description should be worded and whether they should be moved to other
sections. But for now, my work-in-progress is there...
Cheers,
Nathan
Re: [DISCUSS] Release Notes
Posted by Nathan Hartman <ha...@gmail.com>.
On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer <ad...@starcat.io> wrote:
> Ok, so let's split up the PRs with the three people we have now, Abdelatif,
> Nathan, and me. As new people join, we can give them ranges to look at.
>
> Let's do features first:
>
> - Abdelatif: PRs: 1-232
> - Nathan: PRs: 233-465
> - Adam: PRs: 466-697
>
ok i'll do 233-465...
Cheers,
Nathan
Re: [DISCUSS] Release Notes
Posted by Alan Carvalho de Assis <ac...@gmail.com>.
Hi Adam,
It's done, I listed the important bug fixes.
Is there anything else missing to finish the ReleaseNotes?
BR,
Alan
On 4/9/20, Adam Feuer <ad...@starcat.io> wrote:
> Alan,
>
> Thank you! We just need bugfixes now, Abdelatif, Nathan, and I did all the
> features. I think Abdelatif did bugfixes too.
>
> So just go through and summarize bugfixes, probably only ones that rise to
> the level of needing to be in the release notes.
>
> -adam
>
> On Thu, Apr 9, 2020 at 5:14 PM Alan Carvalho de Assis <ac...@gmail.com>
> wrote:
>
>> I want to help:
>>
>> - Abdelatif: PRs: 1-232
>> - Nathan: PRs: 233-465
>> - Adam: PRs: 466-697
>> - Alan : PRs: 697-928
>>
>> BR,
>>
>> Alan
>>
>> On 4/2/20, Adam Feuer <ad...@starcat.io> wrote:
>> > Ok, so let's split up the PRs with the three people we have now,
>> Abdelatif,
>> > Nathan, and me. As new people join, we can give them ranges to look at.
>> >
>> > Let's do features first:
>> >
>> > - Abdelatif: PRs: 1-232
>> > - Nathan: PRs: 233-465
>> > - Adam: PRs: 466-697
>> >
>> > Read the PRs, take notes as a bulleted list, and add to the wiki here
>> under
>> > 2b Features:
>> >
>> > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
>> >
>> > Greg noted that we need to also look at commits from Bitbucket, they
>> > will
>> > be in the git log on the main repo. We can do that next. Then we'll do
>> > bugfixes. Then we'll prioritize and edit.
>> >
>> > We could use help! If you have some time to help, respond to this
>> > email,
>> > and we'll give you a range or PRs or commits to summarize.
>> >
>> > -adam
>> >
>> > On Thu, Apr 2, 2020 at 2:32 PM Abdelatif Guettouche <
>> > abdelatif.guettouche@gmail.com> wrote:
>> >
>> >> At the time of writing we've got 1124 commits since nuttx-8.2 for
>> >> nuttx/ and 230 for apps/. I'm expecting to see a lot of style fixes
>> >> but also a lot of features and bug fixes.
>> >>
>> >> > We need a few more volunteers.
>> >>
>> >> I can get some done, whether it's features or bug fixes.
>> >>
>> >>
>> >> On Thu, Apr 2, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
>> >> >
>> >> > I can't download all the PR descriptions due to rate limiting. Back
>> >> > to
>> >> the
>> >> > plan suggested by Nathan. We need a few more volunteers.
>> >> >
>> >> > -adam
>> >> >
>> >> > On Thu, Apr 2, 2020 at 11:55 AM Adam Feuer <ad...@starcat.io> wrote:
>> >> >
>> >> > > I have an improvement to the process. I just made a scrapy
>> >> > > <https://scrapy.org/> script that can download the PR title and
>> >> > > description from Github. (Yeah that should be accessible via the
>> >> Github API
>> >> > > but I couldn't figure out how.)
>> >> > >
>> >> > > So I can make a spreadsheet or an HTML doc that has all the PR
>> >> > > descriptions in it. Seems like this would be faster to than
>> >> > > clicking
>> >> > > on
>> >> > > them but I don't know. I'll give that a shot and post it here.
>> >> > >
>> >> > > -adam
>> >> > >
>> >> > > On Thu, Apr 2, 2020 at 11:35 AM Nathan Hartman <
>> >> hartman.nathan@gmail.com>
>> >> > > wrote:
>> >> > >
>> >> > >> On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io>
>> >> > >> wrote:
>> >> > >> >
>> >> > >> > Bumping this up. It seems like we need a plan to tackle going
>> >> through
>> >> > >> the
>> >> > >> > 613 closed PRs and summarizing (only merged ones need to be
>> >> summarized).
>> >> > >> > This would be easier with a team of people... anyone want to
>> help?
>> >> > >> >
>> >> > >> > One way we could do this is one group take bug fixes, and
>> >> > >> > another
>> >> take
>> >> > >> > features, and then make a list for each. Then we put them
>> together
>> >> in a
>> >> > >> > document.
>> >> > >>
>> >> > >> So that we don't duplicate work, I think we should also stick to
>> >> > >> a
>> >> range
>> >> > >> of
>> >> > >> PRs.
>> >> > >>
>> >> > >> For example I could go through PRs 1 through 200 looking for new
>> >> features
>> >> > >> -- architectures, drivers, boards, etc -- but *not* bug fixes per
>> >> Adam's
>> >> > >> suggestion and make a list of those. Another volunteer could look
>> at
>> >> PRs
>> >> > >> 201 through 400, etc.
>> >> > >>
>> >> > >> So we need 3 volunteers to look for features, I'm 1 so we need 2
>> >> > >> more.
>> >> > >>
>> >> > >> And we need the same thing for bug fixes, 3 volunteers.
>> >> > >>
>> >> > >> Any takers?
>> >> > >>
>> >> > >> Nathan
>> >> > >>
>> >> > >
>> >> > >
>> >> > > --
>> >> > > Adam Feuer <ad...@starcat.io>
>> >> > >
>> >> >
>> >> >
>> >> > --
>> >> > Adam Feuer <ad...@starcat.io>
>> >>
>> >
>> >
>> > --
>> > Adam Feuer <ad...@starcat.io>
>> >
>>
>
>
> --
> Adam Feuer <ad...@starcat.io>
>
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
> - Abdelatif: PRs: 1-232
> - Nathan: PRs: 233-465
> - Adam: PRs: 466-697
> - Alan : PRs: 697-928
The PRs are now at #757.
There are apps/ with 168 PRs if you'd like to take a look there.
I guess it's better if everyone sticks to his range and does
everything (new features, improvements, bugfixes)
On Fri, Apr 10, 2020 at 1:18 AM Adam Feuer <ad...@starcat.io> wrote:
>
> Alan,
>
> Thank you! We just need bugfixes now, Abdelatif, Nathan, and I did all the
> features. I think Abdelatif did bugfixes too.
>
> So just go through and summarize bugfixes, probably only ones that rise to
> the level of needing to be in the release notes.
>
> -adam
>
> On Thu, Apr 9, 2020 at 5:14 PM Alan Carvalho de Assis <ac...@gmail.com>
> wrote:
>
> > I want to help:
> >
> > - Abdelatif: PRs: 1-232
> > - Nathan: PRs: 233-465
> > - Adam: PRs: 466-697
> > - Alan : PRs: 697-928
> >
> > BR,
> >
> > Alan
> >
> > On 4/2/20, Adam Feuer <ad...@starcat.io> wrote:
> > > Ok, so let's split up the PRs with the three people we have now,
> > Abdelatif,
> > > Nathan, and me. As new people join, we can give them ranges to look at.
> > >
> > > Let's do features first:
> > >
> > > - Abdelatif: PRs: 1-232
> > > - Nathan: PRs: 233-465
> > > - Adam: PRs: 466-697
> > >
> > > Read the PRs, take notes as a bulleted list, and add to the wiki here
> > under
> > > 2b Features:
> > >
> > > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> > >
> > > Greg noted that we need to also look at commits from Bitbucket, they will
> > > be in the git log on the main repo. We can do that next. Then we'll do
> > > bugfixes. Then we'll prioritize and edit.
> > >
> > > We could use help! If you have some time to help, respond to this email,
> > > and we'll give you a range or PRs or commits to summarize.
> > >
> > > -adam
> > >
> > > On Thu, Apr 2, 2020 at 2:32 PM Abdelatif Guettouche <
> > > abdelatif.guettouche@gmail.com> wrote:
> > >
> > >> At the time of writing we've got 1124 commits since nuttx-8.2 for
> > >> nuttx/ and 230 for apps/. I'm expecting to see a lot of style fixes
> > >> but also a lot of features and bug fixes.
> > >>
> > >> > We need a few more volunteers.
> > >>
> > >> I can get some done, whether it's features or bug fixes.
> > >>
> > >>
> > >> On Thu, Apr 2, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
> > >> >
> > >> > I can't download all the PR descriptions due to rate limiting. Back to
> > >> the
> > >> > plan suggested by Nathan. We need a few more volunteers.
> > >> >
> > >> > -adam
> > >> >
> > >> > On Thu, Apr 2, 2020 at 11:55 AM Adam Feuer <ad...@starcat.io> wrote:
> > >> >
> > >> > > I have an improvement to the process. I just made a scrapy
> > >> > > <https://scrapy.org/> script that can download the PR title and
> > >> > > description from Github. (Yeah that should be accessible via the
> > >> Github API
> > >> > > but I couldn't figure out how.)
> > >> > >
> > >> > > So I can make a spreadsheet or an HTML doc that has all the PR
> > >> > > descriptions in it. Seems like this would be faster to than clicking
> > >> > > on
> > >> > > them but I don't know. I'll give that a shot and post it here.
> > >> > >
> > >> > > -adam
> > >> > >
> > >> > > On Thu, Apr 2, 2020 at 11:35 AM Nathan Hartman <
> > >> hartman.nathan@gmail.com>
> > >> > > wrote:
> > >> > >
> > >> > >> On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io> wrote:
> > >> > >> >
> > >> > >> > Bumping this up. It seems like we need a plan to tackle going
> > >> through
> > >> > >> the
> > >> > >> > 613 closed PRs and summarizing (only merged ones need to be
> > >> summarized).
> > >> > >> > This would be easier with a team of people... anyone want to
> > help?
> > >> > >> >
> > >> > >> > One way we could do this is one group take bug fixes, and another
> > >> take
> > >> > >> > features, and then make a list for each. Then we put them
> > together
> > >> in a
> > >> > >> > document.
> > >> > >>
> > >> > >> So that we don't duplicate work, I think we should also stick to a
> > >> range
> > >> > >> of
> > >> > >> PRs.
> > >> > >>
> > >> > >> For example I could go through PRs 1 through 200 looking for new
> > >> features
> > >> > >> -- architectures, drivers, boards, etc -- but *not* bug fixes per
> > >> Adam's
> > >> > >> suggestion and make a list of those. Another volunteer could look
> > at
> > >> PRs
> > >> > >> 201 through 400, etc.
> > >> > >>
> > >> > >> So we need 3 volunteers to look for features, I'm 1 so we need 2
> > >> > >> more.
> > >> > >>
> > >> > >> And we need the same thing for bug fixes, 3 volunteers.
> > >> > >>
> > >> > >> Any takers?
> > >> > >>
> > >> > >> Nathan
> > >> > >>
> > >> > >
> > >> > >
> > >> > > --
> > >> > > Adam Feuer <ad...@starcat.io>
> > >> > >
> > >> >
> > >> >
> > >> > --
> > >> > Adam Feuer <ad...@starcat.io>
> > >>
> > >
> > >
> > > --
> > > Adam Feuer <ad...@starcat.io>
> > >
> >
>
>
> --
> Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
Alan,
Thank you! We just need bugfixes now, Abdelatif, Nathan, and I did all the
features. I think Abdelatif did bugfixes too.
So just go through and summarize bugfixes, probably only ones that rise to
the level of needing to be in the release notes.
-adam
On Thu, Apr 9, 2020 at 5:14 PM Alan Carvalho de Assis <ac...@gmail.com>
wrote:
> I want to help:
>
> - Abdelatif: PRs: 1-232
> - Nathan: PRs: 233-465
> - Adam: PRs: 466-697
> - Alan : PRs: 697-928
>
> BR,
>
> Alan
>
> On 4/2/20, Adam Feuer <ad...@starcat.io> wrote:
> > Ok, so let's split up the PRs with the three people we have now,
> Abdelatif,
> > Nathan, and me. As new people join, we can give them ranges to look at.
> >
> > Let's do features first:
> >
> > - Abdelatif: PRs: 1-232
> > - Nathan: PRs: 233-465
> > - Adam: PRs: 466-697
> >
> > Read the PRs, take notes as a bulleted list, and add to the wiki here
> under
> > 2b Features:
> >
> > https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
> >
> > Greg noted that we need to also look at commits from Bitbucket, they will
> > be in the git log on the main repo. We can do that next. Then we'll do
> > bugfixes. Then we'll prioritize and edit.
> >
> > We could use help! If you have some time to help, respond to this email,
> > and we'll give you a range or PRs or commits to summarize.
> >
> > -adam
> >
> > On Thu, Apr 2, 2020 at 2:32 PM Abdelatif Guettouche <
> > abdelatif.guettouche@gmail.com> wrote:
> >
> >> At the time of writing we've got 1124 commits since nuttx-8.2 for
> >> nuttx/ and 230 for apps/. I'm expecting to see a lot of style fixes
> >> but also a lot of features and bug fixes.
> >>
> >> > We need a few more volunteers.
> >>
> >> I can get some done, whether it's features or bug fixes.
> >>
> >>
> >> On Thu, Apr 2, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
> >> >
> >> > I can't download all the PR descriptions due to rate limiting. Back to
> >> the
> >> > plan suggested by Nathan. We need a few more volunteers.
> >> >
> >> > -adam
> >> >
> >> > On Thu, Apr 2, 2020 at 11:55 AM Adam Feuer <ad...@starcat.io> wrote:
> >> >
> >> > > I have an improvement to the process. I just made a scrapy
> >> > > <https://scrapy.org/> script that can download the PR title and
> >> > > description from Github. (Yeah that should be accessible via the
> >> Github API
> >> > > but I couldn't figure out how.)
> >> > >
> >> > > So I can make a spreadsheet or an HTML doc that has all the PR
> >> > > descriptions in it. Seems like this would be faster to than clicking
> >> > > on
> >> > > them but I don't know. I'll give that a shot and post it here.
> >> > >
> >> > > -adam
> >> > >
> >> > > On Thu, Apr 2, 2020 at 11:35 AM Nathan Hartman <
> >> hartman.nathan@gmail.com>
> >> > > wrote:
> >> > >
> >> > >> On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io> wrote:
> >> > >> >
> >> > >> > Bumping this up. It seems like we need a plan to tackle going
> >> through
> >> > >> the
> >> > >> > 613 closed PRs and summarizing (only merged ones need to be
> >> summarized).
> >> > >> > This would be easier with a team of people... anyone want to
> help?
> >> > >> >
> >> > >> > One way we could do this is one group take bug fixes, and another
> >> take
> >> > >> > features, and then make a list for each. Then we put them
> together
> >> in a
> >> > >> > document.
> >> > >>
> >> > >> So that we don't duplicate work, I think we should also stick to a
> >> range
> >> > >> of
> >> > >> PRs.
> >> > >>
> >> > >> For example I could go through PRs 1 through 200 looking for new
> >> features
> >> > >> -- architectures, drivers, boards, etc -- but *not* bug fixes per
> >> Adam's
> >> > >> suggestion and make a list of those. Another volunteer could look
> at
> >> PRs
> >> > >> 201 through 400, etc.
> >> > >>
> >> > >> So we need 3 volunteers to look for features, I'm 1 so we need 2
> >> > >> more.
> >> > >>
> >> > >> And we need the same thing for bug fixes, 3 volunteers.
> >> > >>
> >> > >> Any takers?
> >> > >>
> >> > >> Nathan
> >> > >>
> >> > >
> >> > >
> >> > > --
> >> > > Adam Feuer <ad...@starcat.io>
> >> > >
> >> >
> >> >
> >> > --
> >> > Adam Feuer <ad...@starcat.io>
> >>
> >
> >
> > --
> > Adam Feuer <ad...@starcat.io>
> >
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Alan Carvalho de Assis <ac...@gmail.com>.
I want to help:
- Abdelatif: PRs: 1-232
- Nathan: PRs: 233-465
- Adam: PRs: 466-697
- Alan : PRs: 697-928
BR,
Alan
On 4/2/20, Adam Feuer <ad...@starcat.io> wrote:
> Ok, so let's split up the PRs with the three people we have now, Abdelatif,
> Nathan, and me. As new people join, we can give them ranges to look at.
>
> Let's do features first:
>
> - Abdelatif: PRs: 1-232
> - Nathan: PRs: 233-465
> - Adam: PRs: 466-697
>
> Read the PRs, take notes as a bulleted list, and add to the wiki here under
> 2b Features:
>
> https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
>
> Greg noted that we need to also look at commits from Bitbucket, they will
> be in the git log on the main repo. We can do that next. Then we'll do
> bugfixes. Then we'll prioritize and edit.
>
> We could use help! If you have some time to help, respond to this email,
> and we'll give you a range or PRs or commits to summarize.
>
> -adam
>
> On Thu, Apr 2, 2020 at 2:32 PM Abdelatif Guettouche <
> abdelatif.guettouche@gmail.com> wrote:
>
>> At the time of writing we've got 1124 commits since nuttx-8.2 for
>> nuttx/ and 230 for apps/. I'm expecting to see a lot of style fixes
>> but also a lot of features and bug fixes.
>>
>> > We need a few more volunteers.
>>
>> I can get some done, whether it's features or bug fixes.
>>
>>
>> On Thu, Apr 2, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
>> >
>> > I can't download all the PR descriptions due to rate limiting. Back to
>> the
>> > plan suggested by Nathan. We need a few more volunteers.
>> >
>> > -adam
>> >
>> > On Thu, Apr 2, 2020 at 11:55 AM Adam Feuer <ad...@starcat.io> wrote:
>> >
>> > > I have an improvement to the process. I just made a scrapy
>> > > <https://scrapy.org/> script that can download the PR title and
>> > > description from Github. (Yeah that should be accessible via the
>> Github API
>> > > but I couldn't figure out how.)
>> > >
>> > > So I can make a spreadsheet or an HTML doc that has all the PR
>> > > descriptions in it. Seems like this would be faster to than clicking
>> > > on
>> > > them but I don't know. I'll give that a shot and post it here.
>> > >
>> > > -adam
>> > >
>> > > On Thu, Apr 2, 2020 at 11:35 AM Nathan Hartman <
>> hartman.nathan@gmail.com>
>> > > wrote:
>> > >
>> > >> On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io> wrote:
>> > >> >
>> > >> > Bumping this up. It seems like we need a plan to tackle going
>> through
>> > >> the
>> > >> > 613 closed PRs and summarizing (only merged ones need to be
>> summarized).
>> > >> > This would be easier with a team of people... anyone want to help?
>> > >> >
>> > >> > One way we could do this is one group take bug fixes, and another
>> take
>> > >> > features, and then make a list for each. Then we put them together
>> in a
>> > >> > document.
>> > >>
>> > >> So that we don't duplicate work, I think we should also stick to a
>> range
>> > >> of
>> > >> PRs.
>> > >>
>> > >> For example I could go through PRs 1 through 200 looking for new
>> features
>> > >> -- architectures, drivers, boards, etc -- but *not* bug fixes per
>> Adam's
>> > >> suggestion and make a list of those. Another volunteer could look at
>> PRs
>> > >> 201 through 400, etc.
>> > >>
>> > >> So we need 3 volunteers to look for features, I'm 1 so we need 2
>> > >> more.
>> > >>
>> > >> And we need the same thing for bug fixes, 3 volunteers.
>> > >>
>> > >> Any takers?
>> > >>
>> > >> Nathan
>> > >>
>> > >
>> > >
>> > > --
>> > > Adam Feuer <ad...@starcat.io>
>> > >
>> >
>> >
>> > --
>> > Adam Feuer <ad...@starcat.io>
>>
>
>
> --
> Adam Feuer <ad...@starcat.io>
>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
Ok, so let's split up the PRs with the three people we have now, Abdelatif,
Nathan, and me. As new people join, we can give them ranges to look at.
Let's do features first:
- Abdelatif: PRs: 1-232
- Nathan: PRs: 233-465
- Adam: PRs: 466-697
Read the PRs, take notes as a bulleted list, and add to the wiki here under
2b Features:
https://cwiki.apache.org/confluence/display/NUTTX/NuttX+9.0
Greg noted that we need to also look at commits from Bitbucket, they will
be in the git log on the main repo. We can do that next. Then we'll do
bugfixes. Then we'll prioritize and edit.
We could use help! If you have some time to help, respond to this email,
and we'll give you a range or PRs or commits to summarize.
-adam
On Thu, Apr 2, 2020 at 2:32 PM Abdelatif Guettouche <
abdelatif.guettouche@gmail.com> wrote:
> At the time of writing we've got 1124 commits since nuttx-8.2 for
> nuttx/ and 230 for apps/. I'm expecting to see a lot of style fixes
> but also a lot of features and bug fixes.
>
> > We need a few more volunteers.
>
> I can get some done, whether it's features or bug fixes.
>
>
> On Thu, Apr 2, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
> >
> > I can't download all the PR descriptions due to rate limiting. Back to
> the
> > plan suggested by Nathan. We need a few more volunteers.
> >
> > -adam
> >
> > On Thu, Apr 2, 2020 at 11:55 AM Adam Feuer <ad...@starcat.io> wrote:
> >
> > > I have an improvement to the process. I just made a scrapy
> > > <https://scrapy.org/> script that can download the PR title and
> > > description from Github. (Yeah that should be accessible via the
> Github API
> > > but I couldn't figure out how.)
> > >
> > > So I can make a spreadsheet or an HTML doc that has all the PR
> > > descriptions in it. Seems like this would be faster to than clicking on
> > > them but I don't know. I'll give that a shot and post it here.
> > >
> > > -adam
> > >
> > > On Thu, Apr 2, 2020 at 11:35 AM Nathan Hartman <
> hartman.nathan@gmail.com>
> > > wrote:
> > >
> > >> On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io> wrote:
> > >> >
> > >> > Bumping this up. It seems like we need a plan to tackle going
> through
> > >> the
> > >> > 613 closed PRs and summarizing (only merged ones need to be
> summarized).
> > >> > This would be easier with a team of people... anyone want to help?
> > >> >
> > >> > One way we could do this is one group take bug fixes, and another
> take
> > >> > features, and then make a list for each. Then we put them together
> in a
> > >> > document.
> > >>
> > >> So that we don't duplicate work, I think we should also stick to a
> range
> > >> of
> > >> PRs.
> > >>
> > >> For example I could go through PRs 1 through 200 looking for new
> features
> > >> -- architectures, drivers, boards, etc -- but *not* bug fixes per
> Adam's
> > >> suggestion and make a list of those. Another volunteer could look at
> PRs
> > >> 201 through 400, etc.
> > >>
> > >> So we need 3 volunteers to look for features, I'm 1 so we need 2 more.
> > >>
> > >> And we need the same thing for bug fixes, 3 volunteers.
> > >>
> > >> Any takers?
> > >>
> > >> Nathan
> > >>
> > >
> > >
> > > --
> > > Adam Feuer <ad...@starcat.io>
> > >
> >
> >
> > --
> > Adam Feuer <ad...@starcat.io>
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
At the time of writing we've got 1124 commits since nuttx-8.2 for
nuttx/ and 230 for apps/. I'm expecting to see a lot of style fixes
but also a lot of features and bug fixes.
> We need a few more volunteers.
I can get some done, whether it's features or bug fixes.
On Thu, Apr 2, 2020 at 10:11 PM Adam Feuer <ad...@starcat.io> wrote:
>
> I can't download all the PR descriptions due to rate limiting. Back to the
> plan suggested by Nathan. We need a few more volunteers.
>
> -adam
>
> On Thu, Apr 2, 2020 at 11:55 AM Adam Feuer <ad...@starcat.io> wrote:
>
> > I have an improvement to the process. I just made a scrapy
> > <https://scrapy.org/> script that can download the PR title and
> > description from Github. (Yeah that should be accessible via the Github API
> > but I couldn't figure out how.)
> >
> > So I can make a spreadsheet or an HTML doc that has all the PR
> > descriptions in it. Seems like this would be faster to than clicking on
> > them but I don't know. I'll give that a shot and post it here.
> >
> > -adam
> >
> > On Thu, Apr 2, 2020 at 11:35 AM Nathan Hartman <ha...@gmail.com>
> > wrote:
> >
> >> On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io> wrote:
> >> >
> >> > Bumping this up. It seems like we need a plan to tackle going through
> >> the
> >> > 613 closed PRs and summarizing (only merged ones need to be summarized).
> >> > This would be easier with a team of people... anyone want to help?
> >> >
> >> > One way we could do this is one group take bug fixes, and another take
> >> > features, and then make a list for each. Then we put them together in a
> >> > document.
> >>
> >> So that we don't duplicate work, I think we should also stick to a range
> >> of
> >> PRs.
> >>
> >> For example I could go through PRs 1 through 200 looking for new features
> >> -- architectures, drivers, boards, etc -- but *not* bug fixes per Adam's
> >> suggestion and make a list of those. Another volunteer could look at PRs
> >> 201 through 400, etc.
> >>
> >> So we need 3 volunteers to look for features, I'm 1 so we need 2 more.
> >>
> >> And we need the same thing for bug fixes, 3 volunteers.
> >>
> >> Any takers?
> >>
> >> Nathan
> >>
> >
> >
> > --
> > Adam Feuer <ad...@starcat.io>
> >
>
>
> --
> Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
I can't download all the PR descriptions due to rate limiting. Back to the
plan suggested by Nathan. We need a few more volunteers.
-adam
On Thu, Apr 2, 2020 at 11:55 AM Adam Feuer <ad...@starcat.io> wrote:
> I have an improvement to the process. I just made a scrapy
> <https://scrapy.org/> script that can download the PR title and
> description from Github. (Yeah that should be accessible via the Github API
> but I couldn't figure out how.)
>
> So I can make a spreadsheet or an HTML doc that has all the PR
> descriptions in it. Seems like this would be faster to than clicking on
> them but I don't know. I'll give that a shot and post it here.
>
> -adam
>
> On Thu, Apr 2, 2020 at 11:35 AM Nathan Hartman <ha...@gmail.com>
> wrote:
>
>> On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io> wrote:
>> >
>> > Bumping this up. It seems like we need a plan to tackle going through
>> the
>> > 613 closed PRs and summarizing (only merged ones need to be summarized).
>> > This would be easier with a team of people... anyone want to help?
>> >
>> > One way we could do this is one group take bug fixes, and another take
>> > features, and then make a list for each. Then we put them together in a
>> > document.
>>
>> So that we don't duplicate work, I think we should also stick to a range
>> of
>> PRs.
>>
>> For example I could go through PRs 1 through 200 looking for new features
>> -- architectures, drivers, boards, etc -- but *not* bug fixes per Adam's
>> suggestion and make a list of those. Another volunteer could look at PRs
>> 201 through 400, etc.
>>
>> So we need 3 volunteers to look for features, I'm 1 so we need 2 more.
>>
>> And we need the same thing for bug fixes, 3 volunteers.
>>
>> Any takers?
>>
>> Nathan
>>
>
>
> --
> Adam Feuer <ad...@starcat.io>
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
I have an improvement to the process. I just made a scrapy
<https://scrapy.org/> script that can download the PR title and description
from Github. (Yeah that should be accessible via the Github API but I
couldn't figure out how.)
So I can make a spreadsheet or an HTML doc that has all the PR descriptions
in it. Seems like this would be faster to than clicking on them but I don't
know. I'll give that a shot and post it here.
-adam
On Thu, Apr 2, 2020 at 11:35 AM Nathan Hartman <ha...@gmail.com>
wrote:
> On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io> wrote:
> >
> > Bumping this up. It seems like we need a plan to tackle going through the
> > 613 closed PRs and summarizing (only merged ones need to be summarized).
> > This would be easier with a team of people... anyone want to help?
> >
> > One way we could do this is one group take bug fixes, and another take
> > features, and then make a list for each. Then we put them together in a
> > document.
>
> So that we don't duplicate work, I think we should also stick to a range of
> PRs.
>
> For example I could go through PRs 1 through 200 looking for new features
> -- architectures, drivers, boards, etc -- but *not* bug fixes per Adam's
> suggestion and make a list of those. Another volunteer could look at PRs
> 201 through 400, etc.
>
> So we need 3 volunteers to look for features, I'm 1 so we need 2 more.
>
> And we need the same thing for bug fixes, 3 volunteers.
>
> Any takers?
>
> Nathan
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Nathan Hartman <ha...@gmail.com>.
On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer <ad...@starcat.io> wrote:
>
> Bumping this up. It seems like we need a plan to tackle going through the
> 613 closed PRs and summarizing (only merged ones need to be summarized).
> This would be easier with a team of people... anyone want to help?
>
> One way we could do this is one group take bug fixes, and another take
> features, and then make a list for each. Then we put them together in a
> document.
So that we don't duplicate work, I think we should also stick to a range of
PRs.
For example I could go through PRs 1 through 200 looking for new features
-- architectures, drivers, boards, etc -- but *not* bug fixes per Adam's
suggestion and make a list of those. Another volunteer could look at PRs
201 through 400, etc.
So we need 3 volunteers to look for features, I'm 1 so we need 2 more.
And we need the same thing for bug fixes, 3 volunteers.
Any takers?
Nathan
Re: [DISCUSS] Release Notes
Posted by Gregory Nutt <sp...@gmail.com>.
On 4/2/2020 1:04 PM, Gregory Nutt wrote:
>
>> Bumping this up. It seems like we need a plan to tackle going through
>> the
>> 613 closed PRs and summarizing (only merged ones need to be summarized).
>> This would be easier with a team of people... anyone want to help?
>>
>> One way we could do this is one group take bug fixes, and another take
>> features, and then make a list for each. Then we put them together in a
>> document.
>
> The last release was in mid-November of 2019. NuttX didn't become a
> podling until mid-December of that year. So there are a month of
> changes in Bitbucket as well.
There were few PRs in the Bitbucket repo. 95% of the changes were via
path so we don't need to involve the Bitbucket repos. We can get that
range or information from the apache repo in all commits from the tag
nuttx-8.2
In the early days as a podling, however. We followed the same process
as on Bitbucket. Several patches were received and were merged into
incubator_nuttx repository master manually. There was no PR. Those
would also be missed if used only PRs.
Recently, we convert patches to PRs first and everything will be done in
the incubator_nuttx* repositories. So we should not have these problems
in the future.
Re: [DISCUSS] Release Notes
Posted by Gregory Nutt <sp...@gmail.com>.
> Bumping this up. It seems like we need a plan to tackle going through the
> 613 closed PRs and summarizing (only merged ones need to be summarized).
> This would be easier with a team of people... anyone want to help?
>
> One way we could do this is one group take bug fixes, and another take
> features, and then make a list for each. Then we put them together in a
> document.
The last release was in mid-November of 2019. NuttX didn't become a
podling until mid-December of that year. So there are a month of
changes in Bitbucket as well.
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
Bumping this up. It seems like we need a plan to tackle going through the
613 closed PRs and summarizing (only merged ones need to be summarized).
This would be easier with a team of people... anyone want to help?
One way we could do this is one group take bug fixes, and another take
features, and then make a list for each. Then we put them together in a
document.
-adam
On Mon, Mar 30, 2020 at 11:31 AM Adam Feuer <ad...@starcat.io> wrote:
> Here's a list of all closed PRs since 2019-11-16, the date of NuttX
> release 8.2:
>
>
> https://github.com/apache/incubator-nuttx/pulls?q=is%3Apr+is%3Aclosed+closed%3A%3E2019-11-16+
>
> There are 613 closed PRs. This might be motivation to get back to doing
> them every two months. :)
>
> -adam
>
> On Sun, Mar 29, 2020 at 2:07 PM Adam Feuer <ad...@starcat.io> wrote:
>
>> Nathan,
>>
>> A quick Google search yielded Reno – tooling for managing release notes.
>>
>> Reno docs:
>> https://docs.openstack.org/reno/latest/
>>
>> Reno source code:
>> https://github.com/openstack/reno
>>
>> It can use ReStructuredText (RST) and has Sphinx integration. Zephyr,
>> Rust, Clang, Python, and others also use RST and Sphinx.
>>
>> -adam
>>
>> On Sun, Mar 29, 2020 at 1:48 PM Nathan Hartman <ha...@gmail.com>
>> wrote:
>>
>>> On Sun, Mar 29, 2020 at 2:03 PM Gregory Nutt <sp...@gmail.com>
>>> wrote:
>>> > The organization of the release notes is fine, it is just making the
>>> > level of effort needed to produce them manageable. This begs for some
>>> > kind of tooling.
>>>
>>> I wonder if there is some Free/Open Source tooling that already exists
>>> (preferably something with a community and user base that already
>>> exists around it) that we could adopt for this purpose.
>>>
>>> Can anyone recommend such a tool?
>>>
>>> Nathan
>>>
>>
>>
>> --
>> Adam Feuer <ad...@starcat.io>
>>
>
>
> --
> Adam Feuer <ad...@starcat.io>
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
Here's a list of all closed PRs since 2019-11-16, the date of NuttX release
8.2:
https://github.com/apache/incubator-nuttx/pulls?q=is%3Apr+is%3Aclosed+closed%3A%3E2019-11-16+
There are 613 closed PRs. This might be motivation to get back to doing
them every two months. :)
-adam
On Sun, Mar 29, 2020 at 2:07 PM Adam Feuer <ad...@starcat.io> wrote:
> Nathan,
>
> A quick Google search yielded Reno – tooling for managing release notes.
>
> Reno docs:
> https://docs.openstack.org/reno/latest/
>
> Reno source code:
> https://github.com/openstack/reno
>
> It can use ReStructuredText (RST) and has Sphinx integration. Zephyr,
> Rust, Clang, Python, and others also use RST and Sphinx.
>
> -adam
>
> On Sun, Mar 29, 2020 at 1:48 PM Nathan Hartman <ha...@gmail.com>
> wrote:
>
>> On Sun, Mar 29, 2020 at 2:03 PM Gregory Nutt <sp...@gmail.com> wrote:
>> > The organization of the release notes is fine, it is just making the
>> > level of effort needed to produce them manageable. This begs for some
>> > kind of tooling.
>>
>> I wonder if there is some Free/Open Source tooling that already exists
>> (preferably something with a community and user base that already
>> exists around it) that we could adopt for this purpose.
>>
>> Can anyone recommend such a tool?
>>
>> Nathan
>>
>
>
> --
> Adam Feuer <ad...@starcat.io>
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Adam Feuer <ad...@starcat.io>.
Nathan,
A quick Google search yielded Reno – tooling for managing release notes.
Reno docs:
https://docs.openstack.org/reno/latest/
Reno source code:
https://github.com/openstack/reno
It can use ReStructuredText (RST) and has Sphinx integration. Zephyr, Rust,
Clang, Python, and others also use RST and Sphinx.
-adam
On Sun, Mar 29, 2020 at 1:48 PM Nathan Hartman <ha...@gmail.com>
wrote:
> On Sun, Mar 29, 2020 at 2:03 PM Gregory Nutt <sp...@gmail.com> wrote:
> > The organization of the release notes is fine, it is just making the
> > level of effort needed to produce them manageable. This begs for some
> > kind of tooling.
>
> I wonder if there is some Free/Open Source tooling that already exists
> (preferably something with a community and user base that already
> exists around it) that we could adopt for this purpose.
>
> Can anyone recommend such a tool?
>
> Nathan
>
--
Adam Feuer <ad...@starcat.io>
Re: [DISCUSS] Release Notes
Posted by Nathan Hartman <ha...@gmail.com>.
On Sun, Mar 29, 2020 at 2:03 PM Gregory Nutt <sp...@gmail.com> wrote:
> The organization of the release notes is fine, it is just making the
> level of effort needed to produce them manageable. This begs for some
> kind of tooling.
I wonder if there is some Free/Open Source tooling that already exists
(preferably something with a community and user base that already
exists around it) that we could adopt for this purpose.
Can anyone recommend such a tool?
Nathan
Re: [DISCUSS] Release Notes
Posted by Gregory Nutt <sp...@gmail.com>.
> The organization of the release notes is fine, it is just making the
> level of effort needed to produce them manageable. This begs for some
> kind of tooling
There is tools/logparser.c, but it was designed specifically to convert
the git log into the format used in the ChangeLog. It is useful for
that restricted purpose, but probably does not meet the need here.
Speaking of the ChangeLog: Keep it and maintain it? Or dump it? It
doesn't have anything in it that is not in the git log. It is somewhat
more compact than the git log, but otherwise offers now value.
Perhaps we should have an attic/ directory to put old things that are no
longer maintained but make have some historical value?
Re: [DISCUSS] Release Notes
Posted by Gregory Nutt <sp...@gmail.com>.
> I think we need to keep the release notes, they help people understand
> why they would want to upgrade.
> Let's make them succinct, however. I like the list of major parts,
> maybe we can add "Boards" to "Architecture Support" and add another
> part for other subsystems like, crypto, graphics, net, file systems,
> etc.
That is basically how it was done before. Look at the top-level file
nuttx/ReleaseNotes. That is ALL previous release nots. It is divided
into two major sections: New Features and Bugfixes. Within each
section, these are enumerated broken out by just the kinds of categories
that you describe.
The organization of the release notes is fine, it is just making the
level of effort needed to produce them manageable. This begs for some
kind of tooling.
Re: [DISCUSS] Release Notes
Posted by Abdelatif Guettouche <ab...@gmail.com>.
I think we need to keep the release notes, they help people understand
why they would want to upgrade.
Let's make them succinct, however. I like the list of major parts,
maybe we can add "Boards" to "Architecture Support" and add another
part for other subsystems like, crypto, graphics, net, file systems,
etc.
> I think the Release Notes should be on the website, not bundled with
> the release tarballs. Rationale: This will allow us to update the
> release notes after the release is made. That would be done, e.g.,
> when known problems are discovered in a release, or to document any
> security issue(s) that the release fixes.
I think this is better. We can still add a note in the readme file
about the latest release and where to find the full release notes.
> It's a very different thing than a Changelog. A Changelog contains
> every detail of what changed and in my opinion that's an outdated
> concept because interested parties can list the Git log, if they
> really want to study every single change.
I'd be in favor of dumping the Changelog, maybe delete it now?
Greg, do you agree? You spent a lot of time with this.
On Sun, Mar 29, 2020 at 5:16 PM Nathan Hartman <ha...@gmail.com> wrote:
>
> Earlier, in the thread "The Release"...
>
> On Sun, Mar 29, 2020 at 11:44 AM Gregory Nutt <sp...@gmail.com> wrote:
> > Do we plan to generate Release Notes? In my experience that is the most
> > difficult part of the release (the rest is fun). Abdelatif tells me that
> > there are 1051 commits. That is a much lower number that I expecteded,
> > lower than most old 2 month cycles, but probably still more than anyone
> > really wants to dig into in detail.
> >
> > We can control this level of effort. Perhaps we just want to list major
> > new architectures and boards supported. And any major new OS features?
> > That would be a relatively low effort. it would be nice to list the
> > major bugs that have been fixed but I don't know of any easy way to get
> > that.
>
> I think we should have Release Notes.
>
> But NOT in excruciating detail!!
>
> Release Notes are for people who want to know:
> * "What's new in this release?"
> * "Why would I want to upgrade?"
> * "What changes must I make in my application?"
> * etc.
>
> It's a very different thing than a Changelog. A Changelog contains
> every detail of what changed and in my opinion that's an outdated
> concept because interested parties can list the Git log, if they
> really want to study every single change.
>
> I think the Release Notes should be on the website, not bundled with
> the release tarballs. Rationale: This will allow us to update the
> release notes after the release is made. That would be done, e.g.,
> when known problems are discovered in a release, or to document any
> security issue(s) that the release fixes.
>
> When new releases are made, Release Notes should only be added, never
> removed, so that people will be able to access release notes for older
> versions at any time.
>
> The release notes could be structured according to the major parts of
> the OS. Something like this:
>
> (1) What's New In This Release
>
> (A) Maybe a paragraph or two listing the most major new features/changes.
> (B) Highlights of project news since last release.
>
> (2) Compatibility Concerns
>
> Point out any major changes that require changes by downstream users.
>
> (3) Major Changes to Core OS
>
> (A) New or significantly changed
>
> (4) Major Changes to Build System
>
> (A) New or significantly changed
>
> (5) Architectural Support
>
> (A) List new architectures
> (B) List architectures with significant improvements
> (C) List removed architectures
>
> (6) Driver Support
>
> (A) List major new drivers
> (B) List drivers with significant improvements
> (C) List removed drivers
>
> (7) Security Issues Fixed in this Release
>
> (8) Known Problems in this Release
>
> (If any)
>
> (9) More Information
>
> (A) Where to find the release
> (B) How to clone git repository and list full changelog
> (C) How to contact the community
>
> (10) Call to action: Invitation to get involved in Apache NuttX
> community and development!
>
> Thoughts?
>
> Cheers,
> Nathan