1
0
Fork 0
forked from nuttx/nuttx-update

docs: Fix sphinx warnings listed in issue #9306

Fixes these errors:
```
 /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/lcd.rst:52: WARNING: duplicate label ttgotdisplayesp32, other instance in /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/framebuffer.rst
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:370: CRITICAL: Unexpected section title.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:394: CRITICAL: Unexpected section title.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1494: ERROR: Inconsistent literal block quoting.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1569: WARNING: Literal block expected; none found.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst:207: WARNING: download file not readable: /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/tone.wav
 checking consistency... /home/bashton/nuttx-wrk/nuttx/Documentation/reference/os/newreno.rst: WARNING: document isn't included in any toctree
 /home/bashton/nuttx-wrk/nuttx/Documentation/guides/zerolatencyinterrupts.rst:117: WARNING: unknown document: <nestedinterrupts.rst>
```
This commit is contained in:
Brennan Ashton 2023-05-19 19:56:44 -07:00 committed by Xiang Xiao
parent 2049ca69b0
commit 4d3ce8f706
6 changed files with 43 additions and 32 deletions

View file

@ -68,7 +68,7 @@ Examples
Examples apply to specific cases of the :ref:`genericlcdfb`: Examples apply to specific cases of the :ref:`genericlcdfb`:
.. _ttgotdisplayesp32: .. _ttgotdisplayesp32_fb:
TTGO T-Display ESP32 board TTGO T-Display ESP32 board
--------------------------- ---------------------------
@ -109,7 +109,7 @@ NuttX Simulator
By selecting the ``sim:lvgl_fb`` config, the ``lvgldemo`` example will be built with the framebuffer driver. By selecting the ``sim:lvgl_fb`` config, the ``lvgldemo`` example will be built with the framebuffer driver.
* ``boards/sim/sim/sim/src/sim_bringup.c`` registers the framebuffer driver the same way :ref:`ttgotdisplayesp32`; * ``boards/sim/sim/sim/src/sim_bringup.c`` registers the framebuffer driver the same way :ref:`ttgotdisplayesp32_fb`;
* ``arch/sim/src/sim/up_framebuffer.c`` and ``arch/sim/src/sim/up_x11framebuffer.c`` will be built as ``CONFIG_SIM_FRAMEBUFFER = y`` and ``CONFIG_SIM_X11FB = y`` are set, respectively; * ``arch/sim/src/sim/up_framebuffer.c`` and ``arch/sim/src/sim/up_x11framebuffer.c`` will be built as ``CONFIG_SIM_FRAMEBUFFER = y`` and ``CONFIG_SIM_X11FB = y`` are set, respectively;
* ``up_framebuffer.c`` provides ``up_fbinitialize`` and, * ``up_framebuffer.c`` provides ``up_fbinitialize`` and,

View file

@ -46,7 +46,7 @@ Examples
Examples apply to specific cases of the :ref:`genericlcdlcd`: Examples apply to specific cases of the :ref:`genericlcdlcd`:
.. _ttgotdisplayesp32: .. _ttgotdisplayesp32_lcd:
TTGO T-Display ESP32 board TTGO T-Display ESP32 board
--------------------------- ---------------------------
@ -94,7 +94,7 @@ NuttX Simulator
By selecting the ``sim:lvgl_lcd`` config, the ``lvgldemo`` example will be built with the LCD character interface. By selecting the ``sim:lvgl_lcd`` config, the ``lvgldemo`` example will be built with the LCD character interface.
* ``boards/sim/sim/sim/src/sim_bringup.c`` registers the framebuffer driver the same way :ref:`ttgotdisplayesp32`; * ``boards/sim/sim/sim/src/sim_bringup.c`` registers the lcd driver the same way :ref:`ttgotdisplayesp32_lcd`;
* ``arch/sim/src/sim/up_lcd.c`` and ``arch/sim/src/sim/up_x11framebuffer.c`` will be built as ``CONFIG_SIM_LCDDRIVER = y`` and ``CONFIG_SIM_X11FB = y`` are set, respectively; * ``arch/sim/src/sim/up_lcd.c`` and ``arch/sim/src/sim/up_x11framebuffer.c`` will be built as ``CONFIG_SIM_LCDDRIVER = y`` and ``CONFIG_SIM_X11FB = y`` are set, respectively;
* ``up_lcd.c`` provides ``board_lcd_initialize`` and ``board_lcd_getdev``: * ``up_lcd.c`` provides ``board_lcd_initialize`` and ``board_lcd_getdev``:

View file

@ -115,7 +115,7 @@ Nested Interrupt Handling
========================= =========================
Some general notes about nested interrupt handling are provided in Some general notes about nested interrupt handling are provided in
:doc:`<nestedinterrupts.rst>`. In this case, handling the nested custom :doc:`nestedinterrupts`. In this case, handling the nested custom
interrupt is simpler because the generic interrupt handler is not interrupt is simpler because the generic interrupt handler is not
re-entered. Rather, the generic interrupt handler must simply be made to re-entered. Rather, the generic interrupt handler must simply be made to
co-exist with the custom interrupt interrupt handler. co-exist with the custom interrupt interrupt handler.

View file

@ -366,8 +366,8 @@ BASIC
There is also a test suite for the interpreter that can be found at There is also a test suite for the interpreter that can be found at
apps/examples/bastest. apps/examples/bastest.
Configuration Configuration
------------- -------------
Below are the recommended configuration changes to use BAS with the Below are the recommended configuration changes to use BAS with the
stm32f4discovery/nsh configuration: stm32f4discovery/nsh configuration:
@ -390,8 +390,8 @@ BASIC
CONFIG_EXAMPLES_BASTEST_DEVMINOR=6 CONFIG_EXAMPLES_BASTEST_DEVMINOR=6
CONFIG_EXAMPLES_BASTEST_DEVPATH="/dev/ram6" CONFIG_EXAMPLES_BASTEST_DEVPATH="/dev/ram6"
Usage Usage
----- -----
This setup will initialize the BASIC test (optional): This will mount a This setup will initialize the BASIC test (optional): This will mount a
ROMFS file system at /mnt/romfs that contains the BASIC test files:: ROMFS file system at /mnt/romfs that contains the BASIC test files::
@ -1487,40 +1487,50 @@ This is a configuration for WebAssembly sample.
1. Compile Toolchain 1. Compile Toolchain
1. Download WASI sdk and export the WASI_SDK_PATH path:: 1. Download WASI sdk and export the WASI_SDK_PATH path
$ wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-19/wasi-sdk-19.0-linux.tar.gz .. code-block:: console
$ tar xf wasi-sdk-19.0-linux.tar.gz
Put wasi-sdk-19.0 to your host WASI_SDK_PATH environment variable, like:
$ export WASI_SDK_PATH=`pwd`/wasi-sdk-19.0
2. Download Wamr "wamrc" AOT compiler and export to the PATH:: wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-19/wasi-sdk-19.0-linux.tar.gz
tar xf wasi-sdk-19.0-linux.tar.gz
# Put wasi-sdk-19.0 to your host WASI_SDK_PATH environment variable, like:
export WASI_SDK_PATH=`pwd`/wasi-sdk-19.0
$ mkdir wamrc 2. Download Wamr "wamrc" AOT compiler and export to the PATH
$ wget https://github.com/bytecodealliance/wasm-micro-runtime/releases/download/WAMR-1.1.2/wamrc-1.1.2-x86_64-ubuntu-20.04.tar.gz
$ tar xf wamrc-1.1.2-x86_64-ubuntu-20.04.tar.gz .. code-block:: console
$ export PATH=$PATH:$PWD
mkdir wamrc
wget https://github.com/bytecodealliance/wasm-micro-runtime/releases/download/WAMR-1.1.2/wamrc-1.1.2-x86_64-ubuntu-20.04.tar.gz
tar xf wamrc-1.1.2-x86_64-ubuntu-20.04.tar.gz
export PATH=$PATH:$PWD
2. Configuring and running 2. Configuring and running
1. Configuring sim/wamr and compile:: 1. Configuring sim/wamr and compile
nuttx$ ./tools/configure.sh sim/wamr .. code-block:: console
nuttx$ make
./tools/configure.sh sim/wamr
make
... ...
Wamrc Generate AoT: /home/archer/code/nuttx/n5/apps/wasm/hello.aot Wamrc Generate AoT: /home/archer/code/nuttx/n5/apps/wasm/hello.aot
Wamrc Generate AoT: /home/archer/code/nuttx/n5/apps/wasm/coremark.aot Wamrc Generate AoT: /home/archer/code/nuttx/n5/apps/wasm/coremark.aot
LD: nuttx LD: nuttx
2. Copy the generated wasm file(Interpreter/AoT):: 2. Copy the generated wasm file(Interpreter/AoT)
nuttx$ cp ../apps/wasm/hello.aot . .. code-block:: console
nuttx$ cp ../apps/wasm/hello.wasm .
nuttx$ cp ../apps/wasm/coremark.wasm .
3. Run iwasm:: cp ../apps/wasm/hello.aot .
cp ../apps/wasm/hello.wasm .
cp ../apps/wasm/coremark.wasm .
nuttx$ ./nuttx 3. Run iwasm
.. code-block:: console
./nuttx
NuttShell (NSH) NuttX-10.4.0 NuttShell (NSH) NuttX-10.4.0
nsh> iwasm /data/hello.wasm nsh> iwasm /data/hello.wasm
Hello, World!! Hello, World!!
@ -1566,12 +1576,12 @@ This is a configuration with sim usbdev support.
sim:usbdev contains two different sets of composite devices:: sim:usbdev contains two different sets of composite devices::
conn0: adb & rndis conn0: adb & rndis
conn1: cdcacm & cdcecm conn1: cdcacm & cdcecm
You can use the sim:usbdev configuration:: You can use the sim:usbdev configuration::
./tools/configure.sh sim:usbdev ./tools/configure.sh sim:usbdev
3. How to run 3. How to run

View file

@ -204,7 +204,7 @@ This will create a temporary folder in ``apps/examples/romfs/testdir``. Move
a PCM-encoded (``.wav``) audio file with 16 or 24 bits/sample (sampled at 16~48kHz) a PCM-encoded (``.wav``) audio file with 16 or 24 bits/sample (sampled at 16~48kHz)
to this folder. to this folder.
.. note:: You can use :download:`this 440 Hz sinusoidal tone <tone.wav>`. .. note:: You can use :download:`this 440 Hz sinusoidal tone <../esp32s2-saola-1/tone.wav>`.
The audio file should be located at ``apps/examples/romfs/testdir/tone.wav`` The audio file should be located at ``apps/examples/romfs/testdir/tone.wav``
Build the project again and flash it (make sure not to clean it, just build) Build the project again and flash it (make sure not to clean it, just build)

View file

@ -18,6 +18,7 @@ in other header files.
led.rst led.rst
mutex.rst mutex.rst
nat.rst nat.rst
newreno.rst
notifier.rst notifier.rst
nuttx.rst nuttx.rst
paging.rst paging.rst