add patch improve-code-readability-in-ext4_iget
[ext4-patch-queue.git] / fix-up-obviously-obsolete-text-in-ext4-docs
blobacf30b410637f1ca2a21cb9fac12e7a3aed0de8e
1 docs: fix up the obviously obsolete bits in the new ext4 documentation
3 Signed-off-by: Theodore Ts'o <tytso@mit.edu>
4 diff --git a/Documentation/filesystems/ext4/ext4.rst b/Documentation/filesystems/ext4/ext4.rst
5 index 47f614c47f56..9d4368d591fa 100644
6 --- a/Documentation/filesystems/ext4/ext4.rst
7 +++ b/Documentation/filesystems/ext4/ext4.rst
8 @@ -20,43 +20,32 @@ Note: More extensive information for getting started with ext4 can be
9  found at the ext4 wiki site at the URL:
10  http://ext4.wiki.kernel.org/index.php/Ext4_Howto
12 -  - Compile and install the latest version of e2fsprogs (as of this
13 -    writing version 1.41.3) from:
14 +  - The latest version of e2fsprogs can be found at:
16 -    http://sourceforge.net/project/showfiles.php?group_id=2406
17 +    https://www.kernel.org/pub/linux/kernel/people/tytso/e2fsprogs/
19         or
21 -    https://www.kernel.org/pub/linux/kernel/people/tytso/e2fsprogs/
22 +    http://sourceforge.net/project/showfiles.php?group_id=2406
24         or grab the latest git repository from:
26 -    git://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git
28 -  - Note that it is highly important to install the mke2fs.conf file
29 -    that comes with the e2fsprogs 1.41.x sources in /etc/mke2fs.conf. If
30 -    you have edited the /etc/mke2fs.conf file installed on your system,
31 -    you will need to merge your changes with the version from e2fsprogs
32 -    1.41.x.
33 +   https://git.kernel.org/pub/scm/fs/ext2/e2fsprogs.git
35 -  - Create a new filesystem using the ext4 filesystem type:::
36 +  - Create a new filesystem using the ext4 filesystem type:
38          # mke2fs -t ext4 /dev/hda1
40 -    Or to configure an existing ext3 filesystem to support extents:::
41 +    Or to configure an existing ext3 filesystem to support extents:
43         # tune2fs -O extents /dev/hda1
45      If the filesystem was created with 128 byte inodes, it can be
46 -    converted to use 256 byte for greater efficiency via:::
47 +    converted to use 256 byte for greater efficiency via:
49          # tune2fs -I 256 /dev/hda1
51 -    (Note: we currently do not have tools to convert an ext4
52 -    filesystem back to ext3; so please do not do try this on production
53 -    filesystems.)
55 -  - Mounting:::
56 +  - Mounting:
58         # mount -t ext4 /dev/hda1 /wherever
60 @@ -106,26 +95,6 @@ Currently Available
61  [1] Filesystems with a block size of 1k may see a limit imposed by the
62  directory hash tree having a maximum depth of two.
64 -Candidate Features for Future Inclusion
65 ----------------------------------------
67 -* online defrag (patches available but not well tested)
68 -* reduced mke2fs time via lazy itable initialization in conjunction with
69 -  the uninit_bg feature (capability to do this is available in e2fsprogs
70 -  but a kernel thread to do lazy zeroing of unused inode table blocks
71 -  after filesystem is first mounted is required for safety)
73 -There are several others under discussion, whether they all make it in is
74 -partly a function of how much time everyone has to work on them. Features like
75 -metadata checksumming have been discussed and planned for a bit but no patches
76 -exist yet so I'm not sure they're in the near-term roadmap.
78 -The big performance win will come with mballoc, delalloc and flex_bg
79 -grouping of bitmaps and inode tables.  Some test results available here:
81 - - http://www.bullopensource.org/ext4/20080818-ffsb/ffsb-write-2.6.27-rc1.html
82 - - http://www.bullopensource.org/ext4/20080818-ffsb/ffsb-readwrite-2.6.27-rc1.html
84  Options
85  =======
87 diff --git a/Documentation/index.rst b/Documentation/index.rst
88 index 65c22b1ff5f2..f95ba981f8cd 100644
89 --- a/Documentation/index.rst
90 +++ b/Documentation/index.rst
91 @@ -109,7 +109,7 @@ The documentation in this section are provided by specific filesystem
92  subprojects.
94  .. toctree::
95 -   :maxdepth: 4
96 +   :maxdepth: 2
98     filesystems/ext4/index