diff options
author | Mattias Andrée <maandree@kth.se> | 2018-11-25 14:17:49 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2018-11-25 14:17:49 +0100 |
commit | e2dc7cf9c966d4c94b7556c1c2ada8d170715654 (patch) | |
tree | 78733ab53fb0e1d185773d23f0f5ccd373be2bc1 /man3 | |
parent | Add man pages (diff) | |
download | libsimple-e2dc7cf9c966d4c94b7556c1c2ada8d170715654.tar.gz libsimple-e2dc7cf9c966d4c94b7556c1c2ada8d170715654.tar.bz2 libsimple-e2dc7cf9c966d4c94b7556c1c2ada8d170715654.tar.xz |
Fix consistence in memelem functions
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r-- | man3/libsimple_memelem.3 | 14 | ||||
-rw-r--r-- | man3/libsimple_memelem_inv.3 | 14 | ||||
-rw-r--r-- | man3/libsimple_memelemscan.3 | 16 | ||||
-rw-r--r-- | man3/libsimple_memelemscan_inv.3 | 16 | ||||
-rw-r--r-- | man3/libsimple_mempsetelem.3 | 8 | ||||
-rw-r--r-- | man3/libsimple_memrelem.3 | 14 | ||||
-rw-r--r-- | man3/libsimple_memrelem_inv.3 | 14 | ||||
-rw-r--r-- | man3/libsimple_memreplaceelem.3 | 2 | ||||
-rw-r--r-- | man3/libsimple_memsetelem.3 | 6 | ||||
-rw-r--r-- | man3/libsimple_rawmemelem.3 | 12 | ||||
-rw-r--r-- | man3/libsimple_rawmemelem_inv.3 | 12 | ||||
-rw-r--r-- | man3/libsimple_rawmemrelem.3 | 14 | ||||
-rw-r--r-- | man3/libsimple_rawmemrelem_inv.3 | 14 |
13 files changed, 78 insertions, 78 deletions
diff --git a/man3/libsimple_memelem.3 b/man3/libsimple_memelem.3 index e1189b3..4ccdb3a 100644 --- a/man3/libsimple_memelem.3 +++ b/man3/libsimple_memelem.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_MEMELEM 3 2018-10-20 libsimple +.TH LIBSIMPLE_MEMELEM 3 2018-11-25 libsimple .SH NAME libsimple_memelem \- find aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_memelem(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_memelem(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef memelem # define memelem libsimple_memelem @@ -20,13 +20,13 @@ The function scans the memory segment .IR haystack , with the size -.IR nhaystack*nneedle , +.IR n*width , for the first occurence of the byte string .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . .PP The comparison is case-sensitive. .SH RETURN VALUE @@ -35,12 +35,12 @@ The function returns the pointer .I s with a minimal offset such that -.IR !memcmp(r,needle,nneedle) , +.IR !memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, .B NULL is returned. diff --git a/man3/libsimple_memelem_inv.3 b/man3/libsimple_memelem_inv.3 index a36e38c..c3b3208 100644 --- a/man3/libsimple_memelem_inv.3 +++ b/man3/libsimple_memelem_inv.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_MEMELEM_INV 3 2018-11-24 libsimple +.TH LIBSIMPLE_MEMELEM_INV 3 2018-11-25 libsimple .SH NAME libsimple_memelem_inv \- find different aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_memelem_inv(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_memelem_inv(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef memelem_inv # define memelem_inv libsimple_memelem_inv @@ -20,14 +20,14 @@ The function scans the memory segment .IR haystack , with the size -.IR nhaystack*nneedle , +.IR n*width , for the first occurence of a byte string different from .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . .PP The comparison is case-sensitive. .SH RETURN VALUE @@ -36,12 +36,12 @@ The function returns the pointer .I s with a minimal offset such that -.IR memcmp(r,needle,nneedle) , +.IR memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, .B NULL is returned. diff --git a/man3/libsimple_memelemscan.3 b/man3/libsimple_memelemscan.3 index 727c44a..092508e 100644 --- a/man3/libsimple_memelemscan.3 +++ b/man3/libsimple_memelemscan.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_MEMELEMSCAN 3 2018-11-17 libsimple +.TH LIBSIMPLE_MEMELEMSCAN 3 2018-11-25 libsimple .SH NAME libsimple_memelemscan \- find aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_memelemscan(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_memelemscan(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef memelemscan # define memelemscan libsimple_memelemscan @@ -20,13 +20,13 @@ The function scans the memory segment .IR haystack , with the size -.IR nhaystack*nneedle , +.IR n*width , for the first occurence of the byte string .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . If no such character exist in the memory segment, the memory segment's end is returned. .PP @@ -37,14 +37,14 @@ The function returns the pointer .I s with a minimal offset such that -.IR !memcmp(r,needle,nneedle) , +.IR !memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, -.I (void *)&((char *)haystack)[nhaystack*nneedle] +.I (void *)&((char *)haystack)[n*width] is returned. .SH ERRORS The diff --git a/man3/libsimple_memelemscan_inv.3 b/man3/libsimple_memelemscan_inv.3 index 77f7119..3fdd8f8 100644 --- a/man3/libsimple_memelemscan_inv.3 +++ b/man3/libsimple_memelemscan_inv.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_MEMELEMSCAN_INV 3 2018-11-24 libsimple +.TH LIBSIMPLE_MEMELEMSCAN_INV 3 2018-11-25 libsimple .SH NAME libsimple_memelemscan_inv \- skip aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_memelemscan_inv(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_memelemscan_inv(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef memelemscan_inv # define memelemscan_inv libsimple_memelemscan_inv @@ -20,14 +20,14 @@ The function scans the memory segment .IR haystack , with the size -.IR nhaystack*nneedle , +.IR n*width , for the first occurence of a byte string different from .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . If no such character exist in the memory segment, the memory segment's end is returned. .PP @@ -38,14 +38,14 @@ The function returns the pointer .I s with a minimal offset such that -.IR memcmp(r,needle,nneedle) , +.IR memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, -.I (void *)&((char *)haystack)[nhaystack*nneedle] +.I (void *)&((char *)haystack)[n*width] is returned. .SH ERRORS The diff --git a/man3/libsimple_mempsetelem.3 b/man3/libsimple_mempsetelem.3 index 0b32228..e10a252 100644 --- a/man3/libsimple_mempsetelem.3 +++ b/man3/libsimple_mempsetelem.3 @@ -5,7 +5,7 @@ libsimple_mempsetelem \- fill an array with a value .nf #include <libsimple.h> -void *libsimple_mempsetelem(void *\fIbuf\fP, const void *\fIitem\fP, size_t \fIsize\fP, size_t \fInitems\fP); +void *libsimple_mempsetelem(void *\fIbuf\fP, const void *\fIitem\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef mempsetelem # define mempsetelem libsimple_mempsetelem @@ -20,18 +20,18 @@ The function fills the beginning of .I buf with -.I nitems +.I n copies of the element .I item with the size -.IR size . +.IR width . .SH RETURN VALUE The .BR libsimple_mempsetelem () function returns the pointer .I buf with the offset -.I nitems*size +.I n*width (the byte where the copy stopped). .SH ERRORS The diff --git a/man3/libsimple_memrelem.3 b/man3/libsimple_memrelem.3 index f6681e9..26bcfb8 100644 --- a/man3/libsimple_memrelem.3 +++ b/man3/libsimple_memrelem.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_MEMRELEM 3 2018-10-20 libsimple +.TH LIBSIMPLE_MEMRELEM 3 2018-11-25 libsimple .SH NAME libsimple_memrelem \- find aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_memrelem(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_memrelem(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef memrelem # define memrelem libsimple_memrelem @@ -20,13 +20,13 @@ The function scans the memory segment .IR haystack , with the size -.IR nhaystack*nneedle , +.IR n*width , for the last occurence of the byte string .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . .PP The comparison is case-sensitive. .SH RETURN VALUE @@ -35,12 +35,12 @@ The function returns the pointer .I s with a maximal offset such that -.IR !memcmp(r,needle,nneedle) , +.IR !memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, .B NULL is returned. diff --git a/man3/libsimple_memrelem_inv.3 b/man3/libsimple_memrelem_inv.3 index 02b4be7..f3d5736 100644 --- a/man3/libsimple_memrelem_inv.3 +++ b/man3/libsimple_memrelem_inv.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_MEMRELEM_INV 3 2018-11-24 libsimple +.TH LIBSIMPLE_MEMRELEM_INV 3 2018-11-25 libsimple .SH NAME libsimple_memrelem_inv \- find different aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_memrelem_inv(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_memrelem_inv(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef memrelem_inv # define memrelem_inv libsimple_memrelem_inv @@ -20,14 +20,14 @@ The function scans the memory segment .IR haystack , with the size -.IR nhaystack*nneedle , +.IR n*width , for the last occurence of a byte string different from .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . .PP The comparison is case-sensitive. .SH RETURN VALUE @@ -36,12 +36,12 @@ The function returns the pointer .I s with a maximal offset such that -.IR memcmp(r,needle,nneedle) , +.IR memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, .B NULL is returned. diff --git a/man3/libsimple_memreplaceelem.3 b/man3/libsimple_memreplaceelem.3 index 02e0f06..6ad5c6c 100644 --- a/man3/libsimple_memreplaceelem.3 +++ b/man3/libsimple_memreplaceelem.3 @@ -5,7 +5,7 @@ libsimple_memreplaceelem \- replace elements in an array .nf #include <libsimple.h> -void *libsimple_memreplaceelem(void *\fIs\fP, int \fIold\fP, int \fInew\fP, size_t \fIn\fP, size_t \fIwidth\fP); +void *libsimple_memreplaceelem(void *\fIs\fP, int \fIold\fP, int \fInew\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef memreplaceelem # define memreplaceelem libsimple_memreplaceelem diff --git a/man3/libsimple_memsetelem.3 b/man3/libsimple_memsetelem.3 index 516a20b..91e5b63 100644 --- a/man3/libsimple_memsetelem.3 +++ b/man3/libsimple_memsetelem.3 @@ -5,7 +5,7 @@ libsimple_memsetelem \- fill an array with a value .nf #include <libsimple.h> -static inline void *libsimple_memsetelem(void *\fIbuf\fP, const void *\fIitem\fP, size_t \fIsize\fP, size_t \fInitems\fP); +static inline void *libsimple_memsetelem(void *\fIbuf\fP, const void *\fIitem\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef memsetelem # define memsetelem libsimple_memsetelem @@ -20,11 +20,11 @@ The function fills the beginning of .I buf with -.I nitems +.I n copies of the element .I item with the size -.IR size . +.IR width . .SH RETURN VALUE The .BR libsimple_memsetelem () diff --git a/man3/libsimple_rawmemelem.3 b/man3/libsimple_rawmemelem.3 index 4e83ed0..62c986c 100644 --- a/man3/libsimple_rawmemelem.3 +++ b/man3/libsimple_rawmemelem.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_RAWMEMELEM 3 2018-11-24 libsimple +.TH LIBSIMPLE_RAWMEMELEM 3 2018-11-25 libsimple .SH NAME libsimple_rawmemelem \- find aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_rawmemelem(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_rawmemelem(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP); #ifndef rawmemelem # define rawmemelem libsimple_rawmemelem @@ -22,9 +22,9 @@ function scans the memory segment for the first occurence of the byte string .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . .PP The .BR libsimple_rawmemelem () @@ -39,12 +39,12 @@ The function returns the pointer .I s with a minimal offset such that -.IR !memcmp(r,needle,nneedle) , +.IR !memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, the behaviour is undefined. .SH ERRORS The diff --git a/man3/libsimple_rawmemelem_inv.3 b/man3/libsimple_rawmemelem_inv.3 index 20ed595..28e5bef 100644 --- a/man3/libsimple_rawmemelem_inv.3 +++ b/man3/libsimple_rawmemelem_inv.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_RAWMEMELEM_INV 3 2018-11-24 libsimple +.TH LIBSIMPLE_RAWMEMELEM_INV 3 2018-11-25 libsimple .SH NAME libsimple_rawmemelem_inv \- find different aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_rawmemelem_inv(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_rawmemelem_inv(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP); #ifndef rawmemelem_inv # define rawmemelem_inv libsimple_rawmemelem_inv @@ -23,9 +23,9 @@ for the first occurence of a byte string different from .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . .PP The .BR libsimple_rawmemchr () @@ -40,12 +40,12 @@ The function returns the pointer .I s with a minimal offset such that -.IR memcmp(r,needle,nneedle) , +.IR memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, the behaviour is undefined. .SH ERRORS The diff --git a/man3/libsimple_rawmemrelem.3 b/man3/libsimple_rawmemrelem.3 index 0a179a8..4ac85aa 100644 --- a/man3/libsimple_rawmemrelem.3 +++ b/man3/libsimple_rawmemrelem.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_RAWMEMRELEM 3 2018-11-24 libsimple +.TH LIBSIMPLE_RAWMEMRELEM 3 2018-11-25 libsimple .SH NAME libsimple_rawmemrelem \- find aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_rawmemrelem(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_rawmemrelem(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef rawmemrelem # define rawmemrelem libsimple_rawmemrelem @@ -20,13 +20,13 @@ The function scans the memory segment .IR haystack , with the size -.IR nhaystack*nneedle , +.IR n*width , for the last occurence of the byte string .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . The .BR libsimple_rawmemrelem () function assumes there is at least one @@ -40,12 +40,12 @@ The function returns the pointer .I s with a maximal offset such that -.IR !memcmp(r,needle,nneedle) , +.IR !memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, the behaviour is undefined. .SH ERRORS The diff --git a/man3/libsimple_rawmemrelem_inv.3 b/man3/libsimple_rawmemrelem_inv.3 index d2d1acf..ee16eb9 100644 --- a/man3/libsimple_rawmemrelem_inv.3 +++ b/man3/libsimple_rawmemrelem_inv.3 @@ -1,11 +1,11 @@ -.TH LIBSIMPLE_RAWMEMRELEM_INV 3 2018-11-24 libsimple +.TH LIBSIMPLE_RAWMEMRELEM_INV 3 2018-11-25 libsimple .SH NAME libsimple_rawmemrelem_inv \- find different aligned byte string in memory .SH SYNOPSIS .nf #include <libsimple.h> -void *libsimple_rawmemrelem_inv(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); +void *libsimple_rawmemrelem_inv(const void *\fIhaystack\fP, const void *\fIneedle\fP, size_t \fIwidth\fP, size_t \fIn\fP); #ifndef rawmemrelem_inv # define rawmemrelem_inv libsimple_rawmemrelem_inv @@ -20,14 +20,14 @@ The function scans the memory segment .IR haystack , with the size -.IR nhaystack*nneedle , +.IR n*width , for the last occurence of a byte string different from .I needle with the size -.IR nneedle , +.IR width , and with an offset equivalent to zero modulo -.IR nneedle . +.IR width . The .BR libsimple_rawmemrelem_inv () function assumes there is at least one @@ -41,12 +41,12 @@ The function returns the pointer .I s with a maximal offset such that -.IR memcmp(r,needle,nneedle) , +.IR memcmp(r,needle,width) , where .I r is the returned pointer, and such that the offset is equivalent to zero modulo -.IR nneedle . +.IR width . If no such offset exists, the behaviour is undefined. .SH ERRORS The |