From 0d0092e582926caa76f23d72dc58001a35d7489b Mon Sep 17 00:00:00 2001
From: Deepak Khatri <lorforlinux@beagleboard.org>
Date: Tue, 8 Nov 2022 21:05:36 +0530
Subject: [PATCH] Fix spelling mistakes and formatting
---
boards/pocketbeagle/original/ch04.rst | 4 ++--
books/pru-cookbook/05blocks/blocks.rst | 2 +-
books/pru-cookbook/07more/more.rst | 2 +-
intro/contribution/rst-cheat-sheet.rst | 12 ++++++------
projects/bb-config/features.rst | 1 +
projects/simppru/io.rst | 2 +-
projects/simppru/usage-simppru-console.rst | 2 +-
projects/simppru/usage-simppru.rst | 2 +-
8 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/boards/pocketbeagle/original/ch04.rst b/boards/pocketbeagle/original/ch04.rst
index 2e3c7f0c..bd6d9010 100644
--- a/boards/pocketbeagle/original/ch04.rst
+++ b/boards/pocketbeagle/original/ch04.rst
@@ -91,9 +91,9 @@ interfaces that make up the board.
| UART | 3 UARTs accessible with 2 enabled by |
| | default |
+-----------------------+---------------------------------------------+
- | I2C | 2 I2C buses enabled by default |
+ | I2C | 2 I2C buses enabled by default |
+-----------------------+---------------------------------------------+
- | SPI | 2 SPI buses with single chip selects |
+ | SPI | 2 SPI buses with single chip selects |
| | enabled by default |
+-----------------------+---------------------------------------------+
| PWM | 4 Pulse Width Modulation outputs accessible |
diff --git a/books/pru-cookbook/05blocks/blocks.rst b/books/pru-cookbook/05blocks/blocks.rst
index 21fa4096..84c6785d 100644
--- a/books/pru-cookbook/05blocks/blocks.rst
+++ b/books/pru-cookbook/05blocks/blocks.rst
@@ -986,7 +986,7 @@ Discussion
The figure below shows the two PRUs are synchronized, though there is some extra
overhead in the process so the period is longer.
-.. figure:: figures/pwm8_prus_synced.png
+.. figure:: figures/pwm8_prus_sycned.png
:align: center
:alt: pwm8.pru0 PRUs synced
diff --git a/books/pru-cookbook/07more/more.rst b/books/pru-cookbook/07more/more.rst
index 5f24de08..a9a71735 100644
--- a/books/pru-cookbook/07more/more.rst
+++ b/books/pru-cookbook/07more/more.rst
@@ -409,7 +409,7 @@ Discussion
| | `PRU Optimizing C/C++ Compiler, v2.2, User's Guide <http://www.ti.com/lit/ug/spruhv7b/spruhv7b.pdf>`_ |
| | shows how to use `xout()`. The first argument, 14, says to do a direct transfer to PRU 1. If the |
| | first argument is 10, 11 or 12, the data is transferred to one of three scratchpad memories that |
- | | PRU 1 can access later. The second argument, 5, says to start transferring with register ``r5`` |
+ | | PRU 1 can access later. The second argument, 5, says to start transferring with register ``r5`` |
| | and use as many registers as needed to transfer all of ``dmemBuf``. The third argument, 0, |
| | says to not use remapping. (See the User's Guide for details.) |
| | The final argument is the data to be transferred. |
diff --git a/intro/contribution/rst-cheat-sheet.rst b/intro/contribution/rst-cheat-sheet.rst
index 4f472270..1b4ef2e8 100644
--- a/intro/contribution/rst-cheat-sheet.rst
+++ b/intro/contribution/rst-cheat-sheet.rst
@@ -19,12 +19,12 @@ Text formatting
With asterisk you can fomat the text as italic & bold,
-1. Sinlge asterisk (``*``) like ``*emphasis*`` gives you *italic text*
-2. Double asterisk (``**``) like ``**strong emphasis**`` gives you **blod text**
+1. Single asterisk (``*``) like ``*emphasis*`` gives you *italic text*
+2. Double asterisk (``**``) like ``**strong emphasis**`` gives you **bold text**
With backquote character (`) you can format the text as link & inline literal.
-1. See `Links`_ section on how single backquote can be used to create a link linke `this <www.beagleboard.org>`_.
+1. See `Links`_ section on how single backquote can be used to create a link like `this <www.beagleboard.org>`_.
2. With double back quotes before and after text you can easily create ``inline lierals``.
.. note::
@@ -62,7 +62,7 @@ more) the at least of the heading text, for example:
.. annotations::
- <1> Length of heading sybol ``#`` is smaller than the content above.
+ <1> Length of heading symbol ``#`` is smaller than the content above.
<2> Shows the correct way of setting the document title (H1) with ``#``.
@@ -206,7 +206,7 @@ You can also include a label to the link as shown below.
this will be rendered as `BeagleBoard.org <www.beagleboard.org>`_.
Implicit Links
-***************
+==============
These are basically the headings inside the rst page which can
be used as a link to that section within document.
@@ -218,7 +218,7 @@ be used as a link to that section within document.
when rendered it becomes `Links`_
Explicit link
-*************
+==============
These are special links you can assign to a specific part of the document and reference anywhere
in the project unlike implicit links which can be used only within the document they are defined.
diff --git a/projects/bb-config/features.rst b/projects/bb-config/features.rst
index 855f1948..af219324 100644
--- a/projects/bb-config/features.rst
+++ b/projects/bb-config/features.rst
@@ -89,6 +89,7 @@ Internet Sharing and Client Config
- Note: You'll have to configure your host Following is an example script:
.. code:: bash
+
echo 1 > /proc/sys/net/ipv4/ip_forward
iptables --table nat --append POSTROUTING --out-interface wlp4s0 -j MASQUERADE
iptables --append FORWARD --in-interface wlp4s0 -j ACCEPT
diff --git a/projects/simppru/io.rst b/projects/simppru/io.rst
index 421fc76b..39e490ea 100644
--- a/projects/simppru/io.rst
+++ b/projects/simppru/io.rst
@@ -160,7 +160,7 @@ Syntax
``start_counter()``
Parameters
-^^^^^^^^^
+^^^^^^^^^^
- n/a
diff --git a/projects/simppru/usage-simppru-console.rst b/projects/simppru/usage-simppru-console.rst
index 9099c880..5366b918 100644
--- a/projects/simppru/usage-simppru-console.rst
+++ b/projects/simppru/usage-simppru-console.rst
@@ -1,5 +1,5 @@
Usage(simppru-console)
-=====
+=======================
simppru-console is a console app, it can be used to send/receive message
to the PRU using RPMSG, and also start/stop the PRU. It is built to
diff --git a/projects/simppru/usage-simppru.rst b/projects/simppru/usage-simppru.rst
index 0d8fcf18..f5e8b3e9 100644
--- a/projects/simppru/usage-simppru.rst
+++ b/projects/simppru/usage-simppru.rst
@@ -1,5 +1,5 @@
Usage(simppru)
-=====
+===============
.. code:: bash
--
GitLab