From: Ondřej Bílka <neleai@seznam.cz>
Date: Mon, 2 Dec 2013 22:32:42 +0000 (+0100)
Subject: Document shm_open.
X-Git-Tag: upstream/2.30~8336
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=416e014536950a77183013fa4c86cb42dfd322a9;p=external%2Fglibc.git

Document shm_open.
---

diff --git a/ChangeLog b/ChangeLog
index f8339e4..de634b4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2013-12-02  Ondřej Bílka  <neleai@seznam.cz>
+
+	* manual/llio.texi (Memory-mapped I/O): Add shm_open and shm_close.
+
 2013-12-02  Steve Ellcey  <sellcey@mips.com>
 
 	* benchtests/Makefile (bench): Add sqrt.
diff --git a/manual/llio.texi b/manual/llio.texi
index dd0eaa3..b6c9260 100644
--- a/manual/llio.texi
+++ b/manual/llio.texi
@@ -1471,6 +1471,33 @@ There is no existing mapping in at least part of the given region.
 @end table
 @end deftypefun
 
+@comment sys/mman.h
+@comment POSIX
+@deftypefn Function int shm_open (const char *@var{name}, int @var{oflag}, mode_t @var{mode})
+
+This function returns a file descriptor that can be used to allocate shared
+memory via mmap. Unrelated processes can use same @var{name} to create or
+open existing shared memory objects.
+
+A @var{name} argument specifies the shared memory object to be opened.
+In @theglibc{} it must be a string smaller than @code{NAME_MAX} bytes starting
+with an optional slash but containing no other slashes.
+
+The semantics of @var{oflag} and @var{mode} arguments is same as in @code{open}.
+
+@code{shm_open} returns the file descriptor on success or @math{-1} on error.
+On failure @code{errno} is set.
+@end deftypefn
+
+@deftypefn Function int shm_unlink (const char *@var{name})
+
+This function is inverse of @code{shm_open} and removes the object with
+the given @var{name} previously created by @code{shm_open}.
+
+@code{shm_unlink} returns @math{0} on success or @math{-1} on error.
+On failure @code{errno} is set.
+@end deftypefn
+
 @node Waiting for I/O
 @section Waiting for Input or Output
 @cindex waiting for input or output