You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by GitBox <gi...@apache.org> on 2018/05/26 02:19:12 UTC
[GitHub] aditihilbert closed pull request #1140: Apidocs - for json, stats,
logs, bootloader, shell
aditihilbert closed pull request #1140: Apidocs - for json, stats, logs, bootloader, shell
URL: https://github.com/apache/mynewt-core/pull/1140
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/os/modules/bootloader/boot_build_status.rst b/docs/os/modules/bootloader/boot_build_status.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_build_status.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_build_status_one.rst b/docs/os/modules/bootloader/boot_build_status_one.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_build_status_one.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_clear_status.rst b/docs/os/modules/bootloader/boot_clear_status.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_clear_status.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_copy_area.rst b/docs/os/modules/bootloader/boot_copy_area.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_copy_area.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_copy_image.rst b/docs/os/modules/bootloader/boot_copy_image.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_copy_image.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_erase_area.rst b/docs/os/modules/bootloader/boot_erase_area.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_erase_area.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_fill_slot.rst b/docs/os/modules/bootloader/boot_fill_slot.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_fill_slot.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_find_image_area_idx.rst b/docs/os/modules/bootloader/boot_find_image_area_idx.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_find_image_area_idx.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_find_image_part.rst b/docs/os/modules/bootloader/boot_find_image_part.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_find_image_part.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_find_image_slot.rst b/docs/os/modules/bootloader/boot_find_image_slot.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_find_image_slot.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_go.rst b/docs/os/modules/bootloader/boot_go.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_go.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_init_flash.rst b/docs/os/modules/bootloader/boot_init_flash.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_init_flash.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_move_area.rst b/docs/os/modules/bootloader/boot_move_area.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_move_area.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_read_image_header.rst b/docs/os/modules/bootloader/boot_read_image_header.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_read_image_header.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_read_image_headers.rst b/docs/os/modules/bootloader/boot_read_image_headers.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_read_image_headers.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_read_status.rst b/docs/os/modules/bootloader/boot_read_status.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_read_status.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_select_image_slot.rst b/docs/os/modules/bootloader/boot_select_image_slot.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_select_image_slot.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_slot_addr.rst b/docs/os/modules/bootloader/boot_slot_addr.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_slot_addr.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_slot_to_area_idx.rst b/docs/os/modules/bootloader/boot_slot_to_area_idx.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_slot_to_area_idx.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_swap_areas.rst b/docs/os/modules/bootloader/boot_swap_areas.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_swap_areas.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_vect_delete_main.rst b/docs/os/modules/bootloader/boot_vect_delete_main.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_vect_delete_main.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_vect_delete_test.rst b/docs/os/modules/bootloader/boot_vect_delete_test.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_vect_delete_test.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_vect_read_main.rst b/docs/os/modules/bootloader/boot_vect_read_main.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_vect_read_main.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_vect_read_one.rst b/docs/os/modules/bootloader/boot_vect_read_one.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_vect_read_one.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_vect_read_test.rst b/docs/os/modules/bootloader/boot_vect_read_test.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_vect_read_test.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/boot_write_status.rst b/docs/os/modules/bootloader/boot_write_status.rst
deleted file mode 100644
index 8b13789179..0000000000
--- a/docs/os/modules/bootloader/boot_write_status.rst
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/os/modules/bootloader/bootloader.rst b/docs/os/modules/bootloader/bootloader.rst
index ccfcc046b8..46d5bb3a4c 100644
--- a/docs/os/modules/bootloader/bootloader.rst
+++ b/docs/os/modules/bootloader/bootloader.rst
@@ -12,12 +12,18 @@ underway and manage the progress of the process.
The bootloader in the Apache Mynewt project verifies the cryptographic
signature of the firmware image before running it. It maintains a
-detailed status log for each stage of the boot process. For verification
-of the authenticity of the OS image, it:
+detailed status log for each stage of the boot process.
The "secure bootloader" should be placed in protected memory on a given
microcontroller.
+The Apache Mynewt bootloader is the foundation of `MCUboot <https://github.com/runtimeco/mcuboot/>`_,
+a secure bootloader for 32-bit MCUs that has been ported to other Operating Systems as well.
+
+.. contents::
+ :local:
+ :depth: 2
+
The Mynewt bootloader comprises two packages:
- The bootutil library (boot/bootutil)
@@ -592,31 +598,5 @@ the key that is has been signed with. The boot loader uses this index to
identify the corresponding public key.
For information on embedding public keys in the boot loader, as well as
-producing signed images, see: boot/bootutil/signed\_images.md
-
-- `boot\_build\_status <boot_build_status.html>`__
-- `boot\_build\_status\_one <boot_build_status_one.html>`__
-- `boot\_clear\_status <boot_clear_status.html>`__
-- `boot\_copy\_area <boot_copy_area.html>`__
-- `boot\_copy\_image <boot_copy_image.html>`__
-- `boot\_erase\_area <boot_erase_area.html>`__
-- `boot\_fill\_slot <boot_fill_slot.html>`__
-- `boot\_find\_image\_area\_idx <boot_find_image_area_idx.html>`__
-- `boot\_find\_image\_part <boot_find_image_part.html>`__
-- `boot\_find\_image\_slot <boot_find_image_slot.html>`__
-- `boot\_go <boot_go.html>`__
-- `boot\_init\_flash <boot_init_flash.html>`__
-- `boot\_move\_area <boot_move_area.html>`__
-- `boot\_read\_image\_header <boot_read_image_header.html>`__
-- `boot\_read\_image\_headers <boot_read_image_headers.html>`__
-- `boot\_read\_status <boot_read_status.html>`__
-- `boot\_select\_image\_slot <boot_select_image_slot.html>`__
-- `boot\_slot\_addr <boot_slot_addr.html>`__
-- `boot\_slot\_to\_area\_idx <boot_slot_to_area_idx.html>`__
-- `boot\_swap\_areas <boot_swap_areas.html>`__
-- `boot\_vect\_delete\_main <boot_vect_delete_main.html>`__
-- `boot\_vect\_delete\_test <boot_vect_delete_test.html>`__
-- `boot\_vect\_read\_main <boot_vect_read_main.html>`__
-- `boot\_vect\_read\_one <boot_vect_read_one.html>`__
-- `boot\_vect\_read\_test <boot_vect_read_test.html>`__
-- `boot\_write\_status <boot_write_status.html>`__
+producing signed images, see `here <https://github.com/apache/mynewt-core/blob/master/boot/bootutil/signed_images.md>`_.
+
diff --git a/docs/os/modules/json/json.rst b/docs/os/modules/json/json.rst
index e65ce0c99a..f44e4855ac 100644
--- a/docs/os/modules/json/json.rst
+++ b/docs/os/modules/json/json.rst
@@ -4,6 +4,10 @@ JSON
JSON is a data interchange format. The description of this format can be
found from IETF RFC 4627.
+.. contents::
+ :local:
+ :depth: 2
+
Description
-----------
@@ -135,59 +139,7 @@ Structure must be filled in before calling the decoder routine
| nodefault | If set, default value is not copied name |
+-------------+-------------------------------------------------------+
-List of Functions
------------------
-
-Functions for encoding:
-
-+------------+----------------+
-| Function | Description |
-+============+================+
-| `json\_enc | This function |
-| ode\_objec | starts the |
-| t\_start < | encoded JSON |
-| json_encod | object. |
-| e_object_s | |
-| tart.html>`_ | |
-| _ | |
-+------------+----------------+
-| `json\_enc | This function |
-| ode\_objec | writes out a |
-| t\_key <js | name for a |
-| on_encode_ | field, |
-| object_key | followed by |
-| .html>`__ | ":" character. |
-+------------+----------------+
-| `json\_enc | This function |
-| ode\_objec | writes out a |
-| t\_entry < | name for a |
-| json_encod | field, |
-| e_object_e | followed by |
-| ntry.html>`_ | ":" character, |
-| _ | and the value |
-| | itself. |
-+------------+----------------+
-| `json\_enc | This function |
-| ode\_objec | finalizes the |
-| t\_finish | encoded JSON |
-| <json_enco | object. |
-| de_object_ | |
-| finish.html> | |
-| `__ | |
-+------------+----------------+
-
-Functions for decoding:
-
-+------------+----------------+
-| Function | Description |
-+============+================+
-| `json\_rea | This function |
-| d\_object | reads in JSON |
-| <json_read | data stream, |
-| _object.md | while looking |
-| >`__ | for name/value |
-| | pairs |
-| | described in |
-| | given |
-| | attribites. |
-+------------+----------------+
+API
+---
+
+.. doxygenfile:: json/include/json/json.h
diff --git a/docs/os/modules/json/json_encode_object_entry.rst b/docs/os/modules/json/json_encode_object_entry.rst
deleted file mode 100644
index a8e7f606df..0000000000
--- a/docs/os/modules/json/json_encode_object_entry.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-json\_encode\_object\_entry
------------------------------
-
-.. code-block:: console
-
- int json_encode_object_entry(struct json_encoder *encoder, char *key, struct json_value *val)
-
-This function writes out a name for a field, followed by ":" character,
-and the value itself. How value is treated depends on the type of the
-value.
-
-Arguments
-^^^^^^^^^
-
-+-------------+------------------------+
-| Arguments | Description |
-+=============+========================+
-| encoder | json\_encoder to use |
-+-------------+------------------------+
-| key | name to write out |
-+-------------+------------------------+
-| val | value to write out |
-+-------------+------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-0 on success.
-
-Example
-^^^^^^^
-
-.. code:: c
-
- static int
- imgr_list(struct nmgr_jbuf *njb)
- {
- struct json_encoder *enc;
- struct json_value array;
-
- ...
-
- json_encode_object_start(enc);
- json_encode_object_entry(enc, "images", &array);
- json_encode_object_finish(enc);
-
- return 0;
- }
-
diff --git a/docs/os/modules/json/json_encode_object_finish.rst b/docs/os/modules/json/json_encode_object_finish.rst
deleted file mode 100644
index 0d98c82c17..0000000000
--- a/docs/os/modules/json/json_encode_object_finish.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-json\_encode\_object\_finish
-------------------------------
-
-.. code-block:: console
-
- int json_encode_object_finish(struct json_encoder *encoder)
-
-This function finalizes the encoded JSON object. This means writing out
-the last "}" character.
-
-Arguments
-^^^^^^^^^
-
-+-------------+------------------------+
-| Arguments | Description |
-+=============+========================+
-| encoder | json\_encoder to use |
-+-------------+------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-0 on success.
-
-Example
-^^^^^^^
-
-.. code:: c
-
- static int
- imgr_list(struct nmgr_jbuf *njb)
- {
- struct json_encoder *enc;
- struct json_value array;
-
- ...
-
- json_encode_object_start(enc);
- json_encode_object_entry(enc, "images", &array);
- json_encode_object_finish(enc);
-
- return 0;
- }
-
diff --git a/docs/os/modules/json/json_encode_object_key.rst b/docs/os/modules/json/json_encode_object_key.rst
deleted file mode 100644
index 5e83f76c52..0000000000
--- a/docs/os/modules/json/json_encode_object_key.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-json\_encode\_object\_key
----------------------------
-
-.. code-block:: console
-
- int json_encode_object_key(struct json_encoder *encoder, char *key)
-
-This function writes out a name for a field, followed by ":" character.
-You would use this e.g. when the value that follows is a JSON object.
-
-Arguments
-^^^^^^^^^
-
-+-------------+------------------------+
-| Arguments | Description |
-+=============+========================+
-| encoder | json\_encoder to use |
-+-------------+------------------------+
-| key | name to write out |
-+-------------+------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-0 on success.
-
-Example
-^^^^^^^
-
-.. code:: c
-
- int
- nmgr_def_taskstat_read(struct nmgr_jbuf *njb)
- {
- ...
-
- struct json_value jv;
-
- json_encode_object_start(&njb->njb_enc);
- JSON_VALUE_INT(&jv, NMGR_ERR_EOK);
- json_encode_object_entry(&njb->njb_enc, "rc", &jv);
-
- json_encode_object_key(&njb->njb_enc, "tasks");
- json_encode_object_start(&njb->njb_enc);
- ...
- }
diff --git a/docs/os/modules/json/json_encode_object_start.rst b/docs/os/modules/json/json_encode_object_start.rst
deleted file mode 100644
index 800354cacc..0000000000
--- a/docs/os/modules/json/json_encode_object_start.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-json\_encode\_object\_start
------------------------------
-
-.. code-block:: console
-
- int json_encode_object_start(struct json_encoder *encoder)
-
-This function starts the encoded JSON object. Usually this means writing
-out the initial "{" character.
-
-Arguments
-^^^^^^^^^
-
-+-------------+------------------------+
-| Arguments | Description |
-+=============+========================+
-| encoder | json\_encoder to use |
-+-------------+------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-0 on success.
-
-Example
-^^^^^^^
-
-.. code:: c
-
- static int
- imgr_list(struct nmgr_jbuf *njb)
- {
- struct json_encoder *enc;
- struct json_value array;
-
- ...
-
- json_encode_object_start(enc);
- json_encode_object_entry(enc, "images", &array);
- json_encode_object_finish(enc);
-
- return 0;
- }
-
diff --git a/docs/os/modules/json/json_read_object.rst b/docs/os/modules/json/json_read_object.rst
deleted file mode 100644
index 379dc9fff8..0000000000
--- a/docs/os/modules/json/json_read_object.rst
+++ /dev/null
@@ -1,67 +0,0 @@
-json\_read\_object
---------------------
-
-.. code-block:: console
-
- int json_read_object(struct json_buffer *jb, const struct json_attr_t *attrs)
-
-This function reads in JSON data stream, while looking for name/value
-pairs described in *attrs*. *attrs* is an array; end of the array is
-indicated by an entry with *NULL* as the name.
-
-Arguments
-^^^^^^^^^
-
-+-------------+-----------------------------------+
-| Arguments | Description |
-+=============+===================================+
-| jb | json\_decoder to use |
-+-------------+-----------------------------------+
-| attrs | array of attributes to look for |
-+-------------+-----------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-0 on success.
-
-Example
-^^^^^^^
-
-.. code:: c
-
-
- static int
- imgr_upload(struct nmgr_jbuf *njb)
- {
- ...
- const struct json_attr_t off_attr[4] = {
- [0] = {
- .attribute = "off",
- .type = t_uinteger,
- .addr.uinteger = &off,
- .nodefault = true
- },
- [1] = {
- .attribute = "data",
- .type = t_string,
- .addr.string = img_data,
- .len = sizeof(img_data)
- },
- [2] = {
- .attribute = "len",
- .type = t_uinteger,
- .addr.uinteger = &size,
- .nodefault = true
- }
- };
- ...
-
- rc = json_read_object(&njb->njb_buf, off_attr);
- if (rc || off == UINT_MAX) {
- rc = OS_EINVAL;
- goto err;
- }
- ...
- }
-
diff --git a/docs/os/modules/logs/logs.rst b/docs/os/modules/logs/logs.rst
index fa993c1354..7da70de106 100644
--- a/docs/os/modules/logs/logs.rst
+++ b/docs/os/modules/logs/logs.rst
@@ -6,6 +6,10 @@ application. It allows packages to define their own log streams with
separate names. It also allows an application to control the output
destination of logs.
+.. contents::
+ :local:
+ :depth: 2
+
### Description
In the Mynewt OS, the log package comes in two versions:
@@ -207,5 +211,4 @@ handler:
Log API and Log Levels
~~~~~~~~~~~~~~~~~~~~~~
-For more information on the ``log`` API and log levels, see the
-``sys/log/full/include/log/log.h`` header file.
+.. doxygenfile:: full/include/log/log.h
diff --git a/docs/os/modules/shell/shell.rst b/docs/os/modules/shell/shell.rst
index 3f2fea2b0c..cd17b8e1f6 100644
--- a/docs/os/modules/shell/shell.rst
+++ b/docs/os/modules/shell/shell.rst
@@ -13,6 +13,10 @@ The shell uses the OS default event queue for shell events and runs in
the context of the main task. An application can, optionally, specify a
dedicated event queue for the shell to use.
+.. contents::
+ :local:
+ :depth: 2
+
The ``sys/shell`` package implements the shell. To use the shell you
must:
@@ -372,3 +376,8 @@ The functions available in this OS feature are:
| dule.html>`_ | |
| _ | |
+------------+----------------+
+
+API
+---
+
+.. doxygenfile:: sys/shell/include/shell/shell.h
diff --git a/docs/os/modules/shell/shell_cmd_register.rst b/docs/os/modules/shell/shell_cmd_register.rst
deleted file mode 100644
index 03e132aaba..0000000000
--- a/docs/os/modules/shell/shell_cmd_register.rst
+++ /dev/null
@@ -1,55 +0,0 @@
-shell\_cmd\_register
-----------------------
-
-.. code-block:: console
-
- int shell_cmd_register(struct shell_cmd *sc)
-
-Registers a handler for incoming shell commands. The function adds the
-shell command to the ``compat`` module.
-
-The caller must initialize the ``shell_cmd`` structure with the command
-name and the pointer to the command handler. The caller must not free
-the memory for the command name string because the shell keeps a
-reference to the memory for internal use.
-
-Arguments
-^^^^^^^^^
-
-+-------------+-----------------------------------------------------------------------+
-| Arguments | Description |
-+=============+=======================================================================+
-| ``sc`` | Pointer to the ``shell_cmd`` structure for the command to register. |
-+-------------+-----------------------------------------------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Returns 0 on success.
-
-Non-zero on failure. #### Notes
-
-The ``SHELL_MAX_COMPAT_COMMANDS`` syscfg setting specifies the maximum
-number of shell commands that the ``compat`` module supports. This
-function aborts if the number of handlers registered exceeds this limit.
-You can increase the value for this setting.
-
-Example
-^^^^^^^^^^^^^^^^^^^
-
-
-.. code-block:: console
-
- static int fs_ls_cmd(int argc, char **argv);
-
- static struct shell_cmd fs_ls_struct = {
- .sc_cmd = "ls",
- .sc_cmd_func = fs_ls_cmd
- };
-
- void
- fs_cli_init(void)
- {
- shell_cmd_register(&fs_ls_struct);
- ....
- }
diff --git a/docs/os/modules/shell/shell_evq_set.rst b/docs/os/modules/shell/shell_evq_set.rst
deleted file mode 100644
index 920fbc6ce7..0000000000
--- a/docs/os/modules/shell/shell_evq_set.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-shell\_evq\_set
-----------------
-
-.. code:: c
-
- void shell_evq_set(struct os_eventq *evq)
-
-Specifies an event queue to use for shell events. You must create the
-event queue and the task to process events from the queue before calling
-this function.
-
-By default, shell uses the OS default event queue and executes in the
-context of the main task that Mynewt creates.
-
-Arguments
-^^^^^^^^^
-
-+-------------+-------------------------------------------------------+
-| Arguments | Description |
-+=============+=======================================================+
-| ``evq`` | Pointer to the event queue to use for shell events. |
-+-------------+-------------------------------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-None
-
-Notes
-^^^^^
diff --git a/docs/os/modules/shell/shell_nlip_input_register.rst b/docs/os/modules/shell/shell_nlip_input_register.rst
deleted file mode 100644
index 266424dd78..0000000000
--- a/docs/os/modules/shell/shell_nlip_input_register.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-shell\_nlip\_input\_register
-------------------------------
-
-.. code-block:: console
-
- int shell_nlip_input_register(shell_nlip_input_func_t nf, void *arg)
-
-Registers a handler for incoming newtmgr messages. The shell receives
-the incoming data stream from the UART, and when it detects a NLIP
-frame, decodes the datagram, and calls the registered handler,\ ``nf``.
-
-The handler function is of type
-``int (*shell_nlip_input_func_t)(struct os_mbuf *m, void *arg)``. The
-shell passes the incoming newtmgr message stored in a ``os_mbuf`` and
-the ``arg`` that was passed to the ``shell_nlip_input_register()``
-function as arguments to the handler function.
-
-Arguments
-^^^^^^^^^
-
-+-------------+---------------------------------------------------------------------+
-| Arguments | Description |
-+=============+=====================================================================+
-| ``nf`` | Handler for incoming newtmgr datagrams. |
-+-------------+---------------------------------------------------------------------+
-| ``arg`` | Argument that is passed to this handler, along with the datagram. |
-+-------------+---------------------------------------------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Returns 0 on success.
-
-Non-zero on failure.
-
-Example
-^^^^^^^
-
-.. code-block:: console
-
- static int
- nmgr_shell_in(struct os_mbuf *m, void *arg)
- {
- ....
- }
-
- int
- nmgr_task_init(uint8_t prio, os_stack_t *stack_ptr, uint16_t stack_len)
- {
- int rc;
- ....
- rc = shell_nlip_input_register(nmgr_shell_in,
- (void *) &g_nmgr_shell_transport);
- if (rc != 0) {
- goto err;
- }
- ....
- }
diff --git a/docs/os/modules/shell/shell_nlip_output.rst b/docs/os/modules/shell/shell_nlip_output.rst
deleted file mode 100644
index 0317e55723..0000000000
--- a/docs/os/modules/shell/shell_nlip_output.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-shell\_nlip\_output
----------------------
-
-.. code-block:: console
-
- int shell_nlip_output(struct os_mbuf *m)
-
-Queues the outgoing newtmgr message for transmission. The shell encodes
-the message, frames the message into packets, and writes each packet to
-the console.
-
-Arguments
-^^^^^^^^^
-
-+-------------+-----------------------------------+
-| Arguments | Description |
-+=============+===================================+
-| m | os\_mbuf containing the message |
-+-------------+-----------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Returns 0 on success.
-
-Non-zero on failure.
-
-Example
-^^^^^^^
-
-.. code-block:: console
-
- static int
- nmgr_shell_out(struct nmgr_transport *nt, struct os_mbuf *m)
- {
- int rc;
-
- rc = shell_nlip_output(m);
- if (rc != 0) {
- goto err;
- }
-
- return (0);
- err:
- return (rc);
- }
diff --git a/docs/os/modules/shell/shell_register.rst b/docs/os/modules/shell/shell_register.rst
deleted file mode 100644
index 3626473bff..0000000000
--- a/docs/os/modules/shell/shell_register.rst
+++ /dev/null
@@ -1,131 +0,0 @@
-shell\_register
------------------
-
-.. code:: c
-
- shell_register(const char *module_name, const struct shell_cmd *commands)
-
-Registers a module named ``module_name`` and the commands that the
-module supports. The caller must allocate and not free the memory for
-the ``module_name`` and the array of ``shell_cmd`` structures for the
-command. The shell keeps references to these structures for internal
-use.
-
-Each entry in the ``commands`` array specifies a shell command for the
-module and must be initialized with the command name and the pointer to
-the command handler. The help field is initialized with help information
-if the command supports help.
-
-Arguments
-^^^^^^^^^
-
-+--------------+----------------+
-| Arguments | Description |
-+==============+================+
-| ``module_nam | Character |
-| e`` | string of the |
-| | module name. |
-+--------------+----------------+
-| ``commands`` | Array of |
-| | ``shell_cmd`` |
-| | structures |
-| | that specify |
-| | the commands |
-| | for the |
-| | module. The |
-| | ``sc_cmd``, |
-| | ``sc_cmd_func` |
-| | `, |
-| | and ``help`` |
-| | fields in the |
-| | last entry |
-| | must be set to |
-| | NULL to |
-| | indicate the |
-| | last entry in |
-| | the array. |
-+--------------+----------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Returns 0 on success.
-
-Non-zero on failure. #### Notes The ``SHELL_MAX_MODULES`` syscfg setting
-specifies the maximum number of modules the shell supports. This
-function aborts if the number of registered modules exceeds this limit.
-You can increase the value for this setting. #### Example This is an
-example excerpt that shows how to declare and initialize the data
-structures for a module and some shell commands for the. Variables for
-the help structures are only declared and intialized if the
-``SHELL_CMD_HELP`` syscfg setting is enabled. The ``sample_commands``
-array of ``shell_cmd`` structures are declared and initialized. The
-fields in the last entry are all set to NULL to indicate the last entry
-in the array.
-
-.. code:: c
-
- static int shell_sample_tasks_display_cmd(int argc, char **argv);
- static int shell_sample_mpool_display_cmd(int argc, char **argv);
-
- static const char *sample_module = "sample_module";
-
- /*
- * Initialize param and command help information if SHELL_CMD_HELP
- * is enabled.
- */
-
- #if MYNEWT_VAL(SHELL_CMD_HELP)
- static const struct shell_param sample_tasks_params[] = {
- {"", "task name"},
- {NULL, NULL}
- };
-
- static const struct shell_cmd_help sample_tasks_help = {
- .summary = "show tasks info",
- .usage = NULL,
- .params = sample_tasks_params,
- };
-
- static const struct shell_param sample_mpool_params[] = {
- {"", "mpool name"},
- {NULL, NULL}
- };
-
- static const struct shell_cmd_help sample_mpool_help = {
- .summary = "show system mpool",
- .usage = NULL,
- .params = sample_mpool_params,
- };
-
- #endif
-
- /*
- * Initialize an array of shell_cmd structures for the commands
- * in the os module.
- */
- static const struct shell_cmd sample_module_commands[] = {
- {
- .sc_cmd = "tasks",
- .sc_cmd_func = shell_sample_tasks_display_cmd,
- #if MYNEWT_VAL(SHELL_CMD_HELP)
- .help = &sample_tasks_help,
- #endif
- },
- {
- .sc_cmd = "sample_mpool",
- .sc_cmd_func = shell_sample_mpool_display_cmd,
- #if MYNEWT_VAL(SHELL_CMD_HELP)
- .help = &sample_mpool_help,
- #endif
- },
- { NULL, NULL, NULL },
- };
-
-
- void
- sample_module_init(void)
- {
- shell_register(sample_module, sample_module_commands);
-
- }
diff --git a/docs/os/modules/shell/shell_register_app_cmd_handler.rst b/docs/os/modules/shell/shell_register_app_cmd_handler.rst
deleted file mode 100644
index ca396f8080..0000000000
--- a/docs/os/modules/shell/shell_register_app_cmd_handler.rst
+++ /dev/null
@@ -1,52 +0,0 @@
-shell\_register\_app\_cmd\_handler
-------------------------------------
-
-.. code:: c
-
- void shell_register_app_cmd_handler(struct shell_cmd *sc)
-
-Registers a command handler as an application command handler. The shell
-calls the application command handler, if one is set, when it receives a
-command that does not have a handler registered. When you implement a
-shell command for your application, you can register an application
-command handler. You do not need to define a command name for the shell
-to use to lookup an application command handler.
-
-For example, if your application uses the ``shell_cmd_register()``
-function to register a handler for the ``myapp_cmd`` shell command and
-the handler supports two subcommands, ``subcmd1`` and \`\ ``subcmd2``,
-then you would enter ``myapp_cmd subcmd1`` and ``myapp_cmd subcmd2`` in
-the shell to run the commands. If you register the handler as an
-application command handler, then you would enter ``subcmd1`` and
-``subcmd2`` in the shell to run the commands. #### Arguments
-
-+-------------+----------------------------------------------------------------------+
-| Arguments | Description |
-+=============+======================================================================+
-| ``sc`` | Pointer to the ``shell_cmd`` structure for the comman to register. |
-+-------------+----------------------------------------------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-None
-
-Example
-^^^^^^^
-
-.. code:: c
-
-
- static int myapp_cmd_handler(int argc, char **argv);
-
- static struct shell_cmd myapp_cmd = {
- .sc_cmd = "",
- .sc_cmd_func = myapp_cmd_handler
- };
-
- void
- myapp_shell_init(void)
- {
- shell_register_app_cmd_handler(&myapp_cmd);
- ....
- }
diff --git a/docs/os/modules/shell/shell_register_default_module.rst b/docs/os/modules/shell/shell_register_default_module.rst
deleted file mode 100644
index 51055b9934..0000000000
--- a/docs/os/modules/shell/shell_register_default_module.rst
+++ /dev/null
@@ -1,52 +0,0 @@
-shell\_register\_default\_module
----------------------------------
-
-.. code:: c
-
- void shell_register_default_module(const char *name)
-
-Sets the module named ``name`` as the default module. You can enter the
-commands for the default module without entering the module name in the
-shell.
-
-Arguments
-^^^^^^^^^
-
-+-------------+--------------------------------------------+
-| Arguments | Description |
-+=============+============================================+
-| ``name`` | Name of the module to set as the default |
-+-------------+--------------------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-None
-
-Example
-^^^^^^^
-
-.. code:: c
-
- static int sample_cmd_handler(int argc, char **argv);
-
- static const char * module_name = "sample_module";
- static const struct shell_cmd sample_cmds[] = {
- {
- .sc_cmd = "mycmd",
- .sc_cmd_func = sample_cmd_handler,
- },
- {NULL, NULL, NULL},
- };
-
- int main (void)
- {
-
-
- /* Register the module and the commands for the module */
- shell_register(module_name, sample_cmds);
-
- /* Set this module as the default module */
- shell_register_default_module(module_name);
-
- }
diff --git a/docs/os/modules/stats/stats.rst b/docs/os/modules/stats/stats.rst
index 61de22b490..54023530b8 100644
--- a/docs/os/modules/stats/stats.rst
+++ b/docs/os/modules/stats/stats.rst
@@ -10,6 +10,10 @@ maintenance, and usage monitoring.
By creating and registering your statistics, they are automatically
included in the Newtmgr shell and console APIs.
+.. contents::
+ :local:
+ :depth: 2
+
Implementation Details
~~~~~~~~~~~~~~~~~~~~~~
@@ -281,3 +285,8 @@ each device separately.
This works identically to the example above, except you would need to
register each one separately with a unique name. The stats system will
not let two sections be entered with the same name.
+
+API
+~~~
+
+.. doxygenfile:: full/include/stats/stats.h
diff --git a/docs/os/modules/testutil/test_assert.rst b/docs/os/modules/testutil/test_assert.rst
deleted file mode 100644
index add28e10dd..0000000000
--- a/docs/os/modules/testutil/test_assert.rst
+++ /dev/null
@@ -1,129 +0,0 @@
-TEST\_ASSERT
--------------
-
-.. code-block:: console
-
- TEST_ASSERT(expression, fail_msg, ...)
-
-.. code-block:: console
-
- TEST_ASSERT_FATAL(expression, fail_msg, ...)
-
-Asserts that the specified condition is true. If the expression is true,
-nothing gets reported. *fail\_msg* will be printed out if the expression
-is false. The expression argument is mandatory; the rest are optional.
-The fail\_msg argument is a printf format string which specifies how the
-remaining arguments are parsed.
-
-``TEST_ASSERT_FATAL()`` causes the current test case to be aborted, if
-expression fails.
-
-Arguments
-^^^^^^^^^
-
-+--------------+----------------+
-| Arguments | Description |
-+==============+================+
-| expression | Condition |
-| | being tested. |
-| | If it fails, |
-| | test is |
-| | considered a |
-| | failure, and a |
-| | message is |
-| | printed out. |
-+--------------+----------------+
-| fail\_msg | Pointer to C |
-| | string that |
-| | contains a |
-| | format string |
-| | that follows |
-| | the same |
-| | specifications |
-| | as format in |
-| | printf. |
-+--------------+----------------+
-| ... | Depending on |
-| | the format |
-| | string, the |
-| | function may |
-| | expect either |
-| | a sequence of |
-| | additional |
-| | arguments to |
-| | be used to |
-| | replace a |
-| | format |
-| | specifier in |
-| | the format |
-| | string or a |
-| | variable |
-| | arguments |
-| | list. va\_list |
-| | is a special |
-| | type defined |
-| | in in |
-| | stdarg.h. |
-+--------------+----------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-None
-
-Notes
-^^^^^
-
-While ``console_printf``, with its well understood formatting options in
-C, is more convenient and easy on the eyes than the raw output of
-``console_write``, the associated code size is considerably larger.
-
-Example
-^^^^^^^
-
-Example #1:
-
-.. code-block:: console
-
- TEST_CASE(config_test_insert)
- {
- int rc;
-
- rc = conf_register(&config_test_handler);
- TEST_ASSERT(rc == 0);
- }
-
-Example #2:
-
-.. code-block:: console
-
- TEST_CASE(nffs_test_unlink)
- {
- int rc;
-
- ....
-
- rc = nffs_format(nffs_area_descs);
- TEST_ASSERT_FATAL(rc == 0);
-
- ....
- }
-
-Example #3:
-
-.. code-block:: console
-
-
- static int
- cbmem_test_case_1_walk(struct cbmem *cbmem, struct cbmem_entry_hdr *hdr,
- void *arg)
- {
- ....
-
- rc = cbmem_read(cbmem, hdr, &actual, 0, sizeof(actual));
- TEST_ASSERT_FATAL(rc == 1, "Couldn't read 1 byte from cbmem");
- TEST_ASSERT_FATAL(actual == expected,
- "Actual doesn't equal expected (%d = %d)", actual, expected);
-
- ....
- }
diff --git a/docs/os/modules/testutil/test_case.rst b/docs/os/modules/testutil/test_case.rst
deleted file mode 100644
index 3b8d886f08..0000000000
--- a/docs/os/modules/testutil/test_case.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-TEST\_CASE
-------------
-
-.. code-block:: console
-
- TEST_CASE(test_case_name)
-
-Defines a test case function with the following type
-``int test_case_name(void)``. This can then be called from regression
-test's ``TEST_SUITE()`` function.
-
-Arguments
-^^^^^^^^^
-
-+--------------------+-------------------------------------------------+
-| Arguments | Description |
-+====================+=================================================+
-| test\_case\_name | Used as the function name for this test case. |
-+--------------------+-------------------------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Return value is 0 if the test case passed; nonzero if it failed.
-Generally, the return code is not used. It is expected that the case
-will pass/fail with tests done using ``TEST_ASSERT()``.
-
-Example
-^^^^^^^
-
-.. code-block:: console
-
- TEST_CASE(config_test_insert)
- {
- ....
- }
diff --git a/docs/os/modules/testutil/test_decl.rst b/docs/os/modules/testutil/test_decl.rst
deleted file mode 100644
index fe0daf9245..0000000000
--- a/docs/os/modules/testutil/test_decl.rst
+++ /dev/null
@@ -1,37 +0,0 @@
-TEST\_CASE\_DECL
-------------------
-
-.. code-block:: console
-
- TEST_CASE_DECL(test_case_name)
-
-Declares a test case function with the following type
-``int test_case_name(void)``. This can then be called from regression
-test's ``TEST_SUITE()`` function. This is only required if the test case
-function exists in a different file than the test suite. This will allow
-the test suite to find the test case
-
-Arguments
-^^^^^^^^^
-
-+--------------------+-------------------------------------------------+
-| Arguments | Description |
-+====================+=================================================+
-| test\_case\_name | Used as the function name for this test case. |
-+--------------------+-------------------------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Return value is 0 if the test case passed; nonzero if it failed.
-Generally, the return code is not used. It is expected that the case
-will pass/fail with tests done using ``TEST_ASSERT()``.
-
-Example file ``test_cases.h``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: console
-
- TEST_CASE_DECL(test_case_1)
- TEST_CASE_DECL(test_case_2)
- TEST_CASE_DECL(test_case_3)
diff --git a/docs/os/modules/testutil/test_pass.rst b/docs/os/modules/testutil/test_pass.rst
deleted file mode 100644
index 7913a4b7e6..0000000000
--- a/docs/os/modules/testutil/test_pass.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-TEST\_PASS
-------------
-
-.. code-block:: console
-
- TEST_PASS(msg, ...)
-
-Reports a success result for the current test. This function is not
-normally needed, as all successful tests automatically write an empty
-pass result at completion. It is only needed when the success result
-report should contain text. The msg argument is a printf format string
-which specifies how the remaining arguments are parsed. The result file
-produced by this function contains the following text:
-
-.. code-block:: console
-
- |<file>:<line-number>| manual pass
- <msg>
-
-Arguments
-^^^^^^^^^
-
-+--------------+----------------+
-| Arguments | Description |
-+==============+================+
-| msg | This is a |
-| | printf format |
-| | string which |
-| | specifies how |
-| | the remaining |
-| | arguments are |
-| | parsed |
-+--------------+----------------+
-| ... | Depending on |
-| | the format |
-| | string, the |
-| | function may |
-| | expect either |
-| | a sequence of |
-| | additional |
-| | arguments to |
-| | be used to |
-| | replace a |
-| | format |
-| | specifier in |
-| | the format |
-| | string or a |
-| | variable |
-| | arguments |
-| | list. va\_list |
-| | is a special |
-| | type defined |
-| | in in |
-| | stdarg.h. |
-+--------------+----------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-None
-
-Notes
-^^^^^
-
-After this function is called, the remainder of the test case is not
-executed.
diff --git a/docs/os/modules/testutil/test_suite.rst b/docs/os/modules/testutil/test_suite.rst
deleted file mode 100644
index e929745c9e..0000000000
--- a/docs/os/modules/testutil/test_suite.rst
+++ /dev/null
@@ -1,42 +0,0 @@
-TEST\_SUITE
--------------
-
-.. code-block:: console
-
- TEST_SUITE(test_suite_name)
-
-Declares a test suite function with the following type
-``int test_suite_name(void)``. This can then be called from either
-*project/test*, or from main routine for package specific regression
-test.
-
-Arguments
-^^^^^^^^^
-
-+---------------------+--------------------------------------------------+
-| Arguments | Description |
-+=====================+==================================================+
-| test\_suite\_name | Used as the function name for this test suite. |
-+---------------------+--------------------------------------------------+
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Return value is 0 if the test suite passed; nonzero if it failed.
-Generally, the return code is not used. It is expected that the
-individual test cases will pass/fail with tests done using
-``TEST_ASSERT()``.
-
-Example
-^^^^^^^
-
-.. code-block:: console
-
- TEST_SUITE(os_sem_test_suite)
- {
- os_sem_test_basic();
- os_sem_test_case_1();
- os_sem_test_case_2();
- os_sem_test_case_3();
- os_sem_test_case_4();
- }
diff --git a/docs/os/modules/testutil/testutil.rst b/docs/os/modules/testutil/testutil.rst
index 29dac00d95..68cab0e3da 100644
--- a/docs/os/modules/testutil/testutil.rst
+++ b/docs/os/modules/testutil/testutil.rst
@@ -6,6 +6,10 @@ specifying test cases and recording test results.
You would use it to build regression tests for your library.
+.. contents::
+ :local:
+ :depth: 2
+
Description
~~~~~~~~~~~
@@ -68,7 +72,7 @@ or by including a call to your test suite from
Example
~~~~~~~
-`This Tutorial <../../tutorials/unit_test.html>`__ shows how to create a
+`This Tutorial </tutorials/other/unit_test.html>`_ shows how to create a
test suite for a Mynewt package.
Data structures
@@ -100,58 +104,9 @@ Data structures
The global ``tu_config`` struct contains all the testutil package's
settings. This should be populated before ``tu_init()`` is called.
-List of Functions
-~~~~~~~~~~~~~~~~~
-
-The functions, and macros available in ``testutil`` are:
-
-+------------+----------------+
-| Function | Description |
-+============+================+
-| `tu\_init | Initializes |
-| <tu_init.m | the test |
-| d>`__ | framework |
-| | according to |
-| | the contents |
-| | of the |
-| | tu\_config |
-| | struct. |
-+------------+----------------+
-| `TEST\_ASS | Asserts that |
-| ERT <test_ | the specified |
-| assert.html> | condition is |
-| `__ | true. |
-+------------+----------------+
-| `TEST\_PAS | Reports a |
-| S <test_pa | success result |
-| ss.html>`__ | for the |
-| | current test. |
-+------------+----------------+
-| `TEST\_SUI | Declares a |
-| TE <test_s | test suite |
-| uite.html>`_ | function. |
-| _ | |
-+------------+----------------+
-| `TEST\_CAS | Defines a test |
-| E <test_ca | case function. |
-| se.html>`__ | |
-+------------+----------------+
-| `TEST\_CAS | Declares a |
-| E\_DECL <t | test case |
-| est_decl.m | function. his |
-| d>`__ | is only |
-| | required if |
-| | the test case |
-| | function |
-| | exists in a |
-| | different file |
-| | than the test |
-| | suite. |
-+------------+----------------+
-| `tu\_resta | This function |
-| rt <tu_res | is used when a |
-| tart.html>`_ | system reset |
-| _ | is necessary |
-| | to proceed |
-| | with testing. |
-+------------+----------------+
+API
+~~~~
+
+.. doxygengroup:: OSTestutil
+ :members:
+ :content-only:
diff --git a/docs/os/modules/testutil/tu_init.rst b/docs/os/modules/testutil/tu_init.rst
deleted file mode 100644
index 93a7d2ff19..0000000000
--- a/docs/os/modules/testutil/tu_init.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-tu\_init
----------
-
-.. code-block:: console
-
- int tu_init(void)
-
-Initializes the test framework according to the contents of the
-``tu_config`` struct. This function must be called before any tests are
-run.
-
-Arguments
-^^^^^^^^^
-
-N/A
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Returns 0 on success; nonzero on failure.
-
-Example
-^^^^^^^
-
-Here's an example of stand-alone code which allows the user to execute
-regression tests for sys/config package only.
-
-.. code-block:: console
-
- #ifdef PKG_TEST
-
- int
- main(int argc, char **argv)
- {
- tu_config.tc_print_results = 1;
- tu_init();
-
- conf_init();
- config_test_all();
-
- return tu_any_failed;
- }
-
- #endif
diff --git a/docs/os/modules/testutil/tu_restart.rst b/docs/os/modules/testutil/tu_restart.rst
deleted file mode 100644
index a08a62e61a..0000000000
--- a/docs/os/modules/testutil/tu_restart.rst
+++ /dev/null
@@ -1,41 +0,0 @@
-tu\_restart
--------------
-
-.. code-block:: console
-
- void tu_restart(void)
-
-This function is used when a system reset is necessary to proceed with
-testing. For example, the OS is designed to run forever once started, so
-a test which creates several OS tasks and then starts the OS has no
-means of completing. This function, when called from such a test,
-gracefully ends the current test case and proceeds to the next test
-case.
-
-The particulars of this function depend on whether it is called from a
-simulated environment. In a simulated environment, this function uses a
-``longjmp()`` call to break out of the current test case.
-
-Arguments
-^^^^^^^^^
-
-N/A
-
-Returned values
-^^^^^^^^^^^^^^^
-
-Returns 0 on success; nonzero on failure.
-
-Example
-^^^^^^^
-
-.. code-block:: console
-
- void
- os_test_restart(void)
- {
- ....
-
- tu_restart();
- }
- #endif
diff --git a/docs/os/os_user_guide.rst b/docs/os/os_user_guide.rst
index ca7dfc4afb..8d615ca46f 100644
--- a/docs/os/os_user_guide.rst
+++ b/docs/os/os_user_guide.rst
@@ -17,7 +17,6 @@ OS User Guide
JSON <modules/json/json>
Statistics <modules/stats/stats>
Logs <modules/logs/logs>
- System Configuration and Initialization <modules/sysinitconfig/sysinitconfig>
This guide provides comprehensive information about Mynewt OS, the
real-time operating system for embedded systems. It is intended both for
diff --git a/encoding/json/include/json/json.h b/encoding/json/include/json/json.h
index afeebd81bd..0ff7819f87 100644
--- a/encoding/json/include/json/json.h
+++ b/encoding/json/include/json/json.h
@@ -38,9 +38,6 @@ extern "C" {
#define JSON_VALUE_TYPE_ARRAY (4)
#define JSON_VALUE_TYPE_OBJECT (5)
-/**
- * For encode. The contents of a JSON value to encode.
- */
struct json_value {
uint8_t jv_pad1;
uint8_t jv_type;
@@ -251,3 +248,9 @@ int json_read_array(struct json_buffer *, const struct json_array_t *);
#endif
#endif /* _JSON_H_ */
+
+/**
+ * @} OSEncoding
+ * @} OSJSON
+ */
+
diff --git a/test/testutil/include/testutil/testutil.h b/test/testutil/include/testutil/testutil.h
index 67f7fa17d2..f4637e7ed0 100644
--- a/test/testutil/include/testutil/testutil.h
+++ b/test/testutil/include/testutil/testutil.h
@@ -30,6 +30,13 @@
extern "C" {
#endif
+/**
+ * @addtogroup OSSystem
+ * @{
+ * @defgroup OSTestutil Test Utilities
+ * @{
+ */
+
/*
* General execution flow of test suites and callbacks (more to come XXX)
*
@@ -315,3 +322,9 @@ TEST_SUITE_##suite_name(void); \
#endif
#endif
+
+/**
+ * @} OSTestutil
+ * @} OSSys
+ */
+
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services