Remove the unfinished sentence
"Since a barrier is, by definition, never immediately [...]"
and jump directly to
"The task may wait [forever or for a timeout]"
instead.
I cannot figure out what the unfinished sentence is supposed to be -
"released"? "passed"?
Remove various incorrect references to "lock" and "obtain" and to an
option set which is not part of the barrier interface.
It looks like the barrier documentation was started based on a copy of
the semaphore documentation and these things are surviving remnants.
Also remove an unfinished sentence in the barrier wait description,
since the intended information is already provided in the under the NOTE
label.
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.
There are still sys.path hacks in the conf.py files. They cannot
be removed because the instance of python running the sphinx-build
command does not see our top level path hacks. I looked at using
PYTHONPATH but I could not figure out how to set a process environ
var for a waf build instance.
For everything before 2015 an OAR copyright is assumed. Later copyright
notices are based on Git commits on a best effort basis.
The copyright notices of the "RTEMS Software Engineering Handbook" and
the "RTEMS CPU Architecture Supplement" are incomplete.
- Remove all genindex.rst files, these are generated and should not
exist in our source.
- Fix the HTML templates so the local specialisation works.
- Add a index link to the sidebar for HTML.
Note, there is no TOC entry for the index in the PDF output and I
cannot figure out how to add one.
Closes#3503
