Skip to content

Commit bd73073

Browse files
kartbennashif
authored andcommitted
doc: samples: net: mqtt: improve formatting
use code literal formatting for KConfig identifiers Signed-off-by: Benjamin Cabé <[email protected]>
1 parent f6db733 commit bd73073

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

samples/net/cloud/mqtt_azure/README.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,23 @@ copied from `<https://github.com/Azure/azure-iot-sdk-c/blob/master/certs/certs.c
3838
Configure the following Kconfig options based on your Azure Cloud IoT Hub
3939
in your own overlay config file:
4040

41-
- SAMPLE_CLOUD_AZURE_USERNAME - Username field use::
41+
- ``SAMPLE_CLOUD_AZURE_USERNAME`` - Username field use::
4242

4343
{iothubhostname}/{device_id}/?api-version=2018-06-30,
4444

4545
where ``{iothubhostname}`` is the full CName of the IoT hub.
4646

47-
- SAMPLE_CLOUD_AZURE_PASSWORD - Password field, use an SAS token.
48-
- SAMPLE_CLOUD_AZURE_CLIENT_ID - ClientId field, use the deviceId.
49-
- SAMPLE_CLOUD_AZURE_HOSTNAME - IoT hub hostname
50-
- SAMPLE_CLOUD_AZURE_SERVER_ADDR - IP address of the Azure MQTT broker
51-
- SAMPLE_CLOUD_AZURE_SERVER_PORT - Port number of the Azure MQTT broker
47+
- ``SAMPLE_CLOUD_AZURE_PASSWORD`` - Password field, use an SAS token.
48+
- ``SAMPLE_CLOUD_AZURE_CLIENT_ID`` - ClientId field, use the deviceId.
49+
- ``SAMPLE_CLOUD_AZURE_HOSTNAME`` - IoT hub hostname
50+
- ``SAMPLE_CLOUD_AZURE_SERVER_ADDR`` - IP address of the Azure MQTT broker
51+
- ``SAMPLE_CLOUD_AZURE_SERVER_PORT`` - Port number of the Azure MQTT broker
5252

5353
You'll also need to set these Kconfig options if you're running
5454
the sample behind a proxy:
5555

56-
- SAMPLE_SOCKS_ADDR - IP address of SOCKS5 Proxy server
57-
- SAMPLE_SOCKS_PORT - Port number of SOCKS5 Proxy server
56+
- ``SAMPLE_SOCKS_ADDR`` - IP address of SOCKS5 Proxy server
57+
- ``SAMPLE_SOCKS_PORT`` - Port number of SOCKS5 Proxy server
5858

5959
On your Linux host computer, open a terminal window, locate the source code
6060
of this sample application (i.e., :zephyr_file:`samples/net/cloud/mqtt_azure`) and type:

0 commit comments

Comments
 (0)