Browse code

better .gitignore, move API to more prominent place in README

Nat! authored on 20/10/2016 15:37:55
Showing 6 changed files
... ...
@@ -37,4 +37,7 @@ tests/vararg/longlong/longlong_longlong
37 37
 tests/vararg/longlong/pointer_longlong
38 38
 tests/vararg/pointer/double_pointer
39 39
 tests/vararg/pointer/int_pointer
40
-tests/vararg/pointer/longlong_pointer
41 40
\ No newline at end of file
41
+tests/vararg/pointer/longlong_pointer
42
+/tests/mulle-tests/
43
+*.exe.debug
44
+*.exe.debug.dSYM
... ...
@@ -45,6 +45,10 @@ struct
45 45
 **mulle-vararg** provides the necessary functions to read such a struct. It has
46 46
 no code to create it.
47 47
 
48
+## API
49
+
50
+* [API](dox/API_VARARG.md)
51
+
48 52
 
49 53
 ## Install
50 54
 
... ...
@@ -63,17 +67,11 @@ On other platforms you can use **mulle-install** from
63 63
 mulle-install --prefix /usr/local --branch release https://www.mulle-kybernetik.com/repositories/mulle-vararg
64 64
 ```
65 65
 
66
-
67 66
 Otherwise read:
68 67
 
69 68
 * [How to Build](dox/BUILD.md)
70 69
 
71 70
 
72
-## API
73
-
74
-* [Vararg](dox/API_VARARG.md)
75
-
76
-
77 71
 ### Platforms and Compilers
78 72
 
79 73
 All platforms and compilers supported by
... ...
@@ -1,4 +1,5 @@
1
-## 0.5.1-0.5.3
1
+0.5.1-0.5.4
2
+===
2 3
 
3 4
 * improve release script and documentation
4 5
 
... ...
@@ -9,6 +9,11 @@ DEPENDENCIES="mulle-c11" # names not camel case
9 9
 ORIGIN=public            # git repo to push
10 10
 LANGUAGE=c               # c,cpp, objc
11 11
 
12
+##
13
+## In optimal cases, you don't edit anything hereafter
14
+##
15
+MULLE_BOOTSTRAP_FAIL_PREFIX="release.sh"
16
+
12 17
 . ./bin/mulle-homebrew/mulle-homebrew.sh
13 18
 
14 19
 # parse options
... ...
@@ -59,7 +59,7 @@ Type                | Description
59 59
 ## Macros
60 60
 
61 61
 
62
-### mulle_vararg_copy - copy varargs
62
+### `mulle_vararg_copy`
63 63
 
64 64
 `mulle_vararg_copy( dst, src)`
65 65
 
... ...
@@ -67,14 +67,14 @@ Copy `mulle_vararg_list` **src** to **dst**. Use this if you want to iterate
67 67
 a second time over a `mulle_vararg_list` argument.
68 68
 
69 69
 
70
-#### mulle_vararg_end - end varargs
70
+### `mulle_vararg_end`
71 71
 
72 72
 `mulle_vararg_end( args)`
73 73
 
74 74
 Marks the end of the use of **args** `mulle_vararg_list` variable.
75 75
 
76 76
 
77
-#### mulle_vararg_next_fp - next floating point value
77
+### `mulle_vararg_next_fp`
78 78
 
79 79
 `mulle_vararg_next_fp( args, type)`
80 80
 
... ...
@@ -88,7 +88,7 @@ mulle_vararg_next_fp( args, float);
88 88
 ```
89 89
 
90 90
 
91
-#### mulle_vararg_next_integer - next integer value
91
+### `mulle_vararg_next_integer`
92 92
 
93 93
 `mulle_vararg_next_integer( args, type)`
94 94
 
... ...
@@ -102,7 +102,7 @@ mulle_vararg_next_integer( args, unsigned short);
102 102
 ```
103 103
 
104 104
 
105
-#### mulle_vararg_next_pointer - next pointer value
105
+### `mulle_vararg_next_pointer`
106 106
 
107 107
 `mulle_vararg_next_pointer( args, type)`
108 108
 
... ...
@@ -115,11 +115,11 @@ mulle_vararg_next_pointer( args, int *);
115 115
 ```
116 116
 
117 117
 
118
-#### mulle_vararg_next_struct - next struct value
118
+### `mulle_vararg_next_struct`
119 119
 
120 120
 `mulle_vararg_next_struct( args, type)`
121 121
 
122
-Use it for all struct types.
122
+Get the next struct value. Use it for all struct types.
123 123
 
124 124
 Example:
125 125
 
... ...
@@ -134,10 +134,11 @@ x = mulle_vararg_next_struct( args, struct x_t);
134 134
 ```
135 135
 
136 136
 
137
-#### _mulle_vararg_next_struct - next address of struct
137
+### _mulle_vararg_next_struct
138 138
 
139 139
 `_mulle_vararg_next_struct( args, type)`
140 140
 
141
+Get the address of the next struct.
141 142
 Use it for all struct types. The struct will not be copied, but
142 143
 instead you get a reference into the varargs. This is obviously more
143 144
 risky!
... ...
@@ -155,11 +156,11 @@ x = mulle_vararg_next_struct( args, struct x_t);
155 155
 ```
156 156
 
157 157
 
158
-#### mulle_vararg_next_union - next union value
158
+### `mulle_vararg_next_union`
159 159
 
160 160
 `mulle_vararg_next_union( args, type)`
161 161
 
162
-Use it for all union types.
162
+Get the next union value. Use it for all union types.
163 163
 
164 164
 Example:
165 165
 
... ...
@@ -173,7 +174,7 @@ union x_t
173 173
 x = mulle_vararg_next_union( args, union x_t);
174 174
 ```
175 175
 
176
-#### _mulle_vararg_next_union - get address of next union
176
+### _mulle_vararg_next_union - get address of next union
177 177
 
178 178
 `_mulle_vararg_next_union( args, type)`
179 179
 
... ...
@@ -195,10 +196,11 @@ x = mulle_vararg_next_union( args, struct x_t);
195 195
 
196 196
 
197 197
 
198
-#### mulle_vararg_start - start varargs
198
+### mulle_vararg_start
199 199
 
200 200
 `mulle_vararg_start( args, ap)`
201 201
 
202
+Start the variable argument access.
202 203
 **args** is a `mulle_vararg_list` variable. **ap** is the last non-variable
203 204
 argument.
204 205
 
... ...
@@ -206,7 +208,7 @@ argument.
206 206
 ## Functions
207 207
 
208 208
 
209
-####  mulle_address_align - align an address
209
+###  mulle_address_align
210 210
 
211 211
 `uintptr_t   mulle_address_align( uintptr_t p, unsigned int alignment)`
212 212
 
... ...
@@ -216,7 +218,7 @@ will return the aligned address.
216 216
 e.g. `mulle_address_align( 0x11, 0x10)` will return `0x20`
217 217
 
218 218
 
219
-####  mulle_pointer_align - align a pointer
219
+###  mulle_pointer_align
220 220
 
221 221
 `void   *mulle_pointer_align( void *p, unsigned int alignment)`
222 222
 
... ...
@@ -224,7 +226,7 @@ Pass in a pointer **p** and an alignment **alignment**. `mulle_align_pointer`
224 224
 will return the aligned pointer.
225 225
 
226 226
 
227
-####  mulle_vararg_count_pointers - count null terminated vararg pointers
227
+###  mulle_vararg_count_pointers - count null terminated vararg pointers
228 228
 
229 229
 `size_t   mulle_vararg_count_pointers( mulle_vararg_list args, void *p)`
230 230
 
... ...
@@ -11,7 +11,7 @@
11 11
 
12 12
 #include "mulle_align.h"
13 13
 
14
-#define MULLE_VARARG_VERSION  ((0 << 20) | (5 << 8) | 3)
14
+#define MULLE_VARARG_VERSION  ((0 << 20) | (5 << 8) | 4)
15 15
 
16 16
 
17 17
 /*