Skip to content

Commit 71c16d3

Browse files
nordic-marenordic-hani
authored andcommitted
More improvements and fixes to documentation
Signed-off-by: Markus Rekdal <markus.rekdal@nordicsemi.no>
1 parent 12a1c1c commit 71c16d3

File tree

7 files changed

+15
-16
lines changed

7 files changed

+15
-16
lines changed

doc/API_documentation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ SoftBank FOTA OS layer
2626
.. doxygengroup:: sb_fota_os
2727
:members:
2828

29-
Softbank FOTA build-time settings
29+
SoftBank FOTA build-time settings
3030
*********************************
3131

3232
.. doxygengroup:: sb_fota_settings

doc/CHANGELOG.rst

+3-4
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
Changelog
44
#########
55

6-
FOTA library and sample applications for SoftBank.
6+
FOTA library and sample application for SoftBank.
77
All notable changes to this project are documented in this file.
88

9-
For a full list of Softbank FOTA add-on releases, related nRF Connect SDK, modem firmware versions, and supported REST API host, view the following table:
9+
For a full list of SoftBank FOTA add-on releases, related nRF Connect SDK, modem firmware versions, and supported REST API host, view the following table:
1010

1111
+-------------------+------------------+--------------------------+------------------------------------+
1212
| |addon| version | |NCS| version | Modem firmware version | REST API host |
@@ -46,7 +46,7 @@ Changes
4646
Renamed events such as ``FOTA_EVENT_DOWNLOADING`` to ``SB_FOTA_EVENT_DOWNLOADING``
4747
* The library now schedules work on its internal queue instead of the syswork queue (this avoids potential blocking of the syswork queue).
4848
* Removed ``SB_FOTA_EVENT_REBOOT_PENDING``.
49-
Reboot is not needed to apply the modem update.
49+
Rebooting is not needed to apply the modem update.
5050
* Removed the dependency on the `LTE Link Control`_ library.
5151
This makes it simpler to integrate the SoftBank FOTA library into applications that do not use the Link Controller library by default, such as the `Serial LTE modem`_ application.
5252

@@ -117,4 +117,3 @@ Changes
117117
=======
118118

119119
* First release that is used to complete SBM IOT certification test.
120-

doc/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:local:
88
:depth: 2
99

10-
SoftBank FOTA library is a binary library that has been developed as an |NCS| add-on.
10+
The SoftBank FOTA library is a binary library that has been developed as an |NCS| add-on.
1111
This library periodically checks `nRF Connect for Cloud`_ for modem firmware updates.
1212
If there is an applicable update, the SoftBank FOTA library downloads and installs it.
1313

doc/sample.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ Configuration
4747
Configuration options
4848
=====================
4949

50-
During development, it is recommended to see when the next update is scheduled, you can use the verbose version of the library (``CONFIG_SB_FOTA_LOG = y``).
51-
For production, it is recommended to use the non-verbose version of the library (``CONFIG_SB_FOTA_LOG = n``), in order to save memory.
50+
During development, it is recommended to use the verbose version of the library (``CONFIG_SB_FOTA_LOG=y``) in order to be able to see when the next update is scheduled.
51+
For production, it is recommended to use the non-verbose version of the library (``CONFIG_SB_FOTA_LOG=n``), in order to save memory.
5252

5353
Configuration files
5454
===================
@@ -64,11 +64,11 @@ To configure modem trace output, see `Sending traces over UART on an nRF91 Serie
6464
Building and running
6565
********************
6666

67-
This sample can be found under the ``samples`` folder in the |addon| structure.
67+
This sample can be found under the ``sample`` folder in the |addon| structure.
6868

6969
You can build this sample as a firmware image for a board target with the \*/ns variant (see the Requirements section above).
7070
In such cases, the sample has Cortex-M Security Extensions (CMSE) enabled and separates the firmware between Non-Secure Processing Environment (NSPE) and Secure Processing Environment (SPE).
71-
Because of this, it automatically includes the Trusted Firmware-M (TF-M).
71+
Because of this, it automatically includes Trusted Firmware-M (TF-M).
7272

7373
To build the sample, follow the instructions in `Building an application`_ for your preferred building environment. See also `Programming an application`_ for programming steps and `Testing and optimization`_ for general information about testing and debugging in the nRF Connect SDK.
7474

@@ -116,13 +116,13 @@ After programming the sample and all prerequisites to the development kit, test
116116
Troubleshooting
117117
===============
118118

119-
If you do not see any output log such as "... Next update check in..." and only see "SoftBank FOTA client started", check that you have linked the alternative verbose library ``CONFIG_SB_FOTA_LOG = y``.
119+
If you do not see any output logs such as "... Next update check in..." and only see "SoftBank FOTA client started", check that you have linked the verbose library ``CONFIG_SB_FOTA_LOG = y``.
120120
By default, the library does not use LOG.
121121

122122
Dependencies
123123
************
124124

125-
It uses the following `sdk-nrfxlib`_ library:
125+
This sample uses the following `sdk-nrfxlib`_ library:
126126

127127
* `Modem library <nrfxlib_nrf_modem_>`_
128128

lib/bin/sb_fota/include/sb_fota.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
/**
88
* @file sb_fota.h
99
*
10-
* @brief Public APIs for the Softbank FOTA client.
11-
* @defgroup sb_fota Softbank FOTA client
10+
* @brief Public APIs for the SoftBank FOTA client.
11+
* @defgroup sb_fota SoftBank FOTA client
1212
* @{
1313
*/
1414

lib/bin/sb_fota/include/sb_fota_os.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* @file sb_fota_os.h
99
*
10-
* @defgroup sb_fota_os Softbank FOTA OS layer
10+
* @defgroup sb_fota_os SoftBank FOTA OS layer
1111
* @{
1212
*/
1313

lib/bin/sb_fota/include/sb_fota_settings.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
/**
88
* @file sb_fota_settings.h
99
*
10-
* @defgroup sb_fota_settings Softbank FOTA build time settings
10+
* @defgroup sb_fota_settings SoftBank FOTA build time settings
1111
* @{
1212
*/
1313

0 commit comments

Comments
 (0)