Commit | Line | Data |
---|---|---|
7c7ba2aa MW |
1 | .\" -*-nroff-*- |
2 | .TH align 3 "4 January 2009" "Straylight/Edgeware" "mLib utilities library" | |
3 | .SH NAME | |
4 | align \- alignment utilities | |
5 | .\" @ALIGN | |
6 | .SH SYNOPSIS | |
7 | .nf | |
8 | .B "#include <mLib/align.h>" | |
9 | ||
10 | .BI "size_t ALIGN(size_t " sz ");" | |
11 | .fi | |
12 | .SH DESCRIPTION | |
13 | The | |
14 | .B ALIGN | |
15 | macro returns the value of its argument | |
16 | .I sz | |
17 | rounded up to the next multiple of the size of | |
18 | .BR "union align" , | |
19 | which is defined as a union containing a selection of built-in types. | |
20 | The intent is to write fairly portable memory allocators, which must | |
21 | return correctly-aligned memory. | |
22 | .IR array . | |
23 | .SH "SEE ALSO" | |
24 | .BR mLib (3). | |
25 | .SH "AUTHOR" | |
26 | Mark Wooding, <mdw@distorted.org.uk> |