~ubuntu-branches/ubuntu/precise/linux-ti-omap/precise

« back to all changes in this revision

Viewing changes to ubuntu/compcache/README

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Bader, Amit Kucheria
  • Date: 2010-03-23 18:05:12 UTC
  • Revision ID: james.westby@ubuntu.com-20100323180512-iavj906ocnphdubp
Tags: 2.6.33-500.3
[ Amit Kucheria ]

* [Config] Fix the debug package name to end in -dbgsym
* SAUCE: Add the ubuntu/ drivers to omap
* SAUCE: Re-export the symbols for aufs
* [Config] Enable AUFS and COMPCACHE

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
ramzswap: Compressed RAM based swap device
 
2
-------------------------------------------
 
3
 
 
4
Project home: http://compcache.googlecode.com
 
5
 
 
6
* Introduction
 
7
This is a RAM based block device which acts as swap disk.
 
8
Pages swapped to this device are compressed and stored in
 
9
memory itself. See project home for use cases, performance
 
10
numbers and lot more.
 
11
 
 
12
* Compiling
 
13
 - Run 'make': this will compile all modules against your kernel.
 
14
 
 
15
 - Following kernel modules are created:
 
16
   - xvmalloc.ko
 
17
   - ramzswap.ko
 
18
 
 
19
* Using
 
20
 - Following scipts are included
 
21
   - use_ramzswap.sh [<disksize(KB)|<memlimit(KB)>] [<backing_swap>]
 
22
     This loads all required modules and sets up swap device.
 
23
     NOTE: script contains detailed documentation on parameters.
 
24
 
 
25
   - unuse_ramzswap.sh
 
26
     Unloads all modules and turns off ramzswap swap device.
 
27
 
 
28
* Common Problems
 
29
 - If you get lots of compile errors, make sure you have package for
 
30
   kernel source installed. For e.g., on Fedora its 'kernel-devel' package.
 
31
 
 
32
 - If (un)use_ramzswap scripts fail to work, refer to wiki:
 
33
   http://code.google.com/p/compcache/wiki/CompilingAndUsing
 
34
 
 
35
* Notes
 
36
 - Statistics are exported via /proc/ramzswap
 
37
 
 
38
Please consider using Issue Tracker:
 
39
http://code.google.com/p/compcache/issues/list
 
40
for reporting any bugs/feature requests.
 
41
 
 
42
Cheers!
 
43
Nitin Gupta
 
44
EMail: ngupta at vflare dot org
 
45