Skip to content

Commit e64684c

Browse files
daanxdaanx
committed
update documentation
1 parent 08fa864 commit e64684c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+5756
-5219
lines changed

‎doc/mimalloc-doc.h‎

Lines changed: 240 additions & 104 deletions
Large diffs are not rendered by default.

‎doc/mimalloc-doxygen.css‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,14 @@ div.fragment {
4747
#nav-sync img {
4848
display: none;
4949
}
50+
h1,h2,h3,h4,h5,h6 {
51+
transition:none;
52+
}
53+
.memtitle {
54+
background-image: none;
55+
background-color: #EEE;
56+
}
57+
table.memproto, .memproto {
58+
text-shadow: none;
59+
font-size: 110%;
60+
}

‎docs/annotated.html‎

Lines changed: 40 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<html xmlns="http://www.w3.org/1999/xhtml">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5-
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.9.1"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.11.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>mi-malloc: Data Structures</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
1213
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13-
<script type="text/javascript" src="resize.js"></script>
1414
<script type="text/javascript" src="navtreedata.js"></script>
1515
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="resize.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
1618
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1719
<script type="text/javascript" src="search/searchdata.js"></script>
1820
<script type="text/javascript" src="search/search.js"></script>
1921
<script type="text/javascript">
20-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
21-
$(document).ready(function() { init_search(); });
22+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
23+
$(function() { init_search(); });
2224
/* @license-end */
2325
</script>
2426
<link href="doxygen.css" rel="stylesheet" type="text/css" />
@@ -29,22 +31,18 @@
2931
<div id="titlearea">
3032
<table cellspacing="0" cellpadding="0">
3133
<tbody>
32-
<tr style="height: 56px;">
34+
<tr id="projectrow">
3335
<td id="projectlogo"><img alt="Logo" src="mimalloc-logo.svg"/></td>
34-
<td id="projectalign" style="padding-left: 0.5em;">
35-
<div id="projectname">mi-malloc
36-
&#160;<span id="projectnumber">1.7/2.0</span>
36+
<td id="projectalign">
37+
<div id="projectname">mi-malloc<span id="projectnumber">&#160;1.8/2.1</span>
3738
</div>
3839
</td>
39-
<td> <div id="MSearchBox" class="MSearchBoxInactive">
40+
<td> <div id="MSearchBox" class="MSearchBoxInactive">
4041
<span class="left">
41-
<img id="MSearchSelect" src="search/mag_sel.svg"
42-
onmouseover="return searchBox.OnSearchSelectShow()"
43-
onmouseout="return searchBox.OnSearchSelectHide()"
44-
alt=""/>
45-
<input type="text" id="MSearchField" value="Search" accesskey="S"
46-
onfocus="searchBox.OnSearchFieldFocus(true)"
47-
onblur="searchBox.OnSearchFieldFocus(false)"
42+
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
43+
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
44+
onfocus="searchBox.OnSearchFieldFocus(true)"
45+
onblur="searchBox.OnSearchFieldFocus(false)"
4846
onkeyup="searchBox.OnSearchFieldChange(event)"/>
4947
</span><span class="right">
5048
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
@@ -56,10 +54,15 @@
5654
</table>
5755
</div>
5856
<!-- end header part -->
59-
<!-- Generated by Doxygen 1.9.1 -->
57+
<!-- Generated by Doxygen 1.11.0 -->
58+
<script type="text/javascript">
59+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
60+
var searchBox = new SearchBox("searchBox", "search/",'.html');
61+
/* @license-end */
62+
</script>
6063
<script type="text/javascript">
61-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
62-
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
64+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
65+
$(function() { codefold.init(0); });
6366
/* @license-end */
6467
</script>
6568
</div><!-- top -->
@@ -69,13 +72,13 @@
6972
<div id="nav-sync" class="sync"></div>
7073
</div>
7174
</div>
72-
<div id="splitbar" style="-moz-user-select:none;"
75+
<div id="splitbar" style="-moz-user-select:none;"
7376
class="ui-resizable-handle">
7477
</div>
7578
</div>
7679
<script type="text/javascript">
77-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
78-
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
80+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
81+
$(function(){initNavTree('annotated.html',''); initResizable(true); });
7982
/* @license-end */
8083
</script>
8184
<div id="doc-content">
@@ -88,28 +91,34 @@
8891

8992
<!-- iframe showing the search results (closed by default) -->
9093
<div id="MSearchResultsWindow">
91-
<iframe src="javascript:void(0)" frameborder="0"
92-
name="MSearchResults" id="MSearchResults">
93-
</iframe>
94+
<div id="MSearchResults">
95+
<div class="SRPage">
96+
<div id="SRIndex">
97+
<div id="SRResults"></div>
98+
<div class="SRStatus" id="Loading">Loading...</div>
99+
<div class="SRStatus" id="Searching">Searching...</div>
100+
<div class="SRStatus" id="NoMatches">No Matches</div>
101+
</div>
102+
</div>
103+
</div>
94104
</div>
95105

96106
<div class="header">
97-
<div class="headertitle">
98-
<div class="title">Data Structures</div> </div>
107+
<div class="headertitle"><div class="title">Data Structures</div></div>
99108
</div><!--header-->
100109
<div class="contents">
101110
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
102111
<table class="directory">
103112
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="group__analysis.html#structmi__heap__area__t" target="_self">mi_heap_area_t</a></td><td class="desc">An area of heap space contains blocks of a single size </td></tr>
104-
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="group__cpp.html#structmi__stl__allocator" target="_self">mi_stl_allocator</a></td><td class="desc"><em>std::allocator</em> implementation for mimalloc for use in STL containers </td></tr>
113+
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="group__cpp.html#structmi__stl__allocator" target="_self">mi_stl_allocator</a></td><td class="desc"><em>std::allocator</em> implementation for mimalloc for use in STL containers </td></tr>
105114
</table>
106115
</div><!-- directory -->
107116
</div><!-- contents -->
108117
</div><!-- doc-content -->
109118
<!-- start footer part -->
110119
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
111120
<ul>
112-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
121+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0 </li>
113122
</ul>
114123
</div>
115124
</body>

‎docs/bench.html‎

Lines changed: 41 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<html xmlns="http://www.w3.org/1999/xhtml">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5-
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.9.1"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.11.0"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>mi-malloc: Performance</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1010
<script type="text/javascript" src="jquery.js"></script>
1111
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
1213
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13-
<script type="text/javascript" src="resize.js"></script>
1414
<script type="text/javascript" src="navtreedata.js"></script>
1515
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="resize.js"></script>
17+
<script type="text/javascript" src="cookie.js"></script>
1618
<link href="search/search.css" rel="stylesheet" type="text/css"/>
1719
<script type="text/javascript" src="search/searchdata.js"></script>
1820
<script type="text/javascript" src="search/search.js"></script>
1921
<script type="text/javascript">
20-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
21-
$(document).ready(function() { init_search(); });
22+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
23+
$(function() { init_search(); });
2224
/* @license-end */
2325
</script>
2426
<link href="doxygen.css" rel="stylesheet" type="text/css" />
@@ -29,22 +31,18 @@
2931
<div id="titlearea">
3032
<table cellspacing="0" cellpadding="0">
3133
<tbody>
32-
<tr style="height: 56px;">
34+
<tr id="projectrow">
3335
<td id="projectlogo"><img alt="Logo" src="mimalloc-logo.svg"/></td>
34-
<td id="projectalign" style="padding-left: 0.5em;">
35-
<div id="projectname">mi-malloc
36-
&#160;<span id="projectnumber">1.7/2.0</span>
36+
<td id="projectalign">
37+
<div id="projectname">mi-malloc<span id="projectnumber">&#160;1.8/2.1</span>
3738
</div>
3839
</td>
39-
<td> <div id="MSearchBox" class="MSearchBoxInactive">
40+
<td> <div id="MSearchBox" class="MSearchBoxInactive">
4041
<span class="left">
41-
<img id="MSearchSelect" src="search/mag_sel.svg"
42-
onmouseover="return searchBox.OnSearchSelectShow()"
43-
onmouseout="return searchBox.OnSearchSelectHide()"
44-
alt=""/>
45-
<input type="text" id="MSearchField" value="Search" accesskey="S"
46-
onfocus="searchBox.OnSearchFieldFocus(true)"
47-
onblur="searchBox.OnSearchFieldFocus(false)"
42+
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
43+
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
44+
onfocus="searchBox.OnSearchFieldFocus(true)"
45+
onblur="searchBox.OnSearchFieldFocus(false)"
4846
onkeyup="searchBox.OnSearchFieldChange(event)"/>
4947
</span><span class="right">
5048
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
@@ -56,10 +54,15 @@
5654
</table>
5755
</div>
5856
<!-- end header part -->
59-
<!-- Generated by Doxygen 1.9.1 -->
57+
<!-- Generated by Doxygen 1.11.0 -->
58+
<script type="text/javascript">
59+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
60+
var searchBox = new SearchBox("searchBox", "search/",'.html');
61+
/* @license-end */
62+
</script>
6063
<script type="text/javascript">
61-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
62-
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
64+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
65+
$(function() { codefold.init(0); });
6366
/* @license-end */
6467
</script>
6568
</div><!-- top -->
@@ -69,13 +72,13 @@
6972
<div id="nav-sync" class="sync"></div>
7073
</div>
7174
</div>
72-
<div id="splitbar" style="-moz-user-select:none;"
75+
<div id="splitbar" style="-moz-user-select:none;"
7376
class="ui-resizable-handle">
7477
</div>
7578
</div>
7679
<script type="text/javascript">
77-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
78-
$(document).ready(function(){initNavTree('bench.html',''); initResizable(); });
80+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
81+
$(function(){initNavTree('bench.html',''); initResizable(true); });
7982
/* @license-end */
8083
</script>
8184
<div id="doc-content">
@@ -88,26 +91,32 @@
8891

8992
<!-- iframe showing the search results (closed by default) -->
9093
<div id="MSearchResultsWindow">
91-
<iframe src="javascript:void(0)" frameborder="0"
92-
name="MSearchResults" id="MSearchResults">
93-
</iframe>
94+
<div id="MSearchResults">
95+
<div class="SRPage">
96+
<div id="SRIndex">
97+
<div id="SRResults"></div>
98+
<div class="SRStatus" id="Loading">Loading...</div>
99+
<div class="SRStatus" id="Searching">Searching...</div>
100+
<div class="SRStatus" id="NoMatches">No Matches</div>
101+
</div>
102+
</div>
103+
</div>
94104
</div>
95105

96-
<div class="PageDoc"><div class="header">
97-
<div class="headertitle">
98-
<div class="title">Performance </div> </div>
106+
<div><div class="header">
107+
<div class="headertitle"><div class="title">Performance</div></div>
99108
</div><!--header-->
100109
<div class="contents">
101110
<div class="textblock"><p>We tested <em>mimalloc</em> against many other top allocators over a wide range of benchmarks, ranging from various real world programs to synthetic benchmarks that see how the allocator behaves under more extreme circumstances.</p>
102111
<p>In our benchmarks, <em>mimalloc</em> always outperforms all other leading allocators (<em>jemalloc</em>, <em>tcmalloc</em>, <em>Hoard</em>, etc) (Jan 2021), and usually uses less memory (up to 25% more in the worst case). A nice property is that it does <em>consistently</em> well over the wide range of benchmarks.</p>
103-
<p>See the <a href="https://github.com/microsoft/mimalloc#Performance">Performance</a> section in the <em>mimalloc</em> repository for benchmark results, or the technical report for detailed benchmark results. </p>
112+
<p>See the <a href="https://github.com/microsoft/mimalloc#Performance">Performance</a> section in the <em>mimalloc</em> repository for benchmark results, or the the technical report for detailed benchmark results. </p>
104113
</div></div><!-- contents -->
105114
</div><!-- PageDoc -->
106115
</div><!-- doc-content -->
107116
<!-- start footer part -->
108117
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
109118
<ul>
110-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
119+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0 </li>
111120
</ul>
112121
</div>
113122
</body>

0 commit comments

Comments
 (0)