On 04/10/2022 09:04, Chris Johns wrote:
On 30/9/2022 11:34 pm, Sebastian Huber wrote:
On 17/09/2022 09:31, Chris Johns wrote:
+rtems_get_version_string()
+--
+
+Gets the RTEMS version string.
+
+.. rubric:: CALLING SEQUENCE:
+
+.. code-block:: c
+
+ const char
On 1/10/2022 12:25 am, Sebastian Huber wrote:
> On 17/09/2022 09:31, Chris Johns wrote:
>>> diff --git a/c-user/config/introduction.rst b/c-user/config/introduction.rst
>>> new file mode 100644
>>> index 000..d06662a
>>> --- /dev/null
>>> +++ b/c-user/config/introduction.rst
>>> @@ -0,0
On 30/9/2022 11:43 pm, Sebastian Huber wrote:
> On 17/09/2022 09:31, Chris Johns wrote:
>>> +rtems_configuration_get_milliseconds_per_tick()
>>> +---
>>> +
>>> +Gets the number of milliseconds per clock tick configured for this
>>> application.
>> There
On 30/9/2022 11:34 pm, Sebastian Huber wrote:
> On 17/09/2022 09:31, Chris Johns wrote:
>>> +rtems_get_version_string()
>>> +--
>>> +
>>> +Gets the RTEMS version string.
>>> +
>>> +.. rubric:: CALLING SEQUENCE:
>>> +
>>> +.. code-block:: c
>>> +
>>> + const char
On 17/09/2022 09:31, Chris Johns wrote:
diff --git a/c-user/config/introduction.rst b/c-user/config/introduction.rst
new file mode 100644
index 000..d06662a
--- /dev/null
+++ b/c-user/config/introduction.rst
@@ -0,0 +1,221 @@
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. Copyright (C)
On 17/09/2022 09:31, Chris Johns wrote:
+rtems_configuration_get_stack_allocate_init_hook()
+--
+
+Gets the thread stack allocator initialization hook configured for this
+application.
+
+.. rubric:: CALLING SEQUENCE:
+
+.. code-block:: c
+
+
On 17/09/2022 09:31, Chris Johns wrote:
+rtems_configuration_get_milliseconds_per_tick()
+---
+
+Gets the number of milliseconds per clock tick configured for this application.
There are other API calls that return this value. What should a user do?
On 17/09/2022 09:31, Chris Johns wrote:
+rtems_get_version_string()
+--
+
+Gets the RTEMS version string.
+
+.. rubric:: CALLING SEQUENCE:
+
+.. code-block:: c
+
+const char *rtems_get_version_string( void );
+
+.. rubric:: RETURN VALUES:
+
+Returns the pointer to the
On 17/09/2022 09:31, Chris Johns wrote:
+rtems_get_copyright_notice()
+
+
+Gets the RTEMS copyright notice.
Subject to format changes, ie users should decode and expect backwards
compatibility?
I don't know. Currently it is just an arbitrary string.
--
embedded
On 23.09.22 08:55, Chris Johns wrote:
Do we want a single chapter with all Classic API types?
Do we want a section per manager for the types?
Which types should be documented?
I would document them in a single chapter and only structs.
There are 2 cases in relation to this thread and
On 23/9/2022 4:34 pm, Sebastian Huber wrote:
On 23.09.22 00:04, Chris Johns wrote:
On 22/9/2022 6:18 pm, Sebastian Huber wrote:
On 17/09/2022 09:31, Chris Johns wrote:
+.. index:: rtems_configuration_get_rtems_api_configuration()
+
+.. _InterfaceRtemsConfigurationGetRtemsApiConfiguration:
+
On 23.09.22 00:04, Chris Johns wrote:
On 22/9/2022 6:18 pm, Sebastian Huber wrote:
On 17/09/2022 09:31, Chris Johns wrote:
+.. index:: rtems_configuration_get_rtems_api_configuration()
+
+.. _InterfaceRtemsConfigurationGetRtemsApiConfiguration:
+
On 22/9/2022 6:18 pm, Sebastian Huber wrote:
> On 17/09/2022 09:31, Chris Johns wrote:
>>> +.. index:: rtems_configuration_get_rtems_api_configuration()
>>> +
>>> +.. _InterfaceRtemsConfigurationGetRtemsApiConfiguration:
>>> +
>>> +rtems_configuration_get_rtems_api_configuration()
>>>
On 17/09/2022 09:31, Chris Johns wrote:
+.. index:: rtems_configuration_get_rtems_api_configuration()
+
+.. _InterfaceRtemsConfigurationGetRtemsApiConfiguration:
+
+rtems_configuration_get_rtems_api_configuration()
+-
+
+Gets the Classic API
On 19/9/2022 5:21 pm, Sebastian Huber wrote:
> On 17/09/2022 09:31, Chris Johns wrote:
>>> +rtems_configuration_get_do_zero_of_workspace()
>>> +--
>>> +
>>> +Indicates if the RTEMS Workspace is configured to be zeroed during system
>>> +initialization
On 17/09/2022 09:31, Chris Johns wrote:
+rtems_configuration_get_do_zero_of_workspace()
+--
+
+Indicates if the RTEMS Workspace is configured to be zeroed during system
+initialization for this application.
+
+.. rubric:: CALLING SEQUENCE:
+
+..
Hi,
Sorry about not reviewing this before now.
Thanks for this, it looks good and most welcome. I have raised some general
questions that apply to a number of entries. I did not tag every case.
On 10/9/22 12:33 am, Sebastian Huber wrote:
> Close #4267.
> Close #4269.
> ---
>
On 09.09.22 16:33, Sebastian Huber wrote:
Close #4267.
Close #4269.
---
c-user/config/directives.rst | 1197
c-user/config/index.rst|2 +
c-user/config/intro.rst| 43 --
c-user/config/introduction.rst | 221 ++
4 files changed,
18 matches
Mail list logo
