docs/develop/virtualmemory/README.XML

   1 <documentation>
   2
   3         <appName>Virtual Memory</appName>
   4
   5         <version>0.9</version>
   6
   7         <author>
   8
   9                 <name>Matt McMinn</name>
  10                 <email>melfinadev@earthlink.net</email>
  11                 <homePage>http://home.earthlink.net/~melfina/</homePage>
  12
  13         </author>
  14
  15         <description>
  16
  17                 It's just a copy of the virtual memory preferences app that comes with BeOS.
  18
  19         </description>
  20
  21         <issues>
  22
  23                 <issue>
  24
  25                         <id>1</id>
  26                         <from>
  27
  28                                 <name>Matthieu Ferte</name>
  29                                 <email>mferte@club-internet.fr</email>
  30
  31                         </from>
  32                         <description>
  33
  34                                 Get the physical memory in a better way.
  35
  36                         </description>
  37                         <relatedInfo>
  38
  39                                 <code>
  40
  41                                         #include <OS.h>
  42
  43                                         int physMem;
  44
  45                                         system_info info;
  46                                         get_system_info(&info);
  47                                         physMem = (info.max_pages * 4096) / 1048576;
  48
  49                                 </code>
  50
  51                         </relatedInfo>
  52
  53                 </issue>
  54                 <issue>
  55
  56                         <id>2</id>
  57                         <from>
  58
  59                                 <name>Matthieu Ferte</name>
  60                                 <email>mferte@club-internet.fr</email>
  61
  62                         </from>
  63                         <description>
  64
  65                                 Get the current memory by reading the file.
  66
  67                         </description>
  68                         <relatedInfo>
  69
  70                                 <code>
  71
  72                                         #include <Entry.h>
  73
  74                                         int currSwap;
  75
  76                                         const char *swap_file;
  77                                         swap_file = "/boot/var/swap";
  78                                         BEntry swap(swap_file);
  79                                         off_t swapsize;
  80                                         swap.GetSize(&swapsize);
  81                                         currSwap = swapsize / 1048576;
  82
  83                                 </code>
  84
  85                         </relatedInfo>
  86
  87                 </issue>
  88                 <issue>
  89
  90                         <id>3</id>
  91                         <from>
  92
  93                                 <name>Matthieu Ferte</name>
  94                                 <email>mferte@club-internet.fr</email>
  95
  96                         </from>
  97                         <description>
  98
  99                                 Equation that calculates the minimum swap size is wrong (not linear).
 100
 101                         </description>
 102                         <relatedInfo>
 103
 104                                 <note>
 105
 106                                         I got the values on my computer with the original vm app :
 107                                         Ram 256 Mb -> Swap 341 Mb
 108                                         Ram 512 Mb -> Swap 640 Mb
 109                                         Ram 768 Mb -> Swap 886 Mb
 110                                         Ram 1024 Mb -> Swap 1133 Mb
 111
 112                                         With obos app i got :
 113                                         Ram 256 Mb -> Swap 341 Mb
 114                                         Ram 512 Mb -> Swap 683 Mb
 115                                         Ram 768 Mb -> Swap 1024 Mb
 116                                         Ram 1024 Mb -> Swap 1365 Mb
 117
 118                                 </note>
 119
 120                         </relatedInfo>
 121
 122                 </issue>
 123
 124         </issues>
 125
 126         <history>
 127
 128                 <earlierVersion version="0.8">
 129
 130                         <date>10/31/2001</date>
 131                         <description>Initial release.  Visually complete.</description>
 132
 133                 </earlierVersion>
 134
 135         </history>
 136
 137         <note>
 138
 139                 Even tho it wasn't really necessary, I know I've overdocumented this app.
 140                 My excuse is that I wanted to learn how to use doxygen, and this was a
 141                 good app to run it on.  So if you want full documentation, and you have
 142                 doxygen installed, available from BeBits, run <code>doxygen .doxygen-conf</code>
 143                 in the code directory, and it will create docs for you.
 144
 145         </note>
 146
 147 </description>