From f3804f4e23d1d66b5eba3ae4358ee26d00f0ab22 Mon Sep 17 00:00:00 2001
From: Jason Kridner <jkridner@beagleboard.org>
Date: Mon, 29 Aug 2022 22:07:20 -0400
Subject: [PATCH] pru-cookbook: fix critical error
---
books/pru-cookbook/03details/details.rst | 25 ++++++++++++++----------
books/pru-cookbook/04debug/debug.rst | 4 +++-
2 files changed, 18 insertions(+), 11 deletions(-)
diff --git a/books/pru-cookbook/03details/details.rst b/books/pru-cookbook/03details/details.rst
index 78ece373..d7ba2058 100644
--- a/books/pru-cookbook/03details/details.rst
+++ b/books/pru-cookbook/03details/details.rst
@@ -10,15 +10,13 @@ compile code and also start and stop the PRUs.
The following are resources used in this chapter.
-Resources
-~~~~~~~~~~
-
-* `PRU Code Generation Tools - Compiler <http://software-dl.ti.com/codegen/esd/cgt_ai_64_lic_sw/PRU/2.1.5/ti_cgt_pru_2.1.5_armlinuxa8hf_busybox_installer.sh>`_
-* `PRU Software Support Package <http://git.ti.com/pru-software-support-package>`_
-* `PRU Optimizing C/C++ Compiler <http://www.ti.com/lit/ug/spruhv7b/spruhv7b.pdf>`_
-* `PRU Assembly Language Tools <http://www.ti.com/lit/ug/spruhv6b/spruhv6b.pdf>`_
-* `AM572x Technical Reference Manual <http://www.ti.com/lit/pdf/spruhz6l>`_ (AI)
-* `AM335x Technical Reference Manual <http://www.ti.com/lit/pdf/spruh73>`_ (All others)
+.. note::
+ * `PRU Code Generation Tools - Compiler <http://software-dl.ti.com/codegen/esd/cgt_ai_64_lic_sw/PRU/2.1.5/ti_cgt_pru_2.1.5_armlinuxa8hf_busybox_installer.sh>`_
+ * `PRU Software Support Package <http://git.ti.com/pru-software-support-package>`_
+ * `PRU Optimizing C/C++ Compiler <http://www.ti.com/lit/ug/spruhv7b/spruhv7b.pdf>`_
+ * `PRU Assembly Language Tools <http://www.ti.com/lit/ug/spruhv6b/spruhv6b.pdf>`_
+ * `AM572x Technical Reference Manual <http://www.ti.com/lit/pdf/spruhz6l>`_ (AI)
+ * `AM335x Technical Reference Manual <http://www.ti.com/lit/pdf/spruh73>`_ (All others)
Getting Example Code
=====================
@@ -37,6 +35,13 @@ It's all on a GitHub repository.
bone$ git clone https://github.com/MarkAYoder/PRUCookbook.git
+
+.. note::
+ #TODO#: There needs to be a code-only repo that is validated against the documentation
+ code to be identical for specific version. The version needs to be noted in the
+ documentation.
+
+
Compiling with clpru and lnkpru
================================
@@ -255,7 +260,7 @@ It's easy, if you already have ``TARGET`` set up:
- Starting PRU 0
start
-See :ref:`../04debug/debug.html#_dmesg_hw,dmesg -Hw` to see how to tell if the PRU
+See :ref:`_dmesg_hw` to see how to tell if the PRU
is stopped.
This assumes ``TARGET`` is set to the PRU you are using.
diff --git a/books/pru-cookbook/04debug/debug.rst b/books/pru-cookbook/04debug/debug.rst
index a9f0edfb..7887b96c 100644
--- a/books/pru-cookbook/04debug/debug.rst
+++ b/books/pru-cookbook/04debug/debug.rst
@@ -47,6 +47,8 @@ see what's happening.
Another useful tool that let's you see the contents of the registers and
RAM is discussed in :ref:`debug_prudebug`.
+.. _dmesg_hw:
+
dmesg Hw
=========
@@ -529,4 +531,4 @@ copyright.c
.. rubric:: Footnotes
-.. [#debug1] FTDI images are from the BeagleBone Cookbook http://shop.oreilly.com/product/0636920033899.do
\ No newline at end of file
+.. [#debug1] FTDI images are from the BeagleBone Cookbook http://shop.oreilly.com/product/0636920033899.do
--
GitLab