fix: all explicit markup errors

Address all of the following errors: Explicit markup ends without a blank line; unexpected unindent. Signed-off-by: Randolph Sapp <[email protected]>
TexasInstruments · Dec 5, 2024 · 06ed530 · 06ed530
1 parent 124a604
commit 06ed530
Show file tree

Hide file tree

Showing 14 changed files with 34 additions and 46 deletions.
diff --git a/source/rtos/DSP_Software/DSP_Debug_and_Trace/_UIA.rst b/source/rtos/DSP_Software/DSP_Debug_and_Trace/_UIA.rst
@@ -14,6 +14,7 @@ In a multi core system, data from all cores are correlated to a single
 timeline.
 
 .. Image:: /images/SA.png
+
 Unified Instrumentation Architecture (UIA)
 ------------------------------------------
 

diff --git a/source/rtos/Documentation_Tarball.rst b/source/rtos/Documentation_Tarball.rst
@@ -7,7 +7,6 @@ Please click the link below to download a snapshot of the entire documentation i
 .. raw:: html
 
     <a href="processor-sdk-rtos-docs.tar.gz">Download processor-sdk-rtos-docs.tar.gz</a>
-|
 
 Unpack the tarball using the command below:
 

diff --git a/source/rtos/Examples_and_Demonstrations/_SimpleLink_WiFi_Demo.rst b/source/rtos/Examples_and_Demonstrations/_SimpleLink_WiFi_Demo.rst
@@ -28,9 +28,12 @@ Hardware
 -  Blue wires between CC3120 BP and AMIC110 ICE
 -  Serial UART cable (provided in EVM kit)
 -  Connection Diagram
-.. Image:: /images/sl_wifi_demo_connection.jpg
+
+   .. Image:: /images/sl_wifi_demo_connection.jpg
+
 -  Picture of connected EVMs
-.. Image:: /images/sl_wifi_demo_connected.jpg
+
+   .. Image:: /images/sl_wifi_demo_connected.jpg
 
 Software
 
@@ -205,11 +208,14 @@ To load and run SimpleLink WiFi Plugin Demo:
 #. Send the bootloader_boot_uart_a8host_debug.bin under
    pdk_<platform>_<version>/packages/ti/starterware/binary/bootloader/bin/am335x-evm/gcc
    using the XMODEM.
-.. Image:: /images/sl_uart_boot_1st.jpg
+
+   .. Image:: /images/sl_uart_boot_1st.jpg
+
 #. Upon completion,  then send the network_terminal.bin under
    processor_sdk_rtos_<platform>_<version>/demos/simplelink-wifi-demo/bin/am335x/a8/debug
    using the XMODEM.
-.. Image:: /images/sl_uart_boot_2nd.jpg
+
+   .. Image:: /images/sl_uart_boot_2nd.jpg
 
 Now the network terminal demo will run and print progress through the UART.
 

diff --git a/source/rtos/FAQ.rst b/source/rtos/FAQ.rst
@@ -179,7 +179,6 @@ Components <Overview.html#top-level-makefile>`__.
 .. note::
    The SDK offers command line build for all the components. CCS projects
    are only supported for DSP libraries and PDK driver examples.
-|
 
 .. rubric:: Step 5: Generate and Run Peripheral Driver Examples
    :name: step-5-generate-and-run-peripheral-driver-examples
@@ -596,7 +595,6 @@ described in the article
    board name which is used to configure the board. When creating a custom
    platform if you don`t intend to use an EEPROM then we recommend removing
    code corresponding to Board_getIDInfo in your board library
-|
 
 .. rubric:: Do I need to do any post processing on PDK files generated
    by Pin Mux Utility?

diff --git a/source/rtos/How_to_Guides/Host/Setup/_Setup_CCS_for_EVM_and_PSDK_RTOS.rst b/source/rtos/How_to_Guides/Host/Setup/_Setup_CCS_for_EVM_and_PSDK_RTOS.rst
@@ -19,7 +19,7 @@ After installing the Processor-SDK RTOS, start CCS and it will
 automatically detect the newly installed components (*products*):
 
 .. Image:: /images/CCS-discovered-products.png
-|
+
 CCS and SDK installed in different directories
 """""""""""""""""""""""""""""""""""""""""""""""
 
@@ -35,7 +35,7 @@ Go to product preference
 From CCS, select "Window -> Preferences":
 
 .. Image:: /images/CCS-GP57x-EVM-Custom-Preferences.png
-|
+
 Enter path to SDK
 '''''''''''''''''''
 
@@ -44,23 +44,22 @@ Products" in the panel on the left. Then, press the "Add" button on the
 panel on the right:
 
 .. Image:: /images/CCS-GP57x-EVM-Custom-Add.png
-|
+
 Verify components
 ''''''''''''''''''
 
 Next, verify the newly discovered products. If everything is correct,
 press the "Finish" button on the bottom:
 
 .. Image:: /images/CCS-GP57x-EVM-Custom-Finish.png
-|
+
 Restart CCS
 ''''''''''''
 
 When prompted, restart CCS for changes to take effect. You will see
 newly discovered products from the custom path.
 
 .. Image:: /images/CCS-GP57x-EVM-Custom-Confirm.png
-|
 
 Install Latest Emulation Package and Sitara Device Support Package
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
@@ -123,7 +122,7 @@ Open new target configuration file
 From CCS, select "File -> New -> Target Configuration File":
 
 .. Image:: /images/CCS-GP437x-EVM-New-Target.png
-|
+
 Select target configuration options
 ''''''''''''''''''''''''''''''''''''
 
@@ -134,7 +133,7 @@ MicroUSB AB connector. Select
 -  **Board or Device**: EVMAM437X
 
 .. Image:: /images/CCS-GP437x-EVM-Configure-Target.png
-|
+
 **Useful Tip**
 
 If you enter the starting numbers of your device in the **Board or
@@ -244,7 +243,7 @@ Save target configuration
 Next, save the target configuration by pressing the **Save** button:
 
 .. Image:: /images/CCS-GP437x-EVM-Save-Target.png
-|
+
 Test target configuration
 ''''''''''''''''''''''''''
 
@@ -253,22 +252,22 @@ button. This will confirm that you have successfully created an emulator
 connection with your board.
 
 .. Image:: /images/AM4-GP-test-connection.png
-|
+
 View target configurations
 '''''''''''''''''''''''''''
 
 From CCS, select "View -> Target Configurations":
 
 .. Image:: /images/CCS-GP437x-EVM-View-Target.png
-|
+
 Launch target configuration
 ''''''''''''''''''''''''''''
 
 Open "User Defined" list and right click on the target configuration
 file that was just saved and select "Launch Selected Configuration":
 
 .. Image:: /images/CCS-GP437x-EVM-Launch-Target.png
-|
+
 Connect target
 '''''''''''''''
 
@@ -277,8 +276,6 @@ After launch, you can connect to a core. For GP AM437x EVM, select
 
 .. Image:: /images/CCS-GP437x-EVM-Connnect-Target.png
 
-|
-
 Success!
 '''''''''
 
@@ -287,7 +284,7 @@ end of the configuration will indicate success or failure. For GP AM437x
 EVM, you will see the message "AM437x GP EVM Initialization is Done":
 
 .. Image:: /images/CCS-GP437x-EVM-Run-Target.png
-|
+
 Additional Notes for AM57x
 """""""""""""""""""""""""""
 
@@ -311,7 +308,7 @@ For example, enable ``DSP11SSClkEnable_API`` for the first DSP core.
 After running the clock enable option, you can connect to the core.
 
 .. Image:: /images/Multicore-Enable.jpg
-|
+
 Timer Suspend Control Options for DSP
 '''''''''''''''''''''''''''''''''''''''
 
@@ -335,8 +332,6 @@ control signal to the DSP as shown in the image below:
 
 .. Image:: /images/GPtimer5_DSPConnect.png
 
-|
-
 Troubleshooting
 """"""""""""""""
 
@@ -362,5 +357,3 @@ If this does not resolve your problem, see these additional resources:
 -  `Troubleshoot
    XDS560 <http://processors.wiki.ti.com/index.php/XDS560#Frequently_Asked_Questions>`__
 
-|
-
diff --git a/...ntegration/_Create_DSP_and_IPU_FW_using_PDK_and_IPC_to_load_from_ARM_AM57xx.rst b/...ntegration/_Create_DSP_and_IPU_FW_using_PDK_and_IPC_to_load_from_ARM_AM57xx.rst
@@ -765,7 +765,6 @@ TRM:
    because each descriptor in the first level translation table describes 1
    MiB of memory. If an access points to a descriptor that is not
    initialized, the MMU will behave in an unpredictable way.
-|
 
 .. rubric:: Changing Cortex M4 IPU Memory Map
    :name: changing-cortex-m4-ipu-memory-map
@@ -785,8 +784,6 @@ defined by the CMA carveout. To change this location, you must change
 the definition of the carveout. **The M4 carveouts are defined in the
 Linux dts file.** For example for the AM57xx EVM:
 
-|
-|
 linux/arch/arm/boot/dts/am57xx-beagle-x15-common.dtsi
 
 ::
@@ -807,14 +804,14 @@ linux/arch/arm/boot/dts/am57xx-beagle-x15-common.dtsi
 		};
 	};
 
-|
+
 You are able to change both the size and location. **Be careful not to
 overlap any other carveouts!**
 
 .. note::
    The **two** location entries for a given carveout
    must be identical!
-|
+
 Additionally, when you change the carveout location, there is a
 corresponding change that must be made to the resource table. For
 starters, if you're making a memory change you will need a **custom**
@@ -836,8 +833,6 @@ corresponding CMA.
     #define PHYS_MEM_IPC_VRING      0x95800000
     #endif
 
-|
-
 .. note::
    The PHYS_MEM_IPC_VRING definition from the resource
    table must match the address of the associated CMA carveout!
@@ -886,9 +881,6 @@ ipc_3_43_02_04/examples/DRA7XX_linux_elf/ex02_messageq/ipu1/IpuAmmu.cfg
     AMMU.largePages[2].L1_cacheable = AMMU.CachePolicy_CACHEABLE;
     AMMU.largePages[2].L1_posted = AMMU.PostedPolicy_POSTED;
 
-|
-
-````
 
 +--------------+-----------------------+-----------------------+--------+-------------+
 | Page         | Cortex M4 Address     | Intermediate Address  | Size   | Comment     |
@@ -983,7 +975,7 @@ ipc/packages/ti/ipc/remoteproc/rsc_table_vayu_ipu.h
             IPU_MEM_IPC_DATA, 0,
             IPU_MEM_IPC_DATA_SIZE, 0, 0, "IPU_MEM_IPC_DATA",
         },
-|
+
 
 The 3 entries above from the resource table all come from the associated
 IPU CMA pool (i.e. as dictated by the TYPE_CARVEOUT). The second
@@ -1261,7 +1253,7 @@ Add the following to the beginning of your configuration file
 .. code-block:: javascript
 
     var Program = xdc.useModule('xdc.cfg.Program');
-|
+
 
 Comment out the Memory sections configuration as shown below
 

diff --git a/source/rtos/Overview/_Directory_Structure.rst b/source/rtos/Overview/_Directory_Structure.rst
@@ -9,7 +9,6 @@ installer.
 
 .. note::
    Not all components are applicable on all platforms.
-|
 
 Software Component Directories
 ================================

diff --git a/source/rtos/Overview/_Getting_Started_Guide.rst b/source/rtos/Overview/_Getting_Started_Guide.rst
@@ -277,7 +277,6 @@ download page for your platform (see links in below section).
    the software in the SDK and will provide the best user experience.
    Occasionally, there may be compatibility issues if different versions
    are used.
-|
 
 When installing CCS, you can choose to control what is installed for
 processor architecture.

diff --git a/source/rtos/Overview/_Processor_SDK_RTOS_Software_Developers_Guide.rst b/source/rtos/Overview/_Processor_SDK_RTOS_Software_Developers_Guide.rst
@@ -54,6 +54,7 @@ build information, and examples to use as a template to start development.
 
 .. rubric:: Guides
    :name: guides
+
 +------------------------------------------------------------------------+-------------------------------------------------------------------------------+
 | **Processor SDK RTOS**                                                                                                                                 |
 +========================================================================+===============================================================================+

diff --git a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM57x.rst b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_BOOT_AM57x.rst
@@ -696,7 +696,7 @@ setup to enable fast boot.
    TRM).Incorrect SYSBOOT configuration can causes long delays especially
    if peripheral boot is configured to be one of the preferred boot modes
    in the boot order
-|
+
 
 Reducing size of SBL and application
 """""""""""""""""""""""""""""""""""""

diff --git a/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_Uniflash.rst b/source/rtos/PDK_Platform_Software/Boot_Board_and_EVM_Abstractions/_Uniflash.rst
@@ -335,7 +335,7 @@ Follow below steps for downloading the flash programer over JTAG manually
 
 .. note:: Refer the `Platform Specific Information <index_board.html#platform-specific-information>`__ for more details on
           additional setup needed for CCS target configuration.
-|
+
 
  - Connect the JTAG port of the board to host PC running CCS.
  - Power ON the board
@@ -350,7 +350,7 @@ Follow below steps for downloading the flash programer over JTAG manually
  - After successful download of the flash programmer, `Program the flash device <index_board.html#programming-the-flash-device>`__
    or `Erase the flash device <index_board.html#erasing-the-flash-device>`__
    by following the steps described in the corresponding secions.
-|
+
 
 
 Programming the Flash Device

diff --git a/source/rtos/PDK_Platform_Software/Device_Drivers/_USB.rst b/source/rtos/PDK_Platform_Software/Device_Drivers/_USB.rst
@@ -454,6 +454,7 @@ platform supported.
 **OMAPL137 EVM**
 
 .. Image:: /images/Omapl137_usb_ac_setup.jpg
+
 **OMAPL138 LCDK**
 
 .. Image:: /images/Omapl138_usb_ac_setup.jpg

diff --git a/source/rtos/Release_Specific/_Build_the_SDK.rst b/source/rtos/Release_Specific/_Build_the_SDK.rst
@@ -34,6 +34,7 @@ The pre-requisite compilers are provided in Code Compose Studio, see the
 |
 
 .. _Build-The-SDK-Setup-Environment-label:
+
 Setup Environment
 ====================
 
@@ -61,7 +62,7 @@ folder.
          links for instructions on how to setup OpensSSL using a particular distribution.
       -  For Linux : Execute the command "sudo apt-get install openssl" at the linux
          command prompt.
-|
+
 Windows
 ^^^^^^^^^
 From the RTOS SDK directory, enter

diff --git a/source/rtos/index_faq.rst b/source/rtos/index_faq.rst
@@ -278,7 +278,6 @@ Components <Overview.html#top-level-makefile>`__.
 .. note::
    The SDK offers command line build for all the components. CCS projects
    are only supported for DSP libraries and PDK driver examples.
-|
 
 .. rubric:: Step 5: Generate and Run Peripheral Driver Examples
    :name: step-5-generate-and-run-peripheral-driver-examples
@@ -694,7 +693,6 @@ described in the article
    board name which is used to configure the board. When creating a custom
    platform if you don`t intend to use an EEPROM then we recommend removing
    code corresponding to Board_getIDInfo in your board library
-|
 
 .. rubric:: Do I need to do any post processing on PDK files generated
    by Pin Mux Utility?
-Original file line number
+Diff line change
@@ Expand Up @@
     timeline.
     .. Image:: /images/SA.png
     Unified Instrumentation Architecture (UIA)
     ------------------------------------------
@@ Expand Down @@