15 Commits

Author SHA1 Message Date
Sebastian Huber
1f8301a972 c-user: Mention possible preemptions
Mention that object create/delete may case the calling task to be
preempted due to the object allocator mutex.
2020-06-18 07:13:13 +02:00
Martin Erik Werner
2424590528 c-user: Add & update ratemon get return values
Add a description of the previously missing RTEMS_NOT_DEFINED return
value for rtems_rate_monotonic_get_status().

Update the RTEMS_SUCCESSFUL return value descriptions for
rtems_rate_monotonic_get_status() and
rtems_rate_monotonic_get_statistics() which incorrectly used the same
description as rtems_rate_monotonic_period().
2020-03-06 16:37:39 +01:00
Martin Erik Werner
2e711f2b4b Address several issues from compiling examples
Compiling the code from examples "code-block:: c" along with public
includes and a bsp exposed a few issues amongst a lot of false
positives. Address some of these:

* Terminate struct declarations with ';'. Mainly for pedantic
  correctness.

* Show ptrdiff_t instead of size_t for the sbrk() prototype, matching
  the current argument type in rtems.

* Replace some occurrences of unsigned16 with uint16_t.

* Fix odd type declaration, "uint8_t char*" -> "char*".

* Use appropriate helper to get chain head instead of invalid access to
  nonexistent struct member.

* Remove several excess '\' escapes.

* Use RTEMS_SELF instead of undefined SELF.

* Use rtems_task instead of void for task functions.

* Add missing stack size parameter in task creation.

* Use rtems_interrupt_level instead of undefined rtems_interrupt.

* Correct return value format for rtems_object_id_get_api()
  rtems_object_id_get_index() (enum and uint16_t) and also fix
  corresponding print formatting.

* Correct return value documentation for rtems_object_id_get_class(),
  rtems_object_id_get_node() and rtems_object_id_get_index()
  int -> uint32_t.

* Use RTEMS_SUCCESSFUL instead of undefined RTEMS_STATUS_SUCCESSFUL and
  fix return value variable name in rate monotonic examples.

* Use RTEMS_TIMEOUT instead of undefined TIMEOUT and RTEMS_PERIOD_STATUS
  instead of undefined STATUS.

* Add missing fields to ftpd configuration.

* Correct parameter types in ftpd hook prototype,
  unsigned char * -> void *.

* Fix various code-block:: attributes, c -> makefile and c -> shell.

* Add missing parenthesis in socket buffer memory calculation example.

* Remove typedef in declaration of mq_attr since it is defiend without
  typedef in reality.

* Update siginfo_t declaration to match current reality.

* Update shell user command definition example to include mode, uid and
  gid.
2019-09-03 09:48:35 +10:00
Sebastian Huber
e52906b556 Simplify SPDX-License-Identifier comment 2019-01-11 07:22:01 +01:00
Sebastian Huber
12dccfe716 Remove superfluous "All rights reserved." 2019-01-11 07:18:56 +01:00
Sebastian Huber
4886d60aa8 Use standard format for copyright lines 2019-01-11 07:18:16 +01:00
Chris Johns
33849946ff Clean up sphinx warnings.
- Fix minor formatting issues.
- Fix reference the gloassary TLS using ':term:'.
- Make sure nothing is between an anchor and the heading where ':ref:' references
  the anchor. This meant moving all the recently added '.. index::' entries.

Update #3232.
Update #3229.
2017-11-13 13:25:18 +11:00
Chris Johns
6c5640131f c-user: Fix index locations.
Update #3229.
2017-11-12 14:34:48 +11:00
Joel Sherrill
c8b6745825 c-user/rate_monotonic_manager.rst: Use Latex math for utilization formulas 2017-04-25 12:33:18 -05:00
Sebastian Huber
938c49e177 Fix refs.bib entry 2017-01-31 14:30:09 +01:00
Kuan-Hsun Chen
c660173fa4 c-user: Update overrun handling related functions and structure
State the limited count of postponed_jobs.
Update _rtems_rate_monotonic_get_status() and related structure.
Move "Further Reading" in c-user to references.
Add mentioned papers in ticket #2795 to references.

Update #2795.
2017-01-30 07:58:27 +01:00
Kuan-Hsun Chen
69d6622ef9 Update documentation to reflect EDF scheduler overrun handling
Update #2795.
2017-01-13 16:07:24 -06:00
Chris Johns
4da4a15ee1 c-user: Fix header levels. Minor fixes. 2016-11-09 11:42:30 +11:00
Chris Johns
53bb72e996 c-user: Format the directives as descriptions.
This change combined with the element list change in latex generates
a much better looking PDF.

Add a page break before each directive to like th previous versions of the
manuals.
2016-11-08 15:28:32 +11:00
Chris Johns
72a62ad88f Rename all manuals with an _ to have a -. It helps released naming of files. 2016-11-03 16:58:08 +11:00