Re: [DISCUSS] Release Notes

2020-04-15 Thread Abdelatif Guettouche
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 wrote: > > Looks good in my opinion > Thanks! > > Alin > > > On Tue, Apr 1

Re: [DISCUSS] Release Notes

2020-04-15 Thread Alin Jerpelea
Looks good in my opinion Thanks! Alin On Tue, Apr 14, 2020, 23:13 Abdelatif Guettouche < abdelatif.guettou...@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 mo

Re: [DISCUSS] Release Notes

2020-04-14 Thread Nathan Hartman
On Tue, Apr 14, 2020 at 5:13 PM Abdelatif Guettouche 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

Re: [DISCUSS] Release Notes

2020-04-14 Thread Abdelatif Guettouche
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". Ma

Re: [DISCUSS] Release Notes

2020-04-10 Thread Abdelatif Guettouche
> 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 C

Re: [DISCUSS] Release Notes

2020-04-09 Thread Nathan Hartman
On Thu, Apr 9, 2020 at 7:09 PM Abdelatif Guettouche < abdelatif.guettou...@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

Re: [DISCUSS] Release Notes

2020-04-09 Thread Alan Carvalho de Assis
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 wrote: > Alan, > > Thank you! We just need bugfixes now, Abdelatif, Nathan, and I did all the > features. I think Abdelatif did bugfixes too. > > So

Re: [DISCUSS] Release Notes

2020-04-09 Thread Abdelatif Guettouche
> - 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, improvem

Re: [DISCUSS] Release Notes

2020-04-09 Thread Adam Feuer
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 Ca

Re: [DISCUSS] Release Notes

2020-04-09 Thread Alan Carvalho de Assis
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 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 r

Re: [DISCUSS] Release Notes

2020-04-09 Thread Adam Feuer
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.guettou...@gmail.com> wrote: > I don't know how you and Nathan proceeded, but I went through all the > PRs

Re: [DISCUSS] Release Notes

2020-04-09 Thread Abdelatif Guettouche
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

Re: [DISCUSS] Release Notes

2020-04-09 Thread Adam Feuer
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.guettou...@gmail.com> wrote: > The list of the PRs where all under "Features Added" so we lost some > organization in the page. I g

Re: [DISCUSS] Release Notes

2020-04-09 Thread Abdelatif Guettouche
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 every

Re: [DISCUSS] Release Notes

2020-04-09 Thread Adam Feuer
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 wrote: > I think putting th

Re: [DISCUSS] Release Notes

2020-04-09 Thread Adam Feuer
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 Abd

Re: [DISCUSS] Release Notes

2020-04-09 Thread Abdelatif Guettouche
> 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 determin

Re: [DISCUSS] Release Notes

2020-04-09 Thread Adam Feuer
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 . It would be a GREAT help if in the future all contributors fill out the PR description with a little bit of

Re: [DISCUSS] Release Notes

2020-04-07 Thread Abdelatif Guettouche
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

Re: [DISCUSS] Release Notes

2020-04-03 Thread Nathan Hartman
On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer 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 >- Ad

Re: [DISCUSS] Release Notes

2020-04-02 Thread Nathan Hartman
On Thu, Apr 2, 2020 at 8:11 PM Adam Feuer 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 >- A

Re: [DISCUSS] Release Notes

2020-04-02 Thread Adam Feuer
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, a

Re: [DISCUSS] Release Notes

2020-04-02 Thread Abdelatif Guettouche
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

Re: [DISCUSS] Release Notes

2020-04-02 Thread Adam Feuer
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 wrote: > I have an improvement to the process. I just made a scrapy > script that can downlo

Re: [DISCUSS] Release Notes

2020-04-02 Thread Gregory Nutt
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

Re: [DISCUSS] Release Notes

2020-04-02 Thread Gregory Nutt
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,

Re: [DISCUSS] Release Notes

2020-04-02 Thread Adam Feuer
I have an improvement to the process. I just made a scrapy 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 desc

Re: [DISCUSS] Release Notes

2020-04-02 Thread Nathan Hartman
On Thu, Apr 2, 2020 at 1:01 PM Adam Feuer 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 thi

Re: [DISCUSS] Release Notes

2020-04-02 Thread Adam Feuer
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

Re: [DISCUSS] Release Notes

2020-03-30 Thread Adam Feuer
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,

Re: [DISCUSS] Release Notes

2020-03-29 Thread Adam Feuer
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

Re: [DISCUSS] Release Notes

2020-03-29 Thread Nathan Hartman
On Sun, Mar 29, 2020 at 2:03 PM Gregory Nutt 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

Re: [DISCUSS] Release Notes

2020-03-29 Thread Adam Feuer
> Release notes are already pulled from the source code and placed on the > webpage with the release. > Awesome! -adam -- Adam Feuer

Re: [DISCUSS] Release Notes

2020-03-29 Thread Brennan Ashton
On Sun, Mar 29, 2020 at 1:00 PM Adam Feuer 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 th

Re: [DISCUSS] Release Notes

2020-03-29 Thread Adam Feuer
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 note

Re: [DISCUSS] Release Notes

2020-03-29 Thread Nathan Hartman
On Sun, Mar 29, 2020 at 2:43 PM Gregory Nutt 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 aft

Re: [DISCUSS] Release Notes

2020-03-29 Thread Gregory Nutt
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

Re: [DISCUSS] Release Notes

2020-03-29 Thread Adam Feuer
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

Re: [DISCUSS] Release Notes

2020-03-29 Thread Gregory Nutt
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 usefu

Re: [DISCUSS] Release Notes

2020-03-29 Thread Gregory Nutt
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, f

Re: [DISCUSS] Release Notes

2020-03-29 Thread Abdelatif Guettouche
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

[DISCUSS] Release Notes

2020-03-29 Thread Nathan Hartman
Earlier, in the thread "The Release"... On Sun, Mar 29, 2020 at 11:44 AM Gregory Nutt 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