Deprecate btrfsctl, btrfs-show, btrfs-vol
authorGoffredo Baroncelli <kreijack@libero.it>
Sun, 5 Dec 2010 17:47:36 +0000 (17:47 +0000)
committerChris Mason <chris.mason@oracle.com>
Tue, 25 Oct 2011 13:18:31 +0000 (09:18 -0400)
Hi all,

the patch below deprecates the following programs

* btrfsctl
* btrfs-vol
* btrfs-show

the reason is simple, these programs are superseded by the btrfs utility,
both in terms of documentation, usability and bug. The goal is to avoid
to duplicate codes and avoid update two programs.

The patch adds a warning in the man pages, in the INSTALL file and in the
programs.

$ ./btrfsctl
**
** WARNING: this program is considered deprecated
** Please consider to switch to the btrfs utility
**
no valid commands given
usage: btrfsctl [ -d file|dir] [ -s snap_name subvol|tree ]
                [-r size] [-A device] [-a] [-c] [-D dir .]
        -d filename: defragments one file
        -d directory: defragments the entire Btree
        -s snap_name dir: creates a new snapshot of dir
        -S subvol_name dir: creates a new subvolume
        -r [+-]size[gkm]: resize the FS by size amount
        -A device: scans the device file for a Btrfs filesystem
        -a: scans all devices for Btrfs filesystems
        -c: forces a single FS sync
        -D: delete snapshot
        -m [tree id] directory: set the default mounted subvolume to the [tree
id] or the
directory

Below the patch, but it is possible to pull the changes from:

  http://cassiopea.homelinux.net/git/btrfs-progs-unstable.git

branch

btrfs-deprecated

Comments are welcome.

G.Baroncelli

 INSTALL             |    5 +++++
 btrfs-show.c        |    5 +++++
 btrfs-vol.c         |    5 +++++
 btrfsctl.c          |    5 +++++
 man/btrfs-show.8.in |    3 +++
 man/btrfsctl.8.in   |    3 +++
 6 files changed, 26 insertions(+), 0 deletions(-)

the tool to create a new snapshot for the filesystem.

Signed-off-by: Chris Mason <chris.mason@oracle.com>
btrfs-show.c
btrfs-vol.c
btrfsctl.c
man/btrfs-show.8.in
man/btrfsctl.8.in

index c49626c..8210fd2 100644 (file)
@@ -117,6 +117,11 @@ int main(int ac, char **av)
        int ret;
        int option_index = 0;
 
+       printf( "**\n"
+               "** WARNING: this program is considered deprecated\n"
+               "** Please consider to switch to the btrfs utility\n"
+               "**\n");
+
        while(1) {
                int c;
                c = getopt_long(ac, av, "", long_options,
index f573023..0efdbc1 100644 (file)
@@ -78,6 +78,11 @@ int main(int ac, char **av)
        struct btrfs_ioctl_vol_args args;
        u64 dev_block_count = 0;
 
+       printf( "**\n"
+               "** WARNING: this program is considered deprecated\n"
+               "** Please consider to switch to the btrfs utility\n"
+               "**\n");
+
        while(1) {
                int c;
                c = getopt_long(ac, av, "a:br:", long_options,
index adfa519..73e20ec 100644 (file)
@@ -107,6 +107,11 @@ int main(int ac, char **av)
        char *fullpath;
        u64 objectid = 0;
 
+       printf( "**\n"
+               "** WARNING: this program is considered deprecated\n"
+               "** Please consider to switch to the btrfs utility\n"
+               "**\n");
+       
        if (ac == 2 && strcmp(av[1], "-a") == 0) {
                fprintf(stderr, "Scanning for Btrfs filesystems\n");
                btrfs_scan_one_dir("/dev", 1);
index dd0b147..cb98b68 100644 (file)
@@ -3,6 +3,9 @@
 btrfs-show \- scan the /dev directory for btrfs partitions and print results.
 .SH SYNOPSIS
 .B btrfs-show
+.SH NOTE
+.B btrfs-show
+is deprecated. Please consider to switch to the btrfs utility. 
 .SH DESCRIPTION
 .B btrfs-show
 is used to scan the /dev directory for btrfs partitions and display brief
index c2d4488..8705fa6 100644 (file)
@@ -10,6 +10,9 @@ btrfsctl \- control a btrfs filesystem
 [ \fB \-A\fP\fI device\fP ]
 [ \fB \-a\fP ]
 [ \fB \-c\fP ]
+.SH NOTE
+B btrfsctl
+is deprecated. Please consider to switch to the btrfs utility.
 .SH DESCRIPTION
 .B btrfsctl
 is used to control the filesystem and the files and directories stored. It is the tool to create a new snapshot for the filesystem.