Skip to content

Commit 2faa6f5

Browse files
laurenmurphyx64nashif
authored andcommitted
samples: misc fixes to docs
Changes console blocks in hello_world and magic_wand tflite-micro samples to Kconfig blocks to match content. Fixes typos in some networking samples so that code blocks display instead of being hidden. Fixes path to litex-vexriscv-tflite.resc. Signed-off-by: Lauren Murphy <[email protected]>
1 parent 1f27849 commit 2faa6f5

File tree

5 files changed

+8
-10
lines changed

5 files changed

+8
-10
lines changed

samples/modules/tflite-micro/hello_world/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ It is recommended that you copy and modify one of the two TensorFlow
7171
samples when creating your own TensorFlow project. To build with
7272
TensorFlow, you must enable the below Kconfig options in your :file:`prj.conf`:
7373

74-
.. code-block:: console
74+
.. code-block:: kconfig
7575
7676
CONFIG_CPLUSPLUS=y
7777
CONFIG_NEWLIB_LIBC=y

samples/modules/tflite-micro/magic_wand/README.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ start the emulator:
4040

4141
.. code-block:: console
4242
43-
renode -e "set zephyr_elf @./build/zephyr/zephyr.elf; s @./renode/litex-vexriscv-tflite.resc"
43+
renode -e "set zephyr_elf @./build/zephyr/zephyr.elf; s @./samples/modules/tflite-micro/magic_wand/renode/litex-vexriscv-tflite.resc"
4444
4545
.. _download and install Renode 1.12 or higher as a package:
4646
https://github.com/renode/renode/releases/
@@ -102,11 +102,9 @@ Modifying Sample for Your Own Project
102102

103103
It is recommended that you copy and modify one of the two TensorFlow
104104
samples when creating your own TensorFlow project. To build with
105-
TensorFlow, you must enable the below Kconfig options in your :file:`prj.conf`.
105+
TensorFlow, you must enable the below Kconfig options in your :file:`prj.conf`:
106106

107-
:file:`prj.conf`:
108-
109-
.. code-block:: console
107+
.. code-block:: kconfig
110108
111109
CONFIG_CPLUSPLUS=y
112110
CONFIG_NEWLIB_LIBC=y

samples/net/cloud/google_iot_mqtt/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ from the Google Cloud Platform itself:
5353
From these values, the config values can be set using the following
5454
template:
5555

56-
.. code-block: kconfig
56+
.. code-block:: kconfig
5757
5858
CLOUD_CLIENT_ID="projects/PROJECT_ID/locations/REGION/registries/REGISTRY_ID/devices/DEVICE_ID"
5959
CLOUD_AUDIENCE="PROJECT_ID"

samples/net/mqtt_publisher/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ same host as the MQTT broker.
160160
To start a proxy server, ``ssh`` can be used.
161161
Use the following command to run it on your host with the default port:
162162

163-
.. code-block: console
163+
.. code-block:: console
164164
165165
$ ssh -N -D 0.0.0.0:1080 localhost
166166

samples/net/sockets/echo_client/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,13 +124,13 @@ with the default port:
124124

125125
For IPv4 proxy server:
126126

127-
.. code-block: console
127+
.. code-block:: console
128128
129129
$ ssh -N -D 0.0.0.0:1080 localhost
130130
131131
For IPv6 proxy server:
132132

133-
.. code-block: console
133+
.. code-block:: console
134134
135135
$ ssh -N -D [::]:1080 localhost
136136

0 commit comments

Comments
 (0)