From 9fc2b129167e1f2a16d942369f057f618a00d81c Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 7 Nov 2018 22:18:04 +0100 Subject: Move section 3 man pages to man3/ and add libsimple.h.0 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man/libsimple_memalignz.3 | 182 ---------------------------------------------- 1 file changed, 182 deletions(-) delete mode 100644 man/libsimple_memalignz.3 (limited to 'man/libsimple_memalignz.3') diff --git a/man/libsimple_memalignz.3 b/man/libsimple_memalignz.3 deleted file mode 100644 index 11a70d7..0000000 --- a/man/libsimple_memalignz.3 +++ /dev/null @@ -1,182 +0,0 @@ -.TH LIBSIMPLE_MEMALIGNZ 3 2018-11-03 libsimple -.SH NAME -libsimple_memalignz \- allocate optionally initialised memory with custom alignment -.SH SYNOPSIS -.nf -#include - -static inline void *libsimple_memalignz(int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP); -static inline void *libsimple_enmemalignz(int \fIstatus\fP, int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP); -static inline void *libsimple_ememalignz(int \fIclear\fP, size_t \fIalignment\fP, size_t \fIn\fP); - -#ifndef memalignz -# define memalignz libsimple_memalignz -#endif -#ifndef enmemalignz -# define enmemalignz libsimple_enmemalignz -#endif -#ifndef ememalignz -# define ememalignz libsimple_ememalignz -#endif -.fi -.PP -Link with -.IR \-lsimple . -.SH DESCRIPTION -The -.BR libsimple_memalignz (), -.BR libsimple_enmemalignz (), -and -.BR libsimple_ememalignz () -functions allocate -.I n -bytes to the heap and return a pointer with an -alignment of -.I alignment -bytes to the allocated memory. The memory will be -initialised with zeroes if -.I clear -is a non-zero value. The function -.BR free (3) -shall be called with the returned pointer as -input when the allocated memory is no longer needed. -.PP -The -.BR libsimple_enmemalignz () -and -.BR libsimple_ememalignz () -functions will terminate the process if the memory -cannot be allocated of if the user tries to allocate -0 bytes, by calling the -.BR libsimple_enprintf () -and -.BR libsimple_eprintf () -functions, respectively. -On failure, the process's exit value will be -.I status -if the -.BR libsimple_enmemalignz () -function is used or -.IR libsimple_default_failure_exit (3) -if the -.BR libsimple_ememalignz () -function is used. -.PP -The -.BR libsimple_enmemalignz () -and -.BR libsimple_ememalignz () -functions behaviour is unspecified if -.I n -is 0. -.SH RETURN VALUE -The -.BR libsimple_memalignz (), -.BR libsimple_enmemalignz (), -and -.BR libsimple_ememalignz () -functions return a pointer to the allocated memory -upon success completion; otherwise the -.BR libsimple_memalignz () -function return -.B NULL -and set -.I errno -it indicate the error, and the -.BR libsimple_enmemalignz () -and -.BR libsimple_ememalignz () -functions terminated the process. -.SH ERRORS -The -.BR libsimple_memalignz () -function will fail if: -.TP -.B EINVAL -.I n -is 0. -.TP -.B EINVAL -.I alignment -is not a power of two. -.TP -.B ENOMEM -Enough memory could not be allocated. -.PP -The -.BR libsimple_enmemalignz () -and -.BR libsimple_ememalignz () -functions will terminate the process on failure. -.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_memalignz (), -.br -.BR libsimple_enmemalignz (), -.br -.BR libsimple_ememalignz () -T} Thread safety MT-Safe -T{ -.BR libsimple_memalignz (), -.br -.BR libsimple_enmemalignz (), -.br -.BR libsimple_ememalignz () -T} Async-signal safety AS-Safe -T{ -.BR libsimple_memalignz (), -.br -.BR libsimple_enmemalignz (), -.br -.BR libsimple_ememalignz () -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_enmalloc (3), -.BR libsimple_mallocz (3), -.BR libsimple_vmallocn (3), -.BR libsimple_vmalloczn (3), -.BR libsimple_encalloc (3), -.BR libsimple_vcallocn (3), -.BR libsimple_enrealloc (3), -.BR libsimple_vreallocn (3), -.BR libsimple_memalign (3), -.BR libsimple_vmemalignn (3), -.BR libsimple_vmemalignzn (3), -.BR libsimple_enposix_memalign (3), -.BR libsimple_posix_memalignz (3), -.BR libsimple_vposix_memalignn (3), -.BR libsimple_vposix_memalignzn (3), -.BR libsimple_enaligned_alloc (3), -.BR libsimple_aligned_allocz (3), -.BR libsimple_valigned_allocn (3), -.BR libsimple_valigned_alloczn (3), -.BR libsimple_pvalloc (3), -.BR libsimple_pvallocz (3), -.BR libsimple_vpvallocn (3), -.BR libsimple_vpvalloczn (3), -.BR libsimple_valloc (3), -.BR libsimple_vallocz (3), -.BR libsimple_vvallocn (3), -.BR libsimple_vvalloczn (3), -.BR libsimple_vmemalloc (3), -.BR libsimple_varrayalloc (3) -- cgit v1.2.3-70-g09d2