[PATCH 17/17] doc: reflect removal of FS-related commands

[Jim Meyering]

From: Jim Meyering <address@hidden>

* README (WARNING): Say that all FS-manipulation code is now gone.
* doc/parted.texi (Command explanations): Remove descriptions of and
any examples or references to the following commands: check, cp,
mkfs, mkpartfs, move, resize.
---
 README          |   33 +++----
 doc/parted.texi |  251 +++++--------------------------------------------------
 2 files changed, 34 insertions(+), 250 deletions(-)

diff --git a/README b/README
index aff7053..3d1fee9 100644
--- a/README
+++ b/README
@@ -3,25 +3,20 @@ GNU Parted

 GNU Parted is a program for manipulating partition tables.

-WARNING: USING PARTED TO PERFORM FILE SYSTEM OPERATIONS IS DEPRECATED
----------------------------------------------------------------------
-
-Parted retains (for now) the ability to create and modify a few types of
-file systems, but that functionality is deprecated.  Whenever possible,
-we recommend that you use file-system-specific tools to create and
-operate on file systems.  For example, use the e2fsprogs programs
-to operate on ext2, ext3 and ext4 file systems.  Use programs from
-the reiserfsprogs package if you want to manipulate reiserfs file
-systems.  Although Parted lets you do some of the same things, the
-file-system-related code in parted is not as robust as the code in
-more specialized, FS-specific packages.
-
-So far, we have good arguments for retaining the capability to resize
-FAT and HFS file systems: as far as we know, no other free software
-provides that functionality.  However, all other FS-related functionality
-will be removed from an upcoming release of Parted.  Thus, you should
-now avoid using the following commands: mkpartfs, mkfs, cp, move, check
-since support for them will be removed.
+WARNING: USING PARTED TO PERFORM FILE SYSTEM OPERATIONS IS NO LONGER SUPPORTED
+------------------------------------------------------------------------------
+
+Parted (post-2.4) no longer has the ability to create and modify file systems.
+Use file-system-specific tools to create and operate on file systems.
+For example, use the e2fsprogs programs to operate on ext2, ext3 and ext4
+file systems.  Use programs from the reiserfsprogs package if you want to
+manipulate reiserfs file systems.  Although Parted lets you do some of the
+same things, the file-system-related code in parted is not as robust as the
+code in more specialized, FS-specific packages.
+
+Most FS-related functionality was removed after Parted 2.4.
+Thus, the following commands are no longer supported:
+mkpartfs, mkfs, cp, move, check, resize.


 See the file NEWS for a list of major changes in the current release.
diff --git a/doc/parted.texi b/doc/parted.texi
index 162f192..f6c64f5 100644
--- a/doc/parted.texi
+++ b/doc/parted.texi
@@ -202,11 +202,6 @@ Linux versions 2.0 and up, on Alpha, x86 PCs, PC98, 
Macintosh PowerPC, Sun hardw
 @item GNU/Hurd
 @end table

-GNU libc 2.1 or higher is required.  You can probably use older versions
-by using the @samp{--disable-nls} option. @xref{Compiling, Building GNU
-Parted}. (Note: I think we have now dropped this requirement.  TODO:
-check if libc 2.0 works!)
-
 @node License
 @section Terms of distribution for GNU Parted
 @cindex license terms
@@ -322,7 +317,7 @@ In command line mode, this is followed by one or more 
commands.  For
 example:

 @example
-# @kbd{parted /dev/sda resize 1 52Mb 104Mb mkfs 2 fat16}
+# @kbd{parted /dev/sda mklabel gpt mkpart P1 ext3 1MiB 8MiB }
 @end example

 @noindent Options (like @kbd{--help}) can only be specified on the
@@ -332,12 +327,12 @@ In interactive mode, commands are entered one at a time 
at a prompt, and
 modify the disk immediately.  For example:

 @example
-(parted) @kbd{resize 1 52.0005Mb 104.5Mb}
-(parted) @kbd{mkfs 2 fat16}
+(parted) @kbd{mklabel gpt}
+(parted) @kbd{mkpart P1 ext3 1MiB 8MiB }
 @end example

 @noindent Unambiguous abbreviations are allowed.  For example, you can
-type ``p'' instead of ``print'', and ``resi'' instead of ``resize''.
+type ``p'' instead of ``print'', and ``u'' instead of ``units''.
 Commands can be typed either in English, or your native language (if
 your language has been translated).  This may create ambiguities.
 Commands are case-insensitive.
@@ -346,40 +341,32 @@ Numbers indicating partition locations can be whole 
numbers or decimals.
 The suffix selects the unit, which may be one of those described in
 @ref{unit}, except CHS and compact.  If no suffix is given, then the default
 unit is assumed.  Negative numbers count back from the end of the disk,
-with ``-1s'' indicating the end of the disk.  Parted will compute sensible
+with ``-1s'' indicating the sector at the end of the disk.
+Parted will compute sensible
 ranges for the locations you specify (e.g. a range of +/- 500 MB when you
 specify the location in ``G''). Use the sector unit ``s'' to specify exact
-locations.
+locations.  With parted-2.4 and newer,
+IEC binary units like ``MiB'', ``GiB'', ``TiB'', etc., specify
+exact locations as well.
+See @xref{IEC binary units}.

 If you don't give a parameter to a command, Parted will prompt you for it.
 For example:

 @example
-(parted) @kbd{resize 1}
-Start? @kbd{0Gb}
-End? @kbd{40Gb}
+(parted) @kbd{mklabel}
+New disk label type? @kbd{gpt}
 @end example

 Parted will always warn you before doing something that is potentially
 dangerous, unless the command is one of those that is inherently
-dangerous (viz., rm, mklabel and mkfs).  For example, if you attempt to
-shrink a partition ``too much'' (i.e., by more than the free space
-available), Parted will automatically reduce the shrinkage so that the
-partition is the smallest it can be without losing data.  If this size is
-significantly different from the size requested, Parted will warn you.
+dangerous (viz., rm, mklabel and mkpart).
 Since many partitioning systems have complicated constraints, Parted will
 usually do something slightly different to what you asked.  (For example,
 create a partition starting at 10.352Mb, not 10.4Mb)
 If the calculated values differ too much, Parted will ask you for
 confirmation.

-Currently ext3 filesystem functionality does not work. To manage ext3 type
-filesystems use tools like resize2fs or mke2fs.  Note that the currently
-supported ext2 filesystem will be deprecated once ext3 support is finalized.
-Further note that ext3 support will have limited functionality that is yet
-to be defined.  Use tools like resize2fs (8) and mke2fs (8) to manage these
-types of filesystems.
-

 @node Invoking Parted
 @section Command Line Options
@@ -428,25 +415,22 @@ GNU Parted provides the following commands:

 @menu
 * align-check::
-* check::
-* cp::
 * help::
 * mklabel::
-* mkfs::
 * mkpart::
-* mkpartfs::
-* move::
 * name::
 * print::
 * quit::
 * rescue::
-* resize::
 * rm::
 * select::
 * set::
 * unit::
 @end menu

+Note that after version 2.4, the following commands were removed:
+check, cp, mkfs, mkpartfs, move, resize.
+
 @node align-check
 @subsection align-check
 @cindex align-check, command description
@@ -474,63 +458,6 @@ Example:

 @end deffn

address@hidden check
address@hidden check
address@hidden check, command description
address@hidden command description, check
-
address@hidden Command check @var{number}
-
-Checks if the file system on partition @var{number} has
-any errors.
-
-Example:
-
address@hidden
-(parted) @kbd{check 1}
address@hidden example
-
-Check the file system on partition 1.
address@hidden deffn
-
address@hidden cp
address@hidden cp
address@hidden cp, command description
address@hidden command description, cp
-
address@hidden Command cp address@hidden @var{from-number} @var{to-number}
-
-Copies the file system on the partition @var{from-number} to partition
address@hidden, deleting the original contents of the destination
-partition.
-
-An optional device parameter, @var{from-device} can be given, which
-specifies which device the source partition is on.
-
-Supported file systems:
address@hidden @bullet
address@hidden ext2
-(provided the destination partition is larger than the source partition)
-
address@hidden fat16, fat32
address@hidden linux-swap
-(equivalent to mkswap on destination partition)
address@hidden reiserfs (if libreiserfs is installed)
-
address@hidden itemize
-
-Example:
-
address@hidden
-(parted) @kbd{cp /dev/hdb 2 3}
address@hidden example
-
address@hidden FIXME: this doesn't format right.
-Copy partition 2 of @file{/dev/hdb} (i.e., @file{/dev/hdb2}) to partition
-on 3, on the device Parted was loaded with, destroying the original
-contents of partition 3.
address@hidden deffn
-
 @node help
 @subsection help
 @cindex help, command description
@@ -543,10 +470,10 @@ Prints general help, or help on @var{command}.
 Example:

 @example
-(parted) @kbd{help resize}
+(parted) @kbd{help mklabel}
 @end example

-Print help for the resize command.
+Print help for the mklabel command.
 @end deffn

 @node mklabel
@@ -586,33 +513,6 @@ Create an MS-DOS disk label.  This is still the most 
common disk label for
 PCs.
 @end deffn

address@hidden mkfs
address@hidden mkfs
address@hidden mkfs, command description
address@hidden command description, mkfs
-
address@hidden Command mkfs @var{number} @var{fs-type}
-
-Makes a file system @var{fs-type} on partition @var{number}, destroying
-all data that resides on that partition.
-
-Supported file systems:
address@hidden @bullet
address@hidden ext2
address@hidden fat16, fat32
address@hidden linux-swap
address@hidden reiserfs (if libreiserfs is installed)
address@hidden itemize
-
-Example:
-
address@hidden
-(parted) @kbd{mkfs 2 fat32}
address@hidden example
-
-Make a @var{fat32} file system on partition 2.
address@hidden deffn
-
 @node mkpart
 @subsection mkpart
 @cindex mkpart, command description
@@ -658,79 +558,6 @@ megabytes into the disk.

 @end deffn

address@hidden mkpartfs
address@hidden mkpartfs
address@hidden mkpartfs, command description
address@hidden command description, mkpartfs
-
address@hidden Command mkpartfs @var{part-type} @var{fs-type} @var{start} 
@var{end}
-
-Creates a new partition of type @var{part-type} with a new file system
-of type @var{fs-type} on it.  The new partition will start @var{start}
-megabytes, and end @var{end} megabytes from the beginning of the disk.
-Do not use this command to recover a deleted partition (use mkpart
-instead).  Using this command is discouraged.  Instead use mkpart
-to create an empty partition, and then use external tools like mke2fs (8)
-to create the filesystem.
-
address@hidden is one of: primary, extended, logical.  Extended and logical
-are only used for msdos and dvh disk labels.
-
address@hidden must be one of these supported file systems:
address@hidden @bullet
address@hidden ext2
address@hidden fat16, fat32
address@hidden linux-swap
address@hidden reiserfs (if libreiserfs is installed)
address@hidden itemize
-
-Example:
-
address@hidden
-(parted) @kbd{mkpartfs logical ext2 440 670}
address@hidden example
-
-Make a logical partition and write an ext2 file system, starting 440
-megabytes and ending 670 megabytes from the beginning of the disk.
address@hidden deffn
-
address@hidden move
address@hidden move
address@hidden move, command description
address@hidden command description, move
-
address@hidden Command move @var{number} @var{start} @var{end}
-
-Moves partition on the disk, by moving its beginning to @var{start}.
-You can't move a partition so that the old and new positions overlap.
-That is, you can only move partitions into free space.  If you want
-to resize a partition in-place, use @command{resize}.
-
-Move never changes the partition number.
-
-Supported file systems:
address@hidden @bullet
address@hidden ext2
-(provided the destination partition is larger than the source partition)
-
address@hidden fat16, fat32
-
address@hidden linux-swap
-
address@hidden reiserfs (if libreiserfs is installed)
address@hidden itemize
-
-Example:
-
address@hidden
-(parted) move 2 150M 500M
address@hidden example
-
-Move the partition numbered 2 so that it begins 150 megabytes from the start of
-the disk, and ends 500 megabytes from the start.
-
address@hidden deffn
-
 @node name
 @subsection name
 @cindex name, command description
@@ -856,45 +683,6 @@ It's back!  :)

 @end deffn

address@hidden resize
address@hidden resize
address@hidden resize, command description
address@hidden command description, resize
-
address@hidden Command resize @var{number} @var{start} @var{end}
-
-Resizes the partition with number @var{number}.  The partition will start
address@hidden from the beginning of the disk, and end @var{end} from the
-beginning of the disk.  resize never changes the partition number.  Extended
-partitions can be resized only so long as the new extended partition
-completely contains all logical partitions.
-
-Note that Parted can manipulate partitions whether or not they have been
-defragmented, so you do not need to defragment the disk before
-using Parted.
-
-Supported file systems:
address@hidden @bullet
address@hidden ext2 -- restriction: the new @var{start} must be the same as
-the old @var{start}.
address@hidden fat16, fat32
address@hidden hfs, hfs+, hfsx -- restriction: the new @var{start} must be the 
same as
-the old @var{start} and the new @var{end} must be smaller than the old
address@hidden
address@hidden linux-swap
address@hidden reiserfs (if libreiserfs is installed)
address@hidden itemize
-
-Example:
-
address@hidden
-(parted) @kbd{resize 3 200M 850M}
address@hidden example
-
-Resize partition 3, so that it begins 200 megabytes and ends 850
-megabytes from the beginning of the disk.
address@hidden deffn
-
 @node rm
 @subsection rm
 @cindex rm, command description
@@ -904,7 +692,7 @@ megabytes from the beginning of the disk.
 @deffn Command rm @var{number}

 Removes the partition with number @var{number}.  If you accidently delete
-a partition with this command, use mkpart (@emph{not} mkpartfs) to
+a partition with this command, use mkpart to
 recover it.  Also, you can use the gpart program (@pxref{Related information})
 to recover damaged disk labels.

@@ -1098,6 +886,7 @@ do not satisfy all constraints, Parted will ask you for 
the nearest
 solution).  Note that negative numbers count back from the end of
 the disk, with ``-1s'' pointing to the last sector of the disk.

address@hidden binary units}
 Note that as of parted-2.4, when you specify start and/or end values
 using IEC binary units like ``MiB'', ``GiB'', ``TiB'', etc., parted
 treats those values as exact, and equivalent to the same number
-- 
1.7.5.2.660.g9f46c