19 Commits

Author SHA1 Message Date
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
fd9d02471b c-user: Add msg broadcast to ISR allowed funcs 2019-05-28 07:43:18 +02: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
464d541653 c-user: Use uniprocessor throughout 2018-03-07 15:33:02 +01:00
Sebastian Huber
0ef3449a75 c-user: Clarify local interrupt disable 2017-12-01 09:31:57 +01:00
Sebastian Huber
b2c766bc72 c-user: Clarify interrupt manager directives
Use RTEMS coding style in all code blocks.
2017-11-30 10:12:50 +01:00
Sebastian Huber
e2a1a3ab2a c-user: Clarify rtems_interrupt_flash() 2017-11-20 08:08:06 +01:00
Sebastian Huber
6efb6fadbe c-user: Remove clock driver specific functions
Do not mention functions which belong to a specific clock driver
implementation.  These functions should not be called by applications
directly.
2017-11-17 13:33:57 +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
21e0fcd28f c-user: Update to reflect rtems_clock_get() being obsoleted.
Closes #2693.
2017-10-11 18:41:41 -05:00
Sebastian Huber
f776fe6591 c-user: Fix interrupt lock documentation
Update #3075.
2017-07-14 07:52:21 +02:00
Sebastian Huber
a0d2eeea9d Use "in X config..." instead of "on X config..." 2017-02-01 13:42:39 +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
Sebastian Huber
3a58bff6bf Update due to clock manager and driver changes 2016-11-03 10:59:01 +01: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