From 3bd35487f08a6d017f8be32689838e9f4d8a2cf2 Mon Sep 17 00:00:00 2001 From: Yanfeng Liu Date: Sat, 2 Mar 2024 19:25:48 +0800 Subject: [PATCH] docs/comments: add simple document and fix typo This patch adds simple document for the shared memory file system. with typos fix in a other places. Signed-off-by: Yanfeng Liu --- Documentation/components/filesystem/shmfs.rst | 14 +++++++++++++- net/Kconfig | 2 +- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/Documentation/components/filesystem/shmfs.rst b/Documentation/components/filesystem/shmfs.rst index f5ed0b8315..f23d79c7e1 100644 --- a/Documentation/components/filesystem/shmfs.rst +++ b/Documentation/components/filesystem/shmfs.rst @@ -2,4 +2,16 @@ Shared Memory File System ========================= -Include support for shm_open() and shm_close. +This supports the POSIX shm_open() APIs for shared memory among unrelated +apps. + +It can be enabled with ``CONFIG_FS_SHMFS=y``. To check how it works, please +also enable the example app via ``CONFIG_EXMAPLE_SHM=y`` and run ``shm_test`` +from NSH command line. + +This file system doesn't support mount operations though. + +If comment the line using ``shm_unlink()`` in the example app, we can see +a file under ``/var/shm/`` from NSH command line after running the example. +We can also remove that file from command line. + diff --git a/net/Kconfig b/net/Kconfig index 1eca79c99e..7c8cf4a3d7 100644 --- a/net/Kconfig +++ b/net/Kconfig @@ -394,7 +394,7 @@ choice depends on NET_STAR default NET_STARPOINT ---help--- - Specifies the role of this not in the star configuration. + Specifies the role of this node in the star configuration. config NET_STARPOINT bool "Point node in star"