Skip to content

Commit dec5999

Browse files
jorgenmkrlubos
authored andcommitted
net: Align Kconfig names in doc and code
NCSDK-34359. Signed-off-by: Jorgen Kvalvaag <[email protected]>
1 parent 3fc19a0 commit dec5999

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

include/net/azure_iot_hub_dps.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ struct azure_iot_hub_dps_config {
5252

5353
/** Registration ID to use in the provisioning request.
5454
* If the pointer is NULL or the length is zero, the compile-time option
55-
* ``CONFIG_AZURE_IOT_HUB_REG_ID`` is used.
55+
* ``CONFIG_AZURE_IOT_HUB_DPS_REG_ID`` is used.
5656
*/
5757
struct azure_iot_hub_buf reg_id;
5858
};

samples/net/coap_client/README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Overview
3030

3131
The CoAP Client sample performs the following actions:
3232

33-
#. Connect to the configured public CoAP test server (specified by the Kconfig option :ref:`CONFIG_COAP_SERVER_HOSTNAME <CONFIG_COAP_SERVER_HOSTNAME>`).
34-
#. Send periodic GET request for a test resource (specified by the Kconfig option :ref:`CONFIG_COAP_RESOURCE <CONFIG_COAP_RESOURCE>`) that is available on the server.
33+
#. Connect to the configured public CoAP test server (specified by the Kconfig option :ref:`CONFIG_COAP_SAMPLE_SERVER_HOSTNAME <CONFIG_COAP_SAMPLE_SERVER_HOSTNAME>`).
34+
#. Send periodic GET request for a test resource (specified by the Kconfig option :ref:`CONFIG_COAP_SAMPLE_RESOURCE <CONFIG_COAP_SAMPLE_RESOURCE>`) that is available on the server.
3535
#. Display the received data about the resource on a terminal emulator.
3636

3737
The public CoAP server used in this sample is Californium CoAP server (``coap://californium.eclipseprojects.io:5683``).
@@ -40,7 +40,7 @@ This server runs Eclipse Californium, which is an open source implementation of
4040
This sample uses the resource **obs** (Californium observable resource) in the communication between the CoAP client and the public CoAP server.
4141
The communication follows the standard request/response pattern and is based on the change in the state of the value of the resource.
4242
The sample queries one resource at a time.
43-
To configure other resources, use the Kconfig option :ref:`CONFIG_COAP_RESOURCE <CONFIG_COAP_RESOURCE>`.
43+
To configure other resources, use the Kconfig option :ref:`CONFIG_COAP_SAMPLE_RESOURCE <CONFIG_COAP_SAMPLE_RESOURCE>`.
4444

4545
Configuration
4646
*************
@@ -52,19 +52,19 @@ Configuration options
5252

5353
Check and configure the following Kconfig options in the :file:`coap_client/prj.conf` file:
5454

55-
.. _CONFIG_COAP_RESOURCE:
55+
.. _CONFIG_COAP_SAMPLE_RESOURCE:
5656

57-
CONFIG_COAP_RESOURCE - CoAP resource configuration
57+
CONFIG_COAP_SAMPLE_RESOURCE - CoAP resource configuration
5858
This option sets the CoAP resource. Default is Californium observable resource.
5959

60-
.. _CONFIG_COAP_SERVER_HOSTNAME:
60+
.. _CONFIG_COAP_SAMPLE_SERVER_HOSTNAME:
6161

62-
CONFIG_COAP_SERVER_HOSTNAME - CoAP server hostname
62+
CONFIG_COAP_SAMPLE_SERVER_HOSTNAME - CoAP server hostname
6363
This option sets the CoAP server hostname. Default is ``californium.eclipseprojects.io``.
6464

65-
.. _CONFIG_COAP_SERVER_PORT:
65+
.. _CONFIG_COAP_SAMPLE_SERVER_PORT:
6666

67-
CONFIG_COAP_SERVER_PORT - CoAP server port
67+
CONFIG_COAP_SAMPLE_SERVER_PORT - CoAP server port
6868
This option sets the port for the CoAP server. Default is ``5683``.
6969

7070
.. include:: /includes/wifi_credentials_shell.txt

0 commit comments

Comments
 (0)