Skip to content

Commit dea2bcb

Browse files
kartbennashif
authored andcommitted
samples: net: tftp: doc: formatting/spelling clean up
misc fixes to ensure proper formatting and spelling of the TFTP sample README Signed-off-by: Benjamin Cabé <[email protected]>
1 parent f6d0383 commit dea2bcb

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

samples/net/tftp_client/README.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,27 +56,34 @@ Build the tftp-client sample application for :ref:`native_sim <native_sim>` like
5656
Download and run a TFTP server (like TFTPd), then create file1.bin (with data) and newfile.bin.
5757

5858
Please note that default IP server address is 192.0.2.2 and default port is 69.
59-
To specify an IP server address and/or port, change configurations in ``prj.conf``::
59+
To specify an IP server address and/or port, change these configurations in ``prj.conf``:
60+
61+
.. code-block:: cfg
6062
6163
CONFIG_TFTP_APP_SERVER="10.0.0.10"
6264
CONFIG_TFTP_APP_PORT="70"
6365
6466
To connect to server using hostname, enable DNS resolver by changing these two
65-
configurations in ``prj.conf``::
67+
configurations in ``prj.conf``:
68+
69+
.. code-block:: cfg
6670
6771
CONFIG_DNS_RESOLVER=y
6872
CONFIG_TFTP_APP_SERVER="my-tftp-server.org"
6973
7074
Sample output
7175
==================================
7276

73-
Sample run on native_sim platform with TFTP server on host machine
74-
Launch net-setup.sh in net-tools
75-
.. code-block:: console
77+
This sample can be run on :ref:`native_sim<native_sim>` while running a TFTP server on the host
78+
machine.
79+
80+
Launch :command:`net-setup.sh` in net-tools:
81+
82+
.. code-block:: bash
7683
7784
net-setup.sh
7885
79-
.. code-block:: console
86+
.. code-block:: bash
8087
8188
<inf> net_config: Initializing network
8289
<inf> net_config: IPv4 address: 192.0.2.1

0 commit comments

Comments
 (0)