This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git
The following commit(s) were added to refs/heads/master by this push:
new f4a8906db docs: Fix the layout in multiple .rst files for the PDF
output
f4a8906db is described below
commit f4a8906dbdb6cda39f661e5bba972b4f43103f47
Author: Wojciech Pietraszewski <[email protected]>
AuthorDate: Tue Sep 24 11:07:00 2024 +0200
docs: Fix the layout in multiple .rst files for the PDF output
Fixes formatting issues in the following categories:
- Device Management
- Image Manager
---
docs/os/modules/devmgmt/customize_newtmgr.rst | 319 ++------------------------
docs/os/modules/devmgmt/oicmgr.rst | 120 +---------
docs/os/modules/imgmgr/imgmgr.rst | 54 ++---
docs/os/modules/imgmgr/imgmgr_module_init.rst | 12 -
4 files changed, 51 insertions(+), 454 deletions(-)
diff --git a/docs/os/modules/devmgmt/customize_newtmgr.rst
b/docs/os/modules/devmgmt/customize_newtmgr.rst
index cb0900c5f..feeec30d0 100644
--- a/docs/os/modules/devmgmt/customize_newtmgr.rst
+++ b/docs/os/modules/devmgmt/customize_newtmgr.rst
@@ -13,309 +13,24 @@ command.
The system level management groups are listed in following table:
-.. raw:: html
++--------------------------+---------------------------------------------------------+-----------------------+
+| Management Group | newtmgr Commands
| Package |
++==========================+=========================================================+=======================+
+| MGMT\_GROUP\_ID\_DEFAULT | ``echo`` ``taskstat`` ``mpstat`` ``datetime``
``reset`` | mgmt/newtmgr/nmgr\_os |
++--------------------------+---------------------------------------------------------+-----------------------+
+| MGMT\_GROUP\_ID\_IMAGE | ``image``
| mgmt/imgmgr |
++--------------------------+---------------------------------------------------------+-----------------------+
+| MGMT\_GROUP\_ID\_STATS | ``stat``
| sys/stats |
++--------------------------+---------------------------------------------------------+-----------------------+
+| MGMT\_GROUP\_ID\_CONFIG | ``config``
| sys/config |
++--------------------------+---------------------------------------------------------+-----------------------+
+| MGMT\_GROUP\_ID\_LOGS | ``log``
| sys/log |
++--------------------------+---------------------------------------------------------+-----------------------+
+| MGMT\_GROUP\_ID\_CRASH | ``crash``
| test/crash\_test |
++--------------------------+---------------------------------------------------------+-----------------------+
+| MGMT\_GROUP\_ID\_RUNTEST | ``run``
| test/runtest |
++--------------------------+---------------------------------------------------------+-----------------------+
- <table style="width:90%" align="center">
-
-.. raw:: html
-
- <td>
-
-Management Group
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-newtmgr Commands
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-Package
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-MGMT\_GROUP\_ID\_DEFAULT
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-``echo`` ``taskstat`` ``mpstat`` ``datetime`` ``reset``
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-mgmt/newtmgr/nmgr\_os
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-MGMT\_GROUP\_ID\_IMAGE
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-``image``
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-mgmt/imgmgr
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-MGMT\_GROUP\_ID\_STATS
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-``stat``
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-sys/stats
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-MGMT\_GROUP\_ID\_CONFIG
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-``config``
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-sys/config
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-MGMT\_GROUP\_ID\_LOGS
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-``log``
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-sys/log
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-MGMT\_GROUP\_ID\_CRASH
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-``crash``
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-test/crash\_test
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-MGMT\_GROUP\_ID\_RUNTEST
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-``run``
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-test/runtest
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- </table>
Both newtmgr and ocimgr process the MGMT\_GROUP\_ID\_DEFAULT commands by
default. You can also use mgmt to add user defined management group
diff --git a/docs/os/modules/devmgmt/oicmgr.rst
b/docs/os/modules/devmgmt/oicmgr.rst
index 649225583..a3acf3d00 100644
--- a/docs/os/modules/devmgmt/oicmgr.rst
+++ b/docs/os/modules/devmgmt/oicmgr.rst
@@ -5,117 +5,15 @@ Apache Mynewt includes support for the OIC interoperability
standard
through the ``oicmgr`` framework. Mynewt defines and exposes oicmgr as
an OIC Server resource with the following identity and properties:
-.. raw:: html
-
- <table style="width:50%" align="center">
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-**URI**
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-/omgr
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <tr>
-
-.. raw:: html
-
- <td>
-
-**Resource Type**\ (rt)
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-x.mynewt.nmgr
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <td>
-
-**Interface**\ (if)
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-oic.if\_rw (default), oic.if.baseline
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- <td>
-
-**Discoverable**
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- <td>
-
-Yes
-
-.. raw:: html
-
- </td>
-
-.. raw:: html
-
- </tr>
-
-.. raw:: html
-
- </table>
++-----------------------+--------------------------------------+
+| **URI** | /omgr |
++-----------------------+--------------------------------------+
+| **Resource Type** (rt)| x.mynewt.nmgr |
++-----------------------+--------------------------------------+
+| **Interface** (if) | oic.if_rw (default), oic.if.baseline |
++-----------------------+--------------------------------------+
+| **Discoverable** | Yes |
++-----------------------+--------------------------------------+
The newtmgr application tool uses CoAP (Constrained ApplicationProtocol)
requests to send commands to oicmgr.
It sends a CoAP request for **/omgr** as follows:
diff --git a/docs/os/modules/imgmgr/imgmgr.rst
b/docs/os/modules/imgmgr/imgmgr.rst
index aec396e4f..bd2995121 100644
--- a/docs/os/modules/imgmgr/imgmgr.rst
+++ b/docs/os/modules/imgmgr/imgmgr.rst
@@ -35,38 +35,34 @@ Note that commands accessing filesystems (next boot target,
file
upload/download) will not be available unless project includes
filesystem implementation.
-Data structures
-~~~~~~~~~~~~~~~
-
-N/A.
List of Functions
~~~~~~~~~~~~~~~~~
The functions available in imgmgr are:
-+-------------+----------------+
-| Function | Description |
-+=============+================+
-| `imgr\_ver | Parses |
-| \_parse` | character |
-| | string |
-| | containing |
-| | specified |
-| | image version |
-| | number and |
-| | writes that to |
-| | given |
-| | image\_version |
-| | struct. |
-+-------------+----------------+
-| `imgr\_ver | Takes version |
-| \_str` | string from |
-| | specified |
-| | image\_version |
-| | struct and |
-| | formats it |
-| | into a |
-| | printable |
-| | string. |
-+-------------+----------------+
++------------------------------+----------------+
+| Function | Description |
++==============================+================+
+| :c:func:`imgr_ver_parse` | Parses |
+| | character |
+| | string |
+| | containing |
+| | specified |
+| | image version |
+| | number and |
+| | writes that to |
+| | given |
+| | image\_version |
+| | struct. |
++------------------------------+----------------+
+| :c:func:`imgr_ver_str` | Takes version |
+| | string from |
+| | specified |
+| | image\_version |
+| | struct and |
+| | formats it |
+| | into a |
+| | printable |
+| | string. |
++------------------------------+----------------+
diff --git a/docs/os/modules/imgmgr/imgmgr_module_init.rst
b/docs/os/modules/imgmgr/imgmgr_module_init.rst
index a626ab585..fe03685a4 100644
--- a/docs/os/modules/imgmgr/imgmgr_module_init.rst
+++ b/docs/os/modules/imgmgr/imgmgr_module_init.rst
@@ -10,15 +10,3 @@ Registers the image manager commands with the ``mgmt``
package.
``sysinit()`` automatically calls this function during system
initialization.
-Arguments
-^^^^^^^^^
-
-N/A
-
-Returned values
-^^^^^^^^^^^^^^^
-
-N/A
-
-Notes
-^^^^^
