On Thu, Jun 10, 2021 at 11:33 AM Sebastien Lorquet <sebast...@lorquet.fr> wrote: > > > Le 10/06/2021 à 16:34, Nathan Hartman a écrit : > > Second, we need a new Documentation page, "Migrating From Older > > NuttX." In this documentation, every compatibility change should be > > documented, going from the present to at least as far back as NuttX > > 7.31. We can get all of these from the ReleaseNotes, but they should > > be consolidated somewhere, so that someone like Sebastien who wants to > > upgrade from version X to version Y can just go step by step and make > > the necessary changes. > That would be an extremely good thing to have. It would ensure an > exhaustive migration path for legacy installations. > > That page should then explain how to migrate to cmake. > > If this doc is easy to find, I have less issues with cmake. > > Also thank you for fixing the release notes. This triplication is not > easy to manage.
Agreed, and one of these days I'm sure we'll find a better solution! In the "Migrating From Older NuttX" document: The last section should document migrating from Latest Release to current master's HEAD. I think it should be the project's policy, from now on, that every time a breaking change is made, it should be documented in that section IN THE SAME PR. This way, everyone will always have documentation how to get from wherever they are to latest HEAD, and When we release, all we have to do is change the title of that section to the new release number, and add a new empty section for HEAD below that. Nathan
