Gareth Rees
3f3c0e6e69
Correct rest syntax for bulleted list.
...
Copied from Perforce
Change: 188192
ServerID: perforce.ravenbrook.com
2015-09-01 13:05:33 +01:00
Gareth Rees
ae6473fba8
Keyword argument mps_key_rank is optional when creating an allocation point for an snc pool.
...
Copied from Perforce
Change: 188178
ServerID: perforce.ravenbrook.com
2015-08-26 12:31:03 +01:00
Gareth Rees
9e6116c0ba
Bring release notes up to date.
...
Copied from Perforce
Change: 188126
ServerID: perforce.ravenbrook.com
2015-08-11 09:46:46 +01:00
Gareth Rees
e10e3b50b1
Documentation corrections and improvements.
...
Copied from Perforce
Change: 187479
ServerID: perforce.ravenbrook.com
2014-11-06 22:54:40 +00:00
Gareth Rees
6907a9287c
Deprecate mps_mv_free_size, mps_mv_size, mps_mvff_free_size, mps_mvff_size, mps_mvt_free_size and mps_mvt_size.
...
Move most of the deprecated material to a new chapter of the manual (to avoid clutter and confusion) and ensure that each deprecated symbol has a recommendation for what to do instead.
Copied from Perforce
Change: 187471
ServerID: perforce.ravenbrook.com
2014-11-06 14:56:15 +00:00
Gareth Rees
bff6ac8fea
There's no such type as mps_count_t, so don't refer to it in the documentation!
...
Copied from Perforce
Change: 187191
ServerID: perforce.ravenbrook.com
2014-10-10 17:17:38 +01:00
Gareth Rees
5ef6fc2ea4
It's now safe to allocate large objects in mvff pools.
...
Copied from Perforce
Change: 187180
ServerID: perforce.ravenbrook.com
2014-10-10 12:43:20 +01:00
Gareth Rees
665ab2f848
Don't talk about "segments" in the pool documentation (this is a detail of the implementation, and may change).
...
The restriction that "buffered allocation can't allocate across segment boundaries" no longer affects MVFF as the pool no longer uses segments.
Copied from Perforce
Change: 187179
ServerID: perforce.ravenbrook.com
2014-10-10 12:42:29 +01:00
Gareth Rees
39e8b866cf
Rename mps_class_t to mps_pool_class_t for clarity.
...
Retain a typedef for mps_class_t for backwards compatibility.
Copied from Perforce
Change: 187065
ServerID: perforce.ravenbrook.com
2014-09-27 13:37:38 +01:00
Gareth Rees
eb2c7fa6d2
Fix typo.
...
Copied from Perforce
Change: 186818
ServerID: perforce.ravenbrook.com
2014-07-04 00:39:29 +01:00
Gareth Rees
5cd56a290f
Provide a default value for mps_key_awl_find_dependent.
...
Copied from Perforce
Change: 186784
ServerID: perforce.ravenbrook.com
2014-07-02 10:39:28 +01:00
Gareth Rees
b58f389f9a
Fix typo.
...
Copied from Perforce
Change: 186750
ServerID: perforce.ravenbrook.com
2014-06-28 20:03:15 +01:00
Gareth Rees
83698f9ef4
Refer to keyword-taking version of creation function.
...
Copied from Perforce
Change: 186716
ServerID: perforce.ravenbrook.com
2014-06-20 15:25:48 +01:00
David Lovemore
3b97cae580
Catch up merge from master/...@186577
...
Copied from Perforce
Change: 186582
ServerID: perforce.ravenbrook.com
2014-06-13 16:38:20 +01:00
David Lovemore
cb517707c9
Remove documentation for mps_key_large_size.
...
Copied from Perforce
Change: 186576
ServerID: perforce.ravenbrook.com
2014-06-13 15:43:30 +01:00
Gareth Rees
365e431f21
Catch-up merge from master sources @186481 to branch/2014-04-15/mvffnoseg.
...
Copied from Perforce
Change: 186484
ServerID: perforce.ravenbrook.com
2014-06-11 12:42:58 +01:00
David Lovemore
c14a0e5e3e
Amc now respects mps_key_extend_by keyword argument.
...
AMC also uses MPS_KEY_LARGE_SIZE keyword argument to specify what size objects need to be to live on their own segment.
Copied from Perforce
Change: 186480
ServerID: perforce.ravenbrook.com
2014-06-11 12:12:44 +01:00
Gareth Rees
f19782ae62
Note that mps_key_pool_debug_options is optional, and describe the default value. noted by rb in review < https://info.ravenbrook.com/mail/2014/06/04/14-41-06/0/ >.
...
Copied from Perforce
Change: 186441
ServerID: perforce.ravenbrook.com
2014-06-08 17:15:02 +01:00
Gareth Rees
331d260bfd
Catch-up merge from master sources @186436 to branch/2014-04-08/align.
...
Copied from Perforce
Change: 186439
ServerID: perforce.ravenbrook.com
2014-06-08 16:30:53 +01:00
Gareth Rees
0449a44337
Amc supports interior pointers.
...
Copied from Perforce
Change: 186364
ServerID: perforce.ravenbrook.com
2014-05-30 11:36:52 +01:00
Gareth Rees
75e502fc7b
Catch-up merge from master sources @186352 to branch/2014-04-15/mvffnoseg.
...
Copied from Perforce
Change: 186355
ServerID: perforce.ravenbrook.com
2014-05-29 16:03:34 +01:00
Gareth Rees
f39c3d27ff
Documentation improvements suggests by bruce mitchener:
...
* Fix cross-references to mps_pool_debug_option_s
* Link pool classes in the header of the table of pool class properties
Copied from Perforce
Change: 186150
ServerID: perforce.ravenbrook.com
2014-05-17 09:30:45 +01:00
Gareth Rees
12de34f5f4
Update release notes.
...
Copied from Perforce
Change: 186087
ServerID: perforce.ravenbrook.com
2014-05-13 17:31:43 +01:00
Gareth Rees
7084978cf2
Document mps_key_spare keyword argument.
...
Copied from Perforce
Change: 186085
ServerID: perforce.ravenbrook.com
2014-05-13 17:21:25 +01:00
Gareth Rees
d377539ae7
Default value for mps_key_ams_support_ambiguous is now the safer value true.
...
Copied from Perforce
Change: 185927
ServerID: perforce.ravenbrook.com
2014-05-01 18:02:53 +01:00
Gareth Rees
b6c1faff35
Fix typo.
...
Copied from Perforce
Change: 185649
ServerID: perforce.ravenbrook.com
2014-04-18 00:41:33 +01:00
Gareth Rees
25dc0fc073
Document the constraints on the mean and maximum size arguments to the mv pool class. remove documentation from poolmv.h: this is in the manual now.
...
Copied from Perforce
Change: 185432
ServerID: perforce.ravenbrook.com
2014-04-10 15:36:51 +01:00
Gareth Rees
07853f0c33
Alas, mvff and mvt can't round up alignment because they need to support buffered allocation.
...
Copied from Perforce
Change: 185381
ServerID: perforce.ravenbrook.com
2014-04-09 13:01:58 +01:00
Gareth Rees
88626830d8
Alignment is now configurable for mv pools using mps_key_align.
...
MVFF and MVT support alignments down to FreelistMinimumAlignment.
For MVFF and MVT, alignments that are too small are rounded up automatically, to make it easier to write portable programs.
Copied from Perforce
Change: 185369
ServerID: perforce.ravenbrook.com
2014-04-08 21:32:19 +01:00
Gareth Rees
284482353a
The alignment of an awl pool is now set to the format alignment, as documented. the alignment restriction on pointers is now based on sizeof(void *), not mps_pf_align.
...
Copied from Perforce
Change: 185357
ServerID: perforce.ravenbrook.com
2014-04-08 18:29:25 +01:00
Gareth Rees
3db904ee46
Document mps_key_interior for amcz, and mention it in the pool introduction.
...
Copied from Perforce
Change: 185128
ServerID: perforce.ravenbrook.com
2014-04-01 17:13:47 +01:00
Gareth Rees
fc7bdbd4dd
Fixed dl's review comments < https://info.ravenbrook.com/mail/2014/04/01/13-28-17/0/ >.
...
Copied from Perforce
Change: 185127
ServerID: perforce.ravenbrook.com
2014-04-01 17:02:00 +01:00
Gareth Rees
b179fa4000
Document amc and amcz support for ambiguous interior references.
...
Copied from Perforce
Change: 185065
ServerID: perforce.ravenbrook.com
2014-03-27 21:31:08 +00:00
Gareth Rees
ac55d519bf
Merge branch/2014-02-26/args-done into master sources.
...
Copied from Perforce
Change: 184554
ServerID: perforce.ravenbrook.com
2014-02-26 13:47:56 +00:00
Gareth Rees
32d10cd02a
Make mps_args_done obsolete.
...
Copied from Perforce
Change: 184543
ServerID: perforce.ravenbrook.com
2014-02-26 12:47:27 +00:00
Gareth Rees
dcdd1d4840
Remove duplicate documentation for mps_key_chain argument to ams.
...
Write "takes" instead of "requires" when documenting keyword arguments for debugging pool classes.
Copied from Perforce
Change: 184540
ServerID: perforce.ravenbrook.com
2014-02-26 12:23:21 +00:00
Gareth Rees
d2220c5c16
Better user documentation for generation chains:
...
* In the pool class properties table, note whether a pool class uses generational garbage collection.
* The arena has a default generation chain.
* The MPS_KEY_CHAIN keyword argument is now optional when creating an AMC, AMCZ or AMS pool.
* The pool classes AWL and LO now take an optional MPS_KEY_CHAIN keyword argument.
* The pool classes AMS, AWL and LO now take an optional MPS_KEY_GEN keyword argument specifying the generation for new objects.
* Remove material about generation chains from the user guide (just use the arena's default generation chain).
Copied from Perforce
Change: 184273
ServerID: perforce.ravenbrook.com
2014-01-31 16:23:04 +00:00
Gareth Rees
b5eac5fb83
Use #. for numbered lists instead of 1. 2. 3. to make these documents easier to edit.
...
Copied from Perforce
Change: 183913
ServerID: perforce.ravenbrook.com
2014-01-10 09:58:44 +00:00
Gareth Rees
ac61bf3438
Fix broken formatting.
...
Copied from Perforce
Change: 183517
ServerID: perforce.ravenbrook.com
2013-10-02 16:05:24 +01:00
Gareth Rees
6971ab5691
Document that you can specify mps_key_rank when creating an allocation point on an ams pool. make mps_key_rank default to mps_rank_exact().
...
Copied from Perforce
Change: 183515
ServerID: perforce.ravenbrook.com
2013-10-02 15:44:34 +01:00
Gareth Rees
b5004beb4b
Make keyword mps_key_ams_support_ambiguous optional, with default value false. update documentation accordingly.
...
Copied from Perforce
Change: 183513
ServerID: perforce.ravenbrook.com
2013-10-02 15:14:57 +01:00
Richard Brooksby
1e28ab548b
Fixing mentions of mps_size_t to just size_t in the manual. the former doesn't exist.
...
Copied from Perforce
Change: 183089
ServerID: perforce.ravenbrook.com
2013-07-16 16:10:47 +01:00
Gareth Rees
c40afadc18
Document ap creation requirements in terms of mps_ap_create_k, not the deprecated mps_ap_create.
...
Copied from Perforce
Change: 183073
ServerID: perforce.ravenbrook.com
2013-07-16 13:38:18 +01:00
Gareth Rees
ef2e69f815
Release notes.
...
Copied from Perforce
Change: 182648
ServerID: perforce.ravenbrook.com
2013-06-08 20:43:19 +01:00
Gareth Rees
4c328fc243
Fix links from manual to converted design documents (ref target must follow index declaration, not precede it).
...
Fix conversion of citations when an element is missing.
Converted design documents depend on the converter.
Copied from Perforce
Change: 182638
ServerID: perforce.ravenbrook.com
2013-06-08 18:06:16 +01:00
Gareth Rees
78067a8f56
Separate the consideration of automatic and manual pool classes, so that we can ask the appropriate questions in each case.
...
Copied from Perforce
Change: 182636
ServerID: perforce.ravenbrook.com
2013-06-08 17:49:26 +01:00
Richard Brooksby
3f4b601a61
Added missing documentation of the default values of reserve depth and frag limit in mvt.
...
Copied from Perforce
Change: 182626
ServerID: perforce.ravenbrook.com
2013-06-08 13:44:25 +01:00
Richard Brooksby
137c8f00a0
Correcting statement that mvt doesn't accept an alignment.
...
Using MPS_PF_ALIGN reference to describe the default value of MPS_KEY_ALIGN in MVT and MVFF.
Copied from Perforce
Change: 182623
ServerID: perforce.ravenbrook.com
2013-06-08 13:30:06 +01:00
Richard Brooksby
ac1e57c0ac
Merging branch/2013-05-17/emergency with major rework of mvt, mvff, and cbs.
...
Some parts of this are still ragged, and would not normally pass review, but this is a massive improvement to the existing code.
Copied from Perforce
Change: 182614
ServerID: perforce.ravenbrook.com
2013-06-08 10:57:57 +01:00
Gareth Rees
ddf49ff7e9
Mvt takes configurable alignment via a keyword argument.
...
Copied from Perforce
Change: 182605
ServerID: perforce.ravenbrook.com
2013-06-07 14:45:14 +01:00