No bug, add header comments to Memory.h, r=none
authorDavid Mandelin <dmandelin@mozilla.com>
Fri, 27 Apr 2012 15:10:54 -0700
changeset 92651 1ed9525b2a9f96c755791cccf50ea7e3884c0867
parent 92650 04e00b912240f574bf09c20a4c91b50216c7e23e
child 92652 6d00f1cbfa08eaa909646e6224afc48f5810b828
push id22549
push userryanvm@gmail.com
push dateSun, 29 Apr 2012 20:42:32 +0000
treeherdermozilla-central@32a0e99932b2 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersnone
milestone15.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
No bug, add header comments to Memory.h, r=none
js/src/gc/Memory.h
--- a/js/src/gc/Memory.h
+++ b/js/src/gc/Memory.h
@@ -9,24 +9,29 @@
 #define jsgc_memory_h___
 
 #include <stddef.h>
 #include "jsgc.h"
 
 namespace js {
 namespace gc {
 
-/*
- * Sanity check that our compiled configuration matches the currently running
- * instance and initialize any runtime data needed for allocation.
- */
+// Sanity check that our compiled configuration matches the currently running
+// instance and initialize any runtime data needed for allocation.
 void InitMemorySubsystem();
 
+// Allocate or deallocate pages from the system with the given alignment.
 void *MapAlignedPages(size_t size, size_t alignment);
 void UnmapPages(void *p, size_t size);
 
+// Tell the OS that the given pages are not in use, so they should not
+// be written to a paging file. This may be a no-op on some platforms.
 bool MarkPagesUnused(void *p, size_t size);
+
+// Undo |MarkPagesUnused|: tell the OS that the given pages are of interest
+// and should be paged in and out normally. This may be a no-op on some
+// platforms.
 bool MarkPagesInUse(void *p, size_t size);
 
 } /* namespace gc */
 } /* namespace js */
 
 #endif /* jsgc_memory_h___ */