patch-docs_man3_qblist_h_3 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  1. --- libqb-0.16.0.orig/docs/man3/qblist.h.3 2013-07-25 20:16:18.000000000 +0200
  2. +++ libqb-0.16.0/docs/man3/qblist.h.3 2013-09-09 05:26:31.607808856 +0200
  3. @@ -1,4 +1,4 @@
  4. -.TH "qblist.h" 3 "Thu Jul 25 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  5. +.TH "qblist.h" 3 "Mon Sep 9 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  6. .ad l
  7. .nh
  8. .SH NAME
  9. @@ -21,7 +21,7 @@ This is a kernel style list implementati
  10. .RI "struct \fBqb_list_head\fP"
  11. .br
  12. .in -1c
  13. -.SS "Macros"
  14. +.SS "Defines"
  15. .in +1c
  16. .ti -1c
  17. @@ -122,26 +122,23 @@ This is a kernel style list implementati
  18. \fBAuthor:\fP
  19. .RS 4
  20. -Steven Dake sdake@redhat.com
  21. +Steven Dake <sdake@redhat.com>
  22. .RE
  23. .PP
  24. -.SH "Macro Definition Documentation"
  25. +.SH "Define Documentation"
  26. .PP
  27. -.SS "#define QB_INIT_LIST_HEAD(ptr)"
  28. -\fBValue:\fP
  29. +.SS "#define \fBQB_INIT_LIST_HEAD\fP(ptr)"\fBValue:\fP
  30. .PP
  31. .nf
  32. do { \
  33. (ptr)->next = (ptr); (ptr)->prev = (ptr); \
  34. } while (0)
  35. .fi
  36. -.SS "#define QB_LIST_DECLARE(name) struct \fBqb_list_head\fP name = { &(name), &(name) }"
  37. -
  38. +.SS "#define \fBQB_LIST_DECLARE\fP(name) struct \fBqb_list_head\fP name = { &(name), &(name) }"
  39. .PP
  40. Declare and initialize a list head\&.
  41. -.SS "#define qb_list_entry(ptr, type, member) ((type *)((char *)(ptr)-(char*)(&((type *)0)->member)))"
  42. -
  43. +.SS "#define \fBqb_list_entry\fP(ptr, type, member) ((type *)((char *)(ptr)-(char*)(&((type *)0)->member)))"
  44. .PP
  45. Get the struct for this entry\&. \fBParameters:\fP
  46. .RS 4
  47. @@ -153,8 +150,7 @@ Get the struct for this entry\&. \fBPara
  48. .RE
  49. .PP
  50. -.SS "#define qb_list_first_entry(ptr, type, member) \fBqb_list_entry\fP((ptr)->next, type, member)"
  51. -
  52. +.SS "#define \fBqb_list_first_entry\fP(ptr, type, member) \fBqb_list_entry\fP((ptr)->next, type, member)"
  53. .PP
  54. Get the first element from a list\&. \fBParameters:\fP
  55. .RS 4
  56. @@ -166,8 +162,7 @@ Get the first element from a list\&. \fB
  57. .RE
  58. .PP
  59. -.SS "#define qb_list_for_each(pos, head) for (pos = (head)->next; pos != (head); pos = pos->next)"
  60. -
  61. +.SS "#define \fBqb_list_for_each\fP(pos, head) for (pos = (head)->next; pos != (head); pos = pos->next)"
  62. .PP
  63. Iterate over a list\&. \fBParameters:\fP
  64. .RS 4
  65. @@ -179,8 +174,7 @@ Iterate over a list\&. \fBParameters:\fP
  66. .PP
  67. Referenced by qb_list_length()\&.
  68. -.SS "#define qb_list_for_each_entry(pos, head, member)"
  69. -\fBValue:\fP
  70. +.SS "#define \fBqb_list_for_each_entry\fP(pos, head, member)"\fBValue:\fP
  71. .PP
  72. .nf
  73. for (pos = qb_list_entry((head)->next, typeof(*pos), member); \
  74. @@ -198,8 +192,7 @@ Iterate over list of given type\&. \fBPa
  75. .RE
  76. .PP
  77. -.SS "#define qb_list_for_each_entry_from(pos, head, member)"
  78. -\fBValue:\fP
  79. +.SS "#define \fBqb_list_for_each_entry_from\fP(pos, head, member)"\fBValue:\fP
  80. .PP
  81. .nf
  82. for (; &pos->member != (head); \
  83. @@ -216,8 +209,7 @@ Iterate over list of given type from the
  84. .RE
  85. .PP
  86. -.SS "#define qb_list_for_each_entry_reverse(pos, head, member)"
  87. -\fBValue:\fP
  88. +.SS "#define \fBqb_list_for_each_entry_reverse\fP(pos, head, member)"\fBValue:\fP
  89. .PP
  90. .nf
  91. for (pos = qb_list_entry((head)->prev, typeof(*pos), member); \
  92. @@ -235,8 +227,7 @@ Iterate backwards over list of given typ
  93. .RE
  94. .PP
  95. -.SS "#define qb_list_for_each_entry_safe(pos, n, head, member)"
  96. -\fBValue:\fP
  97. +.SS "#define \fBqb_list_for_each_entry_safe\fP(pos, n, head, member)"\fBValue:\fP
  98. .PP
  99. .nf
  100. for (pos = qb_list_entry((head)->next, typeof(*pos), member), \
  101. @@ -257,8 +248,7 @@ Iterate over list of given type safe aga
  102. .RE
  103. .PP
  104. -.SS "#define qb_list_for_each_entry_safe_reverse(pos, n, head, member)"
  105. -\fBValue:\fP
  106. +.SS "#define \fBqb_list_for_each_entry_safe_reverse\fP(pos, n, head, member)"\fBValue:\fP
  107. .PP
  108. .nf
  109. for (pos = qb_list_entry((head)->prev, typeof(*pos), member), \
  110. @@ -279,8 +269,7 @@ Iterate backwards over list safe against
  111. .RE
  112. .PP
  113. -.SS "#define qb_list_for_each_reverse(pos, head) for (pos = (head)->prev; pos != (head); pos = pos->prev)"
  114. -
  115. +.SS "#define \fBqb_list_for_each_reverse\fP(pos, head) for (pos = (head)->prev; pos != (head); pos = pos->prev)"
  116. .PP
  117. Iterate over a list backwards\&. \fBParameters:\fP
  118. .RS 4
  119. @@ -290,8 +279,7 @@ Iterate over a list backwards\&. \fBPara
  120. .RE
  121. .PP
  122. -.SS "#define qb_list_for_each_safe(pos, n, head)"
  123. -\fBValue:\fP
  124. +.SS "#define \fBqb_list_for_each_safe\fP(pos, n, head)"\fBValue:\fP
  125. .PP
  126. .nf
  127. for (pos = (head)->next, n = pos->next; pos != (head); \
  128. @@ -310,8 +298,7 @@ Iterate over a list safe against removal
  129. .SH "Function Documentation"
  130. .PP
  131. -.SS "static void qb_list_add (struct \fBqb_list_head\fP *element, struct \fBqb_list_head\fP *head)\fC [inline]\fP, \fC [static]\fP"
  132. -
  133. +.SS "static void \fBqb_list_add\fP (struct \fBqb_list_head\fP *element, struct \fBqb_list_head\fP *head)\fC [inline, static]\fP"
  134. .PP
  135. Add this element to the list\&. \fBParameters:\fP
  136. .RS 4
  137. @@ -323,8 +310,7 @@ Add this element to the list\&. \fBParam
  138. .PP
  139. References qb_list_head::next, and qb_list_head::prev\&.
  140. -.SS "static void qb_list_add_tail (struct \fBqb_list_head\fP *element, struct \fBqb_list_head\fP *head)\fC [inline]\fP, \fC [static]\fP"
  141. -
  142. +.SS "static void \fBqb_list_add_tail\fP (struct \fBqb_list_head\fP *element, struct \fBqb_list_head\fP *head)\fC [inline, static]\fP"
  143. .PP
  144. Add to the list (but at the end of the list)\&. \fBParameters:\fP
  145. .RS 4
  146. @@ -333,7 +319,7 @@ Add to the list (but at the end of the l
  147. \fIhead\fP pointer to the list head
  148. .RE
  149. .PP
  150. -\fBSee Also:\fP
  151. +\fBSee also:\fP
  152. .RS 4
  153. \fBqb_list_add()\fP
  154. .RE
  155. @@ -341,8 +327,7 @@ Add to the list (but at the end of the l
  156. .PP
  157. References qb_list_head::next, and qb_list_head::prev\&.
  158. -.SS "static void qb_list_del (struct \fBqb_list_head\fP *_remove)\fC [inline]\fP, \fC [static]\fP"
  159. -
  160. +.SS "static void \fBqb_list_del\fP (struct \fBqb_list_head\fP *_remove)\fC [inline, static]\fP"
  161. .PP
  162. Delete an entry from the list\&. \fBParameters:\fP
  163. .RS 4
  164. @@ -352,8 +337,7 @@ Delete an entry from the list\&. \fBPara
  165. .PP
  166. References qb_list_head::next, and qb_list_head::prev\&.
  167. -.SS "static int32_t qb_list_empty (const struct \fBqb_list_head\fP *head)\fC [inline]\fP, \fC [static]\fP"
  168. -
  169. +.SS "static int32_t \fBqb_list_empty\fP (const struct \fBqb_list_head\fP *head)\fC [inline, static]\fP"
  170. .PP
  171. A quick test to see if the list is empty (pointing to it's self)\&. \fBParameters:\fP
  172. .RS 4
  173. @@ -370,8 +354,7 @@ boolean true/false
  174. References qb_list_head::next\&.
  175. .PP
  176. Referenced by qb_list_splice(), and qb_list_splice_tail()\&.
  177. -.SS "static void qb_list_init (struct \fBqb_list_head\fP *head)\fC [inline]\fP, \fC [static]\fP"
  178. -
  179. +.SS "static void \fBqb_list_init\fP (struct \fBqb_list_head\fP *head)\fC [inline, static]\fP"
  180. .PP
  181. Initialize the list entry\&. Points next and prev pointers to head\&.
  182. .PP
  183. @@ -383,8 +366,7 @@ Initialize the list entry\&. Points next
  184. .PP
  185. References qb_list_head::next, and qb_list_head::prev\&.
  186. -.SS "static int qb_list_is_last (const struct \fBqb_list_head\fP *list, const struct \fBqb_list_head\fP *head)\fC [inline]\fP, \fC [static]\fP"
  187. -
  188. +.SS "static int \fBqb_list_is_last\fP (const struct \fBqb_list_head\fP *list, const struct \fBqb_list_head\fP *head)\fC [inline, static]\fP"
  189. .PP
  190. Tests whether list is the last entry in list head\&. \fBParameters:\fP
  191. .RS 4
  192. @@ -401,8 +383,7 @@ boolean true/false
  193. .PP
  194. References qb_list_head::next\&.
  195. -.SS "static int32_t qb_list_length (struct \fBqb_list_head\fP *head)\fC [inline]\fP, \fC [static]\fP"
  196. -
  197. +.SS "static int32_t \fBqb_list_length\fP (struct \fBqb_list_head\fP *head)\fC [inline, static]\fP"
  198. .PP
  199. Count the number of items in the list\&. \fBParameters:\fP
  200. .RS 4
  201. @@ -417,8 +398,7 @@ length of the list\&.
  202. .PP
  203. References qb_list_for_each\&.
  204. -.SS "static void qb_list_replace (struct \fBqb_list_head\fP *old, struct \fBqb_list_head\fP *new)\fC [inline]\fP, \fC [static]\fP"
  205. -
  206. +.SS "static void \fBqb_list_replace\fP (struct \fBqb_list_head\fP *old, struct \fBqb_list_head\fP *new)\fC [inline, static]\fP"
  207. .PP
  208. Replace old entry by new one\&. \fBParameters:\fP
  209. .RS 4
  210. @@ -430,8 +410,7 @@ Replace old entry by new one\&. \fBParam
  211. .PP
  212. References qb_list_head::next, and qb_list_head::prev\&.
  213. -.SS "static void qb_list_splice (struct \fBqb_list_head\fP *list, struct \fBqb_list_head\fP *head)\fC [inline]\fP, \fC [static]\fP"
  214. -
  215. +.SS "static void \fBqb_list_splice\fP (struct \fBqb_list_head\fP *list, struct \fBqb_list_head\fP *head)\fC [inline, static]\fP"
  216. .PP
  217. Join two lists\&. \fBParameters:\fP
  218. .RS 4
  219. @@ -448,8 +427,7 @@ The 'list' is reinitialised
  220. .PP
  221. References qb_list_head::next, qb_list_head::prev, and qb_list_empty()\&.
  222. -.SS "static void qb_list_splice_tail (struct \fBqb_list_head\fP *list, struct \fBqb_list_head\fP *head)\fC [inline]\fP, \fC [static]\fP"
  223. -
  224. +.SS "static void \fBqb_list_splice_tail\fP (struct \fBqb_list_head\fP *list, struct \fBqb_list_head\fP *head)\fC [inline, static]\fP"
  225. .PP
  226. Join two lists, each list being a queue\&. \fBParameters:\fP
  227. .RS 4