manual/macros.texi

   1 @c Define common macros used to keep phrasing consistent in the manual.
   2
   3 @ifclear MACROS
   4 @set MACROS
   5
   6 @c Names used to refer to the library, as noun phrases at the start or
   7 @c not at the start of a sentence.
   8 @macro Theglibc
   9 The GNU C Library
  10 @end macro
  11 @macro theglibc
  12 the GNU C Library
  13 @end macro
  14
  15 @c Name used to refer to the library as an adjective.
  16 @macro glibcadj
  17 GNU C Library
  18 @end macro
  19
  20 @c Description applying to all GNU systems; that is, used in
  21 @c describing a property of a system such that no system without that
  22 @c property would be considered a variant of the GNU system.
  23 @macro gnusystems
  24 GNU systems
  25 @end macro
  26
  27 @c Systems that are not GNU systems.
  28 @macro nongnusystems
  29 non-GNU systems
  30 @end macro
  31
  32 @c Description applying to GNU/Linux and GNU/Hurd systems, but not
  33 @c necessarily to other variants of the GNU system.
  34 @macro gnulinuxhurdsystems
  35 GNU/Linux and GNU/Hurd systems
  36 @end macro
  37
  38 @c Descrption applying to GNU/Hurd systems; that is, systems using the
  39 @c GNU Hurd with the GNU C Library.
  40 @macro gnuhurdsystems
  41 GNU/Hurd systems
  42 @end macro
  43
  44 @c Descrption applying to GNU/Linux systems; that is, systems using
  45 @c the Linux kernel with the GNU C Library.
  46 @macro gnulinuxsystems
  47 GNU/Linux systems
  48 @end macro
  49
  50 @c Document the safety functions as preliminary.  It does NOT expand its
  51 @c comments.
  52 @macro prelim {comments}
  53 Preliminary:
  54
  55 @end macro
  56 @c Document a function as thread safe.
  57 @macro mtsafe {comments}
  58 | MT-Safe \comments\
  59
  60 @end macro
  61 @c Document a function as thread unsafe.
  62 @macro mtunsafe {comments}
  63 | MT-Unsafe \comments\
  64
  65 @end macro
  66 @c Document a function as safe for use in asynchronous signal handlers.
  67 @macro assafe {comments}
  68 | AS-Safe \comments\
  69
  70 @end macro
  71 @c Document a function as unsafe for use in asynchronous signal
  72 @c handlers.  This distinguishes unmarked functions, for which this
  73 @c property has not been assessed, from those that have been analyzed.
  74 @macro asunsafe {comments}
  75 | AS-Unsafe \comments\
  76
  77 @end macro
  78 @c Document a function as safe for use when asynchronous cancellation is
  79 @c enabled.
  80 @macro acsafe {comments}
  81 | AC-Safe \comments\
  82
  83 @end macro
  84 @c Document a function as unsafe for use when asynchronous cancellation
  85 @c is enabled.  This distinguishes unmarked functions, for which this
  86 @c property has not been assessed, from those that have been analyzed.
  87 @macro acunsafe {comments}
  88 | AC-Unsafe \comments\
  89
  90 @end macro
  91 @c Format safety properties without referencing the section of the
  92 @c definitions.  To be used in the definitions of the properties
  93 @c themselves.
  94 @macro sampsafety {notes}
  95 @noindent
  96 \notes\|
  97
  98
  99 @end macro
 100 @c Format the safety properties of a function.
 101 @macro safety {notes}
 102 \notes\| @xref{POSIX Safety Concepts}.
 103
 104
 105 @end macro
 106 @macro mtasurace {comments}
 107 race\comments\
 108 @end macro
 109 @macro asurace {comments}
 110 race\comments\
 111 @end macro
 112 @macro mtsrace {comments}
 113 race\comments\
 114 @end macro
 115 @macro mtasuconst {comments}
 116 const\comments\
 117 @end macro
 118 @macro mtslocale {comments}
 119 locale\comments\
 120 @end macro
 121 @macro mtsenv {comments}
 122 env\comments\
 123 @end macro
 124 @macro mtshostid {comments}
 125 hostid\comments\
 126 @end macro
 127 @macro mtssigintr {comments}
 128 sigintr\comments\
 129 @end macro
 130 @macro mtuinit {comments}
 131 init\comments\
 132 @end macro
 133 @macro asuinit {comments}
 134 init\comments\
 135 @end macro
 136 @macro acuinit {comments}
 137 init\comments\
 138 @end macro
 139 @macro asulock {comments}
 140 lock\comments\
 141 @end macro
 142 @macro aculock {comments}
 143 lock\comments\
 144 @end macro
 145 @macro asucorrupt {comments}
 146 corrupt\comments\
 147 @end macro
 148 @macro acucorrupt {comments}
 149 corrupt\comments\
 150 @end macro
 151 @macro ascuheap {comments}
 152 heap\comments\
 153 @end macro
 154 @macro asuheap {comments}
 155 heap\comments\
 156 @end macro
 157 @macro ascudlopen {comments}
 158 dlopen\comments\
 159 @end macro
 160 @macro ascuplugin {comments}
 161 plugin\comments\
 162 @end macro
 163 @macro ascuintl {comments}
 164 i18n\comments\
 165 @end macro
 166 @macro asuintl {comments}
 167 i18n\comments\
 168 @end macro
 169 @macro acsfd {comments}
 170 fd\comments\
 171 @end macro
 172 @macro acsmem {comments}
 173 mem\comments\
 174 @end macro
 175 @macro mtascusig {comments}
 176 sig\comments\
 177 @end macro
 178 @macro mtasuterm {comments}
 179 term\comments\
 180 @end macro
 181 @macro acuterm {comments}
 182 term\comments\
 183 @end macro
 184 @macro mtstimer {comments}
 185 timer\comments\
 186 @end macro
 187 @macro mtascutimer {comments}
 188 timer\comments\
 189 @end macro
 190 @macro mtasscwd {comments}
 191 cwd\comments\
 192 @end macro
 193 @macro acscwd {comments}
 194 cwd\comments\
 195 @end macro
 196 @macro mtsposix {comments}
 197 !posix\comments\
 198 @end macro
 199 @macro mtuposix {comments}
 200 !posix\comments\
 201 @end macro
 202 @macro assposix {comments}
 203 !posix\comments\
 204 @end macro
 205 @macro asuposix {comments}
 206 !posix\comments\
 207 @end macro
 208 @macro acsposix {comments}
 209 !posix\comments\
 210 @end macro
 211 @macro acuposix {comments}
 212 !posix\comments\
 213 @end macro
 214
 215 @end ifclear