This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new ebef20ee17 docs: revising comments and documents
ebef20ee17 is described below
commit ebef20ee17edf035f9f858f249488a63406bcdba
Author: Yanfeng Liu <yfliu2...@qq.com>
AuthorDate: Thu Jan 25 10:25:55 2024 +0800
docs: revising comments and documents
- spi/slave.h: revise comments in pulic types section
- doc/sim.rst: minor formatting, add ways to escape cu
Signed-off-by: Yanfeng Liu <yfliu2...@qq.com>
---
Documentation/platforms/sim/sim/boards/sim/index.rst | 13 ++++++++-----
include/nuttx/spi/slave.h | 3 +--
2 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/Documentation/platforms/sim/sim/boards/sim/index.rst
b/Documentation/platforms/sim/sim/boards/sim/index.rst
index bc2a6fa976..85748ad30e 100644
--- a/Documentation/platforms/sim/sim/boards/sim/index.rst
+++ b/Documentation/platforms/sim/sim/boards/sim/index.rst
@@ -692,6 +692,7 @@ NOTES
running C++ static initializers until NuttX has been initialized.
fb
+--
A simple configuration used for some basic (non-graphic) debug of the
framebuffer character drivers using apps/examples/fb.
@@ -1115,14 +1116,14 @@ rpproxy and rpserver
rpserver: Remote master(host) server process.
rpserver contains all the real hardware configuration, such as:
- 1.Universal Asynchronous Receiver/Transmitter (UART).
- 2.Specific File System.
- 3.Network protocol stack and real network card device.
- 4....
+ 1. Universal Asynchronous Receiver/Transmitter (UART).
+ 2. Specific File System.
+ 3. Network protocol stack and real network card device.
+ 4. ...
Rpmsg driver used in this example include:
-1.Rpmsg Syslog
+1. Rpmsg Syslog
Source::
@@ -1250,6 +1251,8 @@ To use this example:
1 1 224 FIFO Kthread --- Waiting Signal 00000000
002032 hpwork
3 3 100 FIFO Task --- Running 00000000
004080 init
+ To switch back the console, type ``"~."`` in the cu session.
+
3. RpmsgFS:
Mount the remote file system via RPMSGFS, cu to proxy first::
diff --git a/include/nuttx/spi/slave.h b/include/nuttx/spi/slave.h
index 02de4e622d..11b7bde8c8 100644
--- a/include/nuttx/spi/slave.h
+++ b/include/nuttx/spi/slave.h
@@ -388,8 +388,7 @@
*
* 4) When the first word from the master is shifted in, the SPI
* controller driver will call the device's receive() method to
- * provide the master with the command word that was just shifted
- * in.
+ * provide the master command word that was just shifted in.
*
* For the case of bi-directional data transfer or of a transfer of
* data from the SPI device to the master, the SPI device driver
