Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-06-06 16:50:55 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/comments: add simple document and fix typo

Browse Source 
This patch adds simple document for the shared memory file system.
with typos fix in a other places.

Signed-off-by: Yanfeng Liu <yfliu2008@qq.com>
This commit is contained in:
Yanfeng Liu
2024-03-02 19:25:48 +08:00
committed by Xiang Xiao
parent 0c50af583d
commit 3bd35487f0
2 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/components/filesystem/shmfs.rst
+13 -1
View File
@@ -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.