linux/Documentation/vm
Dan Magenheimer 4fe4746ab6 mm/fs: cleancache documentation
This patchset introduces cleancache, an optional new feature exposed
by the VFS layer that potentially dramatically increases page cache
effectiveness for many workloads in many environments at a negligible
cost.  It does this by providing an interface to transcendent memory,
which is memory/storage that is not otherwise visible to and/or directly
addressable by the kernel.

Instead of being discarded, hooks in the reclaim code "put" clean
pages to cleancache.  Filesystems that "opt-in" may "get" pages
from cleancache that were previously put, but pages in cleancache are
"ephemeral", meaning they may disappear at any time. And the size
of cleancache is entirely dynamic and unknowable to the kernel.
Filesystems currently supported by this patchset include ext3, ext4,
btrfs, and ocfs2.  Other filesystems (especially those built entirely
on VFS) should be easy to add, but should first be thoroughly tested to
ensure coherency.

Details and a FAQ are provided in Documentation/vm/cleancache.txt

This first patch of eight in this cleancache series only adds two
new documentation files.

[v8: minor documentation changes by author]
[v3: akpm@linux-foundation.org: document sysfs API]
[v3: hch@infradead.org: move detailed description to Documentation/vm]
Signed-off-by: Dan Magenheimer <dan.magenheimer@oracle.com>
Reviewed-by: Jeremy Fitzhardinge <jeremy@goop.org>
Reviewed-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
Acked-by: Andrew Morton <akpm@linux-foundation.org>
Acked-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Al Viro <viro@ZenIV.linux.org.uk>
Cc: Matthew Wilcox <matthew@wil.cx>
Cc: Nick Piggin <npiggin@kernel.dk>
Cc: Mel Gorman <mel@csn.ul.ie>
Cc: Rik Van Riel <riel@redhat.com>
Cc: Jan Beulich <JBeulich@novell.com>
Cc: Chris Mason <chris.mason@oracle.com>
Cc: Andreas Dilger <adilger@sun.com>
Cc: Ted Ts'o <tytso@mit.edu>
Cc: Mark Fasheh <mfasheh@suse.com>
Cc: Joel Becker <joel.becker@oracle.com>
Cc: Nitin Gupta <ngupta@vflare.org>
2011-05-26 10:00:56 -06:00
..
.gitignore Documentation/vm/.gitignore: add page-types 2009-09-24 07:20:57 -07:00
00-INDEX Documentation/vm/: split txt and source files 2010-03-12 15:52:35 -08:00
active_mm.txt Fix common misspellings 2011-03-31 11:26:23 -03:00
balance page allocator: use allocation flags as an index to the zone watermark 2009-06-16 19:47:35 -07:00
cleancache.txt mm/fs: cleancache documentation 2011-05-26 10:00:56 -06:00
highmem.txt mm: highmem documentation 2010-10-26 16:52:08 -07:00
hugepage-mmap.c Documentation/vm/: split txt and source files 2010-03-12 15:52:35 -08:00
hugepage-shm.c Documentation/vm/: split txt and source files 2010-03-12 15:52:35 -08:00
hugetlbpage.txt Fix common misspellings 2011-03-31 11:26:23 -03:00
hwpoison.txt HWPOISON: Use correct name for MADV_HWPOISON in documentation 2009-12-16 12:20:00 +01:00
ksm.txt ksm: remove unswappable max_kernel_pages 2009-12-15 08:53:20 -08:00
locking truncate: new helpers 2009-09-24 08:41:47 -04:00
Makefile slub: Fix build breakage in Documentation/vm 2010-11-06 09:04:33 +02:00
map_hugetlb.c Documentation/vm: use better value for MAP_HUGETLB 2010-05-24 07:30:56 -07:00
numa numa: update Documentation/vm/numa, add memoryless node info 2010-05-27 09:12:57 -07:00
numa_memory_policy.txt Doc: Fix typo s/packages/packaged 2010-09-21 17:03:27 +02:00
overcommit-accounting Fix common misspellings 2011-03-31 11:26:23 -03:00
page_migration trivial: fix where cgroup documentation is not correctly referred to 2009-03-30 15:22:02 +02:00
page-types.c Documentation/vm/page-types.c: auto debugfs mount for hwpoison operation 2011-03-22 17:44:17 -07:00
pagemap.txt pagemap: document KPF_KSM and show it in page-types 2009-10-08 07:36:39 -07:00
slub.txt failslab: add ability to filter slab caches 2010-02-26 19:19:39 +02:00
transhuge.txt thp: transparent hugepage support documentation 2011-01-13 17:32:38 -08:00
unevictable-lru.txt doc: CONFIG_UNEVICTABLE_LRU doesn't exist anymore 2011-03-17 00:37:19 +01:00