Skip to content

Commit 81635dc

Browse files
StaticRocketStaticRocket
committed
fix: set language for a few code-blocks
Fix and tag the code-blocks to cut down on parsing and attribute errors. Also, it adds syntax highlighting and some rudimentary syntax checking for these examples. Signed-off-by: Randolph Sapp <[email protected]>
1 parent 6095c1e commit 81635dc

File tree

7 files changed

+104
-104
lines changed

7 files changed

+104
-104
lines changed

‎source/buildroot/Overview.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ to github repository.
4444
Repository structure
4545
====================
4646

47-
.. code-block::
47+
.. code-block:: text
4848
4949
buildroot-external-TI
5050
├── external.desc

‎source/debian/Building_Debian_Image.rst‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ The scripts are hosted at https://github.com/TexasInstruments/ti-bdebstrap
3131

3232
To clone the repository, run:
3333

34-
.. code-block::
34+
.. code-block:: console
3535
3636
git clone https://github.com/TexasInstruments/ti-bdebstrap.git
3737
3838
3939
Repository Structure
4040
--------------------
4141

42-
.. code-block::
42+
.. code-block:: text
4343
4444
ti-bdebstrap
4545
├── build.sh
@@ -108,13 +108,13 @@ Install Pre-requisite Packages
108108

109109
First, ensure that your repositories are up-to-date:
110110

111-
.. code-block::
111+
.. code-block:: console
112112
113113
sudo apt update
114114
115115
Then, install packages as follows:
116116

117-
.. code-block::
117+
.. code-block:: console
118118
119119
sudo apt install -y \
120120
pigz expect pv \
@@ -128,13 +128,13 @@ Then, install packages as follows:
128128
129129
Ensure that all packages were correctly installed using:
130130

131-
.. code-block::
131+
.. code-block:: console
132132
133133
sudo apt install --fix-broken
134134
135135
Finally, install ``toml-cli`` and ``yamllint``:
136136

137-
.. code-block::
137+
.. code-block:: console
138138
139139
pip3 install toml-cli
140140
pip3 install yamllint
@@ -182,7 +182,7 @@ Building the Image
182182

183183
To build an image, you need to run the :file:`build.sh` script:
184184

185-
.. code-block::
185+
.. code-block:: console
186186
187187
sudo ./build.sh <build-name>
188188
@@ -192,7 +192,7 @@ After the build, the RootFS, Boot partition and bsp_sources are stored in :file:
192192

193193
Example: to build for ``trixie-am62pxx-evm``, run:
194194

195-
.. code-block::
195+
.. code-block:: console
196196
197197
sudo ./build.sh trixie-am62pxx-evm
198198
@@ -205,13 +205,13 @@ This step can be skipped if you do not want to share the generated Image with an
205205

206206
To generate an SD Card Image with the generated RootFS and Boot partition files, run:
207207

208-
.. code-block::
208+
.. code-block:: console
209209
210210
./create-wic.sh <build-name>
211211
212212
Example: to build for ``trixie-am62pxx-evm``, run:
213213

214-
.. code-block::
214+
.. code-block:: console
215215
216216
./create-wic.sh trixie-am62pxx-evm
217217
@@ -222,13 +222,13 @@ Flash Image to SD Card using Script
222222

223223
To flash the SD card without generating a wic image, use the :file:`create-sdcard.sh` script. Run it using the below command and follow with the prompts.
224224

225-
.. code-block::
225+
.. code-block:: console
226226
227227
sudo ./create-sdcard.sh <build-name>
228228
229229
For example, if the image is ``trixie-am62pxx-evm``, type:
230230

231-
.. code-block::
231+
.. code-block:: console
232232
233233
sudo ./create-sdcard.sh trixie-am62pxx-evm
234234

‎source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/pru-icssg-pwm.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@ The PRU PWM Linux kernel driver depends on the PRU-ICSS kernel driver. So
3636
the following kernel Kconfig options should be enabled to use the PRU PWM
3737
module.
3838

39-
.. code::
39+
.. code-block:: menuconfig
4040
41-
Device Drivers --->
42-
SOC (System On Chip) specific Drivers --->
43-
[*] TI SOC drivers support --->
44-
<M> TI PRU-ICSS Subsystem Platform drivers
41+
Device Drivers --->
42+
SOC (System On Chip) specific Drivers --->
43+
[*] TI SOC drivers support --->
44+
<M> TI PRU-ICSS Subsystem Platform drivers
4545
46-
Device Drivers --->
47-
Pulse-Width Modulation (PWM) Support --->
48-
PRU-ICSS PWM support
46+
Device Drivers --->
47+
Pulse-Width Modulation (PWM) Support --->
48+
PRU-ICSS PWM support
4949
5050
5151
.. rubric:: PRU PWM Sysfs Usage

‎source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/pru-sw-uart.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@ in PRU R30 and R31.
4242

4343
For details please refer to the kernel device tree binding doc:
4444

45-
.. code::
45+
.. code-block:: text
4646
47-
Documentation/devicetree/bindings/serial/pru-suart.txt
47+
Documentation/devicetree/bindings/serial/pru-suart.txt
4848
4949
The Processor SDK Linux kernel also provides an device tree example for
5050
Beaglebone Black:
5151

52-
.. code::
52+
.. code-block:: text
5353
54-
arch/arm/boot/dts/am335x-boneblack-prusuart.dts
54+
arch/arm/boot/dts/am335x-boneblack-prusuart.dts
5555
5656
This example defines the 3 UARTs on PRU0 without hardware flow control and 3
5757
UARTs on PRU1 with hardware flow control. All the UART pins are available on
@@ -64,16 +64,16 @@ The PRU Soft UART Linux kernel driver depends on the PRU-ICSS kernel driver. So
6464
the following kernel Kconfig options should be enabled to use the PRU Soft UART
6565
module.
6666

67-
.. code::
67+
.. code-block:: menuconfig
6868
69-
Device Drivers --->
70-
SOC (System On Chip) specific Drivers --->
71-
[*] TI SOC drivers support --->
72-
<M> TI PRU-ICSS Subsystem Platform drivers
69+
Device Drivers --->
70+
SOC (System On Chip) specific Drivers --->
71+
[*] TI SOC drivers support --->
72+
<M> TI PRU-ICSS Subsystem Platform drivers
7373
74-
Device Drivers --->
75-
Character devices --->
76-
Serial drivers --->
77-
<M> TI PRU Software UART suppor
74+
Device Drivers --->
75+
Character devices --->
76+
Serial drivers --->
77+
<M> TI PRU Software UART suppor
7878
7979

‎source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/pruss-uart.rst‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,45 +30,45 @@ The PRUSS UART Linux kernel driver depends on the PRU-ICSS kernel drivers. So
3030
the following kernel Kconfig options should be enabled to use the PRUSS UART
3131
module.
3232

33-
.. code::
33+
.. code-block:: menuconfig
3434
35-
Device Drivers --->
36-
SOC (System On Chip) specific Drivers --->
37-
[*] TI SOC drivers support --->
38-
<M> TI PRU-ICSS Subsystem Platform drivers
35+
Device Drivers --->
36+
SOC (System On Chip) specific Drivers --->
37+
[*] TI SOC drivers support --->
38+
<M> TI PRU-ICSS Subsystem Platform drivers
3939
40-
Device Drivers --->
41-
IRQ chip support --->
42-
<M> TI PRU-ICSS Interrupt Controller
40+
Device Drivers --->
41+
IRQ chip support --->
42+
<M> TI PRU-ICSS Interrupt Controller
4343
44-
Device Drivers --->
45-
Character devices --->
46-
Serial drivers --->
47-
<M> TI PRU-ICSS UART support
44+
Device Drivers --->
45+
Character devices --->
46+
Serial drivers --->
47+
<M> TI PRU-ICSS UART support
4848
4949
5050
.. rubric:: Example DT configuration
5151

5252
From am335x-evmsk.dts
5353

54-
.. code::
54+
.. code-block:: dts
5555
56-
&pruss_uart {
57-
prus = <&pru0>;
58-
ti,pru-interrupt-map = <0 6 2 2>;
59-
pinctrl-names = "default";
60-
pinctrl-0 = <&prussuart_pins>;
61-
status = "okay";
62-
};
56+
&pruss_uart {
57+
prus = <&pru0>;
58+
ti,pru-interrupt-map = <0 6 2 2>;
59+
pinctrl-names = "default";
60+
pinctrl-0 = <&prussuart_pins>;
61+
status = "okay";
62+
};
6363
6464
6565
.. rubric:: Driver Usage
6666

6767
Once the driver is probed, kernel log shows the following message.
6868

69-
.. code::
69+
.. code-block:: dmesg
7070
71-
[ 28.617700] 4a328000.serial: ttyS1 at MMIO 0x4a328000 (irq = 77, base_baud = 12000000) is a 16550A
71+
[ 28.617700] 4a328000.serial: ttyS1 at MMIO 0x4a328000 (irq = 77, base_baud = 12000000) is a 16550A
7272
7373
Therefore the device node /dev/ttyS1 is associated to the PRUSS UART, user
7474
space application can read/write this serial port. For detalls please refer

0 commit comments

Comments
 (0)