Re: [PATCH 1/3] user: Update migration guide
On Wed, Apr 15, 2020 at 9:29 AM Gedare Bloom wrote: > On Wed, Apr 15, 2020 at 7:56 AM Sebastian Huber > wrote: > > > > On 15/04/2020 15:52, Gedare Bloom wrote: > > > > +The configuration of SMP schedulers changed. Please read the > corresponding > > +chapter in the RTEMS Classic API Guide. > > > > I guess inter-doc refs don't work, but maybe the chapter name should > > be mentioned here? > > > > Ok, I will fix this here. > > > > In the long run we need a better solution for references in our > documentation set. > > > > We have to make it also easier for others to reference our > documentation. What I have in mind this is a bibtex entry in one of the > front pages which someone can simply copy and paste into its bibtex data > base. > > Yes, having some suggested citable sources would be helpful for many > reasons. We should consider if it is possible to "publish" our release > manuals some way that makes them more easily citable. > If the PDFs are acceptable, the RTEMS Foundation could self-pub them on Amazon and that would give them ISBN numbers. I looked into doing this a while back. At that point, I recall the biggest hurdle was having a front and back cover. The set of template covers may have changed and OAR now has a graphics artist on staff. Worth evaluating again. With the RTEMS Foundation a legal entity now, that would give it a theoretical (small) source of revenue. That's better than one of us doing it as an individual. The hard copy price would be based on the number of pages. The Kindle version should be much cheaper. How does this sound as a plan? We also need bibtex entries. :) --joel > ___ > devel mailing list > devel@rtems.org > http://lists.rtems.org/mailman/listinfo/devel > ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: [PATCH 1/3] user: Update migration guide
On Wed, Apr 15, 2020 at 7:56 AM Sebastian Huber wrote: > > On 15/04/2020 15:52, Gedare Bloom wrote: > > +The configuration of SMP schedulers changed. Please read the corresponding > +chapter in the RTEMS Classic API Guide. > > I guess inter-doc refs don't work, but maybe the chapter name should > be mentioned here? > > Ok, I will fix this here. > > In the long run we need a better solution for references in our documentation > set. > > We have to make it also easier for others to reference our documentation. > What I have in mind this is a bibtex entry in one of the front pages which > someone can simply copy and paste into its bibtex data base. Yes, having some suggested citable sources would be helpful for many reasons. We should consider if it is possible to "publish" our release manuals some way that makes them more easily citable. ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: [PATCH 1/3] user: Update migration guide
On 15/04/2020 15:52, Gedare Bloom wrote: +The configuration of SMP schedulers changed. Please read the corresponding +chapter in the RTEMS Classic API Guide. I guess inter-doc refs don't work, but maybe the chapter name should be mentioned here? Ok, I will fix this here. In the long run we need a better solution for references in our documentation set. We have to make it also easier for others to reference our documentation. What I have in mind this is a bibtex entry in one of the front pages which someone can simply copy and paste into its bibtex data base. ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
Re: [PATCH 1/3] user: Update migration guide
On Tue, Apr 14, 2020 at 9:13 AM Sebastian Huber wrote: > > Update #3895. > --- > user/migration/v4_11-to-v5.rst | 54 > -- > 1 file changed, 42 insertions(+), 12 deletions(-) > > diff --git a/user/migration/v4_11-to-v5.rst b/user/migration/v4_11-to-v5.rst > index 4329771..2917951 100644 > --- a/user/migration/v4_11-to-v5.rst > +++ b/user/migration/v4_11-to-v5.rst > @@ -1,6 +1,7 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > .. Copyright (C) 2020 Chris Johns > +.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) > > .. _Migration_4_11_to_5: > > @@ -10,33 +11,62 @@ RTEMS 4.11 to RTEMS 5 > This section provides helpful information when migrating from RTEMS 4.11 to > RTEMS 5. > > -Configuration > -- > +Application Configuration Options > +- > + > +The evaluation of application configuration options in > +was reworked during the RTEMS 5 development cycle. All options which let the > +user define data structures were removed, this includes > + > +* ``CONFIGURE_HAS_OWN_CONFIGURATION_TABLE``, > + > +* ``CONFIGURE_HAS_OWN_BDBUF_TABLE``, > + > +* ``CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE``, > + > +* ``CONFIGURE_HAS_OWN_FILESYSTEM_TABLE``, > + > +* ``CONFIGURE_HAS_OWN_INIT_TABLE``, > > -A number of configurations macros have moved as a result of internal changes > in > -RTEMS. Some of these will produce a warning indicating the new configuration > -setings you need to define. If you need to run an application on RTEMS 4.11 > and > -RTEMS 5 the following code exmaple shows how to conditionally define the > -settings. The example is: > +* ``CONFIGURE_HAS_OWN_MOUNT_TABLE``, > + > +* ``CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE``, and > + > +* ``CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE``. > + > +The configuration of SMP schedulers changed. Please read the corresponding > +chapter in the RTEMS Classic API Guide. I guess inter-doc refs don't work, but maybe the chapter name should be mentioned here? > + > +A number of configurations options have moved or are obsolete as a result of > +internal changes in RTEMS. Some of these will produce a warning indicating > the > +new configuration setings you need to define. If you need to run an > application s/setings/settings Not introduced by your change, but still should fix. > +on RTEMS 4.11 and RTEMS 5 the following code exmaple shows how to > conditionally s/exmaple/example Also not your typo. > +define the settings. The example is: > > .. code-block:: c > > #include > > #if __RTEMS_MAJOR__ < 5 > - #define CONFIGURE_MAXIMUM_FIFOS 10 > - #define CONFIGURE_MAXIMUM_PIPES 10 > + #define CONFIGURE_MAXIMUM_FIFOS 10 > + #define CONFIGURE_MAXIMUM_PIPES 10 > #else > - #define CONFIGURE_IMFS_ENABLE_MKFIFO > + #define CONFIGURE_IMFS_ENABLE_MKFIFO > #endif > > #define MAX_FILE_DESCRIPTORS 200 > #if __RTEMS_MAJOR__ < 5 > - #define CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS MAX_FILE_DESCRIPTORS > + #define CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS MAX_FILE_DESCRIPTORS > #else > - #define CONFIGURE_MAXIMUM_FILE_DESCRIPTORS MAX_FILE_DESCRIPTORS > + #define CONFIGURE_MAXIMUM_FILE_DESCRIPTORS MAX_FILE_DESCRIPTORS > #endif > > +Clock Manager > +- > + > +The directive :c:func:`rtems_clock_get` was removed. See the RTEMS Classic > API > +Guide for alternatives. Again, providing further direction would help. > + > Networking > -- > > -- > 2.16.4 > > ___ > devel mailing list > devel@rtems.org > http://lists.rtems.org/mailman/listinfo/devel ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
[PATCH 1/3] user: Update migration guide
Update #3895. --- user/migration/v4_11-to-v5.rst | 54 -- 1 file changed, 42 insertions(+), 12 deletions(-) diff --git a/user/migration/v4_11-to-v5.rst b/user/migration/v4_11-to-v5.rst index 4329771..2917951 100644 --- a/user/migration/v4_11-to-v5.rst +++ b/user/migration/v4_11-to-v5.rst @@ -1,6 +1,7 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 .. Copyright (C) 2020 Chris Johns +.. Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) .. _Migration_4_11_to_5: @@ -10,33 +11,62 @@ RTEMS 4.11 to RTEMS 5 This section provides helpful information when migrating from RTEMS 4.11 to RTEMS 5. -Configuration -- +Application Configuration Options +- + +The evaluation of application configuration options in +was reworked during the RTEMS 5 development cycle. All options which let the +user define data structures were removed, this includes + +* ``CONFIGURE_HAS_OWN_CONFIGURATION_TABLE``, + +* ``CONFIGURE_HAS_OWN_BDBUF_TABLE``, + +* ``CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE``, + +* ``CONFIGURE_HAS_OWN_FILESYSTEM_TABLE``, + +* ``CONFIGURE_HAS_OWN_INIT_TABLE``, -A number of configurations macros have moved as a result of internal changes in -RTEMS. Some of these will produce a warning indicating the new configuration -setings you need to define. If you need to run an application on RTEMS 4.11 and -RTEMS 5 the following code exmaple shows how to conditionally define the -settings. The example is: +* ``CONFIGURE_HAS_OWN_MOUNT_TABLE``, + +* ``CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE``, and + +* ``CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE``. + +The configuration of SMP schedulers changed. Please read the corresponding +chapter in the RTEMS Classic API Guide. + +A number of configurations options have moved or are obsolete as a result of +internal changes in RTEMS. Some of these will produce a warning indicating the +new configuration setings you need to define. If you need to run an application +on RTEMS 4.11 and RTEMS 5 the following code exmaple shows how to conditionally +define the settings. The example is: .. code-block:: c #include #if __RTEMS_MAJOR__ < 5 - #define CONFIGURE_MAXIMUM_FIFOS 10 - #define CONFIGURE_MAXIMUM_PIPES 10 + #define CONFIGURE_MAXIMUM_FIFOS 10 + #define CONFIGURE_MAXIMUM_PIPES 10 #else - #define CONFIGURE_IMFS_ENABLE_MKFIFO + #define CONFIGURE_IMFS_ENABLE_MKFIFO #endif #define MAX_FILE_DESCRIPTORS 200 #if __RTEMS_MAJOR__ < 5 - #define CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS MAX_FILE_DESCRIPTORS + #define CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS MAX_FILE_DESCRIPTORS #else - #define CONFIGURE_MAXIMUM_FILE_DESCRIPTORS MAX_FILE_DESCRIPTORS + #define CONFIGURE_MAXIMUM_FILE_DESCRIPTORS MAX_FILE_DESCRIPTORS #endif +Clock Manager +- + +The directive :c:func:`rtems_clock_get` was removed. See the RTEMS Classic API +Guide for alternatives. + Networking -- -- 2.16.4 ___ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
