aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2018-10-20 22:12:59 +0200
committerMattias Andrée <maandree@kth.se>2018-10-20 22:12:59 +0200
commit24f9649c1f4692dd0cea64170a015a214197c926 (patch)
tree686e5c5c5bea6e69ff5894f10e6dc5fb0124b97f /man
parentAdd man pages for memeq, mempcpy and mempset (diff)
downloadlibsimple-24f9649c1f4692dd0cea64170a015a214197c926.tar.gz
libsimple-24f9649c1f4692dd0cea64170a015a214197c926.tar.bz2
libsimple-24f9649c1f4692dd0cea64170a015a214197c926.tar.xz
Add mempsetelem and memsetelem and add fix and tests for memelem and memrelem
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man')
-rw-r--r--man/libsimple_mempcpy.34
-rw-r--r--man/libsimple_mempset.35
-rw-r--r--man/libsimple_mempsetelem.372
-rw-r--r--man/libsimple_memsetelem.369
4 files changed, 146 insertions, 4 deletions
diff --git a/man/libsimple_mempcpy.3 b/man/libsimple_mempcpy.3
index 40b1e63..4d4c514 100644
--- a/man/libsimple_mempcpy.3
+++ b/man/libsimple_mempcpy.3
@@ -1,6 +1,6 @@
.TH LIBSIMPLE_MEMPCPY 3 2018-10-20 libsimple
.SH NAME
-libsimple_mempcpy \- check two memory segments for equality
+libsimple_mempcpy \- copy an array of bytes into another
.SH SYNOPSIS
.nf
#include <libsimple.h>
@@ -66,5 +66,5 @@ None.
.SH BUGS
None.
.SH SEE ALSO
-.BR libsimple_mempset (3)
+.BR libsimple_mempset (3),
.BR memcpy (3)
diff --git a/man/libsimple_mempset.3 b/man/libsimple_mempset.3
index e4d7fda..33b610c 100644
--- a/man/libsimple_mempset.3
+++ b/man/libsimple_mempset.3
@@ -1,6 +1,6 @@
.TH LIBSIMPLE_MEMPSET 3 2018-10-20 libsimple
.SH NAME
-libsimple_mempset \- check two memory segments for equality
+libsimple_mempset \- fill an array of bytes
.SH SYNOPSIS
.nf
#include <libsimple.h>
@@ -68,5 +68,6 @@ None.
.SH BUGS
None.
.SH SEE ALSO
-.BR libsimple_mempcpy (3)
+.BR libsimple_mempsetelem (3),
+.BR libsimple_mempcpy (3),
.BR memset (3)
diff --git a/man/libsimple_mempsetelem.3 b/man/libsimple_mempsetelem.3
new file mode 100644
index 0000000..ca52a2e
--- /dev/null
+++ b/man/libsimple_mempsetelem.3
@@ -0,0 +1,72 @@
+.TH LIBSIMPLE_MEMPSETELEM 3 2018-10-20 libsimple
+.SH NAME
+libsimple_mempsetelem \- fill an array with a value
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+void *libsimple_mempsetelem(void *\fIbuf\fP, const void *\fIitem\fP, size_t \fIsize\fP, size_t \fInitems\fP);
+
+#ifndef mempsetelem
+# define mempsetelem libsimple_mempsetelem
+#endif
+.fi
+
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_mempsetelem ()
+function fills the beginning of
+.I buf
+with
+.I nitems
+copies of the element
+.I item
+with the size
+.IR size .
+.SH RETURN VALUE
+The
+.BR libsimple_mempsetelem ()
+function returns the pointer
+.I buf
+with the offset
+.I nitems*size
+(the byte where the copy stopped).
+.SH ERRORS
+The
+.BR libsimple_mempsetelem ()
+function cannot fail.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface Attribute Value
+T{
+.BR libsimple_mempsetelem ()
+T} Thread safety MT-Safe
+T{
+.BR libsimple_mempsetelem ()
+T} Async-signal safety AS-Safe
+T{
+.BR libsimple_mempsetelem ()
+T} Async-cancel safety AC-Safe
+.TE
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR libsimple_memsetelem (3),
+.BR libsimple_mempset (3)
diff --git a/man/libsimple_memsetelem.3 b/man/libsimple_memsetelem.3
new file mode 100644
index 0000000..700310a
--- /dev/null
+++ b/man/libsimple_memsetelem.3
@@ -0,0 +1,69 @@
+.TH LIBSIMPLE_MEMSETELEM 3 2018-10-20 libsimple
+.SH NAME
+libsimple_memsetelem \- fill an array with a value
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+static inline void *libsimple_memsetelem(void *\fIbuf\fP, const void *\fIitem\fP, size_t \fIsize\fP, size_t \fInitems\fP);
+
+#ifndef memsetelem
+# define memsetelem libsimple_memsetelem
+#endif
+.fi
+
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_memsetelem ()
+function fills the beginning of
+.I buf
+with
+.I nitems
+copies of the element
+.I item
+with the size
+.IR size .
+.SH RETURN VALUE
+The
+.BR libsimple_memsetelem ()
+function returns the pointer
+.IR buf .
+.SH ERRORS
+The
+.BR libsimple_memsetelem ()
+function cannot fail.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface Attribute Value
+T{
+.BR libsimple_memsetelem ()
+T} Thread safety MT-Safe
+T{
+.BR libsimple_memsetelem ()
+T} Async-signal safety AS-Safe
+T{
+.BR libsimple_memsetelem ()
+T} Async-cancel safety AC-Safe
+.TE
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR libsimple_mempsetelem (3),
+.BR memset (3)