diff options
author | Martin Erik Werner <martinerikwerner@gmail.com> | 2019-09-03 01:48:28 +0200 |
---|---|---|
committer | Chris Johns <chrisj@rtems.org> | 2019-09-03 09:48:35 +1000 |
commit | 2e711f2b4b59398a18d21ea34bdb064c459fdd45 (patch) | |
tree | e79c0d7ee12a966fdd93d717ec573657ea1e55ce /shell/file_and_directory.rst | |
parent | Update docs for log mode change and JSON reporting (diff) | |
download | rtems-docs-2e711f2b4b59398a18d21ea34bdb064c459fdd45.tar.bz2 |
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.
Diffstat (limited to 'shell/file_and_directory.rst')
-rw-r--r-- | shell/file_and_directory.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/shell/file_and_directory.rst b/shell/file_and_directory.rst index 8609736..c1837ac 100644 --- a/shell/file_and_directory.rst +++ b/shell/file_and_directory.rst @@ -100,7 +100,7 @@ NOTES: EXAMPLES: The following is an example of how to use ``blksync``: - .. code-block:: c + .. code-block:: shell blksync /dev/hda1 @@ -1469,7 +1469,7 @@ ln - make links .. index:: ln SYNOPSYS: - .. code-block:: c + .. code-block:: shell ln [-fhinsv] source_file [target_file] ln [-fhinsv] source_file ... target_dir @@ -1729,7 +1729,7 @@ mkdir - create a directory .. index:: mkdir SYNOPSYS: - .. code-block:: c + .. code-block:: shell mkdir dir [dir1 .. dirN] |