24 Commits

Author SHA1 Message Date
Sebastian Huber
dee158cd68 c-user: Document RTEMS_FATAL_SOURCE_HEAP
Close #3806.
2019-10-31 13:29:41 +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
789b0caad7 c-user: INTERNAL_ERROR_NO_MEMORY_FOR_PER_CPU_DATA
Update #3507.
2019-02-19 09:17:57 +01: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
Sebastian Huber
aaf9c78ac1 c-user: RTEMS_FATAL_SOURCE_INVALID_HEAP_FREE
Close #3437.
2018-06-05 09:13:25 +02:00
Malte Münch
9a91d77e08 fix typo: extesion->extension 2018-05-18 13:54:52 +02:00
Sebastian Huber
674b71470b c-user: Document global construction
Close #3243.
2017-11-24 06:56:51 +01:00
Sebastian Huber
97c51c8bfb c-user: Document rtems_panic()
Close #3244.
2017-11-23 07:27:55 +01:00
Sebastian Huber
70f23e475b Clarify INTERNAL_ERROR_ARC4RANDOM_GETENTROPY_FAIL
Update #3239.
2017-11-20 08:08:30 +01:00
Sebastian Huber
baf98240a4 Document INTERNAL_ERROR_ARC4RANDOM_GETENTROPY_FAIL
Close #3239.
2017-11-17 07:58:10 +01:00
Sebastian Huber
5531f022fc INTERNAL_ERROR_ILLEGAL_USE_OF_FLOATING_POINT_UNIT 2017-11-17 07:57:51 +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
Sebastian Huber
a0d2eeea9d Use "in X config..." instead of "on X config..." 2017-02-01 13:42:39 +01:00
Sebastian Huber
b1e3b75e90 c-user: Rework user extensions chapter
Update #2692.
Update #2752.
2017-01-26 15:10:49 +01:00
Sebastian Huber
6fa32c01ee Update Initialization Manager chapter
Update #2408.
2016-12-12 08:07:35 +01:00
Sebastian Huber
00ffe1fa6b Improve fatal error chapter
Update #2825.
2016-12-12 08:07:32 +01:00
Sebastian Huber
1727e62218 Improve fatal error chapter
Update #2825.
2016-11-23 13:45:55 +01:00
Sebastian Huber
943bc94874 Rework fatal error chapter
Update #2811.
2016-11-21 14:52:50 +01: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