Skip to content

Commit 15dd845

Browse files
committed
add docs
1 parent 33713c3 commit 15dd845

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,24 @@ Test project /.../inplace_vector/build
204204
Total Test time (real) = 0.01 sec
205205
```
206206

207+
## Build arguments
208+
209+
### Disable dynamic size type in control block
210+
211+
By default,
212+
the type of the size variable in the control block is selected to the smallest
213+
it could be
214+
(as an upper bound can be established given we know the capacity of the vector).
215+
216+
You can turn off this behavior by setting `BEMAN_INPLACE_VECTOR_FIXED_SIZE_T`
217+
to `ON`, which fixes the type to `std::size_t`.
218+
219+
Example: configuring the project with fixed size type.
220+
221+
```bash
222+
cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DBEMAN_INPLACE_VECTOR_FIXED_SIZE_T=ON
223+
```
224+
207225
## Development
208226

209227
### Linting

0 commit comments

Comments
 (0)