code.ossystems Code Review - openembedded-core.git/blob

   1 Upstream-Status: Inappropriate [Backport]
   2 From 0a63a11c3d3bbb7e061daad28435b5eef91a947d Mon Sep 17 00:00:00 2001
   3 From: Hubert Kario <kario@wit.edu.pl>
   4 Date: Sun, 23 Jan 2011 15:31:07 +0000
   5 Subject: [PATCH 04/15] update man page to new defragment command interface
   6
   7 Update
   8
   9         btrfs filesystem defragment
  10
  11 command explanation. Add explanation of advanced parameters and notes
  12 about general usage.
  13
  14 Add few notes about the
  15
  16         btrfs <command> --help
  17
  18 usage, fix related grammar.
  19
  20 Signed-off-by: Hubert Kario <kario@wit.edu.pl>
  21 Signed-off-by: Chris Mason <chris.mason@oracle.com>
  22 ---
  23  man/btrfs.8.in |   33 ++++++++++++++++++++++++++-------
  24  1 files changed, 26 insertions(+), 7 deletions(-)
  25
  26 diff --git a/man/btrfs.8.in b/man/btrfs.8.in
  27 index 26ef982..cba2de1 100644
  28 --- a/man/btrfs.8.in
  29 +++ b/man/btrfs.8.in
  30 @@ -15,7 +15,7 @@ btrfs \- control a btrfs filesystem
  31  .PP
  32  \fBbtrfs\fP \fBsubvolume set-default\fP\fI <id> <path>\fP
  33  .PP
  34 -\fBbtrfs\fP \fBfilesystem defrag\fP\fI <file>|<dir> [<file>|<dir>...]\fP
  35 +\fBbtrfs\fP \fBfilesystem defragment\fP\fI [-vcf] [-s start] [-l len] [-t size] <file>|<dir> [<file>|<dir>...]\fP
  36  .PP
  37  \fBbtrfs\fP \fBfilesystem sync\fP\fI <path> \fP
  38  .PP
  39 @@ -34,6 +34,8 @@ btrfs \- control a btrfs filesystem
  40  .PP
  41  \fBbtrfs\fP \fBhelp|\-\-help|\-h \fP\fI\fP
  42  .PP
  43 +\fBbtrfs\fP \fB<command> \-\-help \fP\fI\fP
  44 +.PP
  45  .SH DESCRIPTION
  46  .B btrfs
  47  is used to control the filesystem and the files and directories stored. It is
  48 @@ -60,12 +62,12 @@ returns an error.
  49
  50  If a command is terminated by
  51  .I --help
  52 -, the relevant help is showed. If the passed command matches more commands,
  53 -the help of all the matched commands are showed. For example
  54 +, the detailed help is showed. If the passed command matches more commands,
  55 +detailed help of all the matched commands is showed. For example
  56  .I btrfs dev --help
  57  shows the help of all
  58  .I device*
  59 -command.
  60 +commands.
  61
  62  .SH COMMANDS
  63  .TP
  64 @@ -98,12 +100,29 @@ mount time via the \fIsubvol=\fR option.
  65
  66  \fBsubvolume set-default\fR\fI <id> <path>\fR
  67  Set the subvolume of the filesystem \fI<path>\fR which is mounted as
  68 -\fIdefault\fR. The subvolume is identified by \fB<id>\fR, which
  69 +\fIdefault\fR. The subvolume is identified by \fI<id>\fR, which
  70  is returned by the \fBsubvolume list\fR command.
  71  .TP
  72
  73 -\fBfilesystem defragment\fP\fI <file>|<dir> [<file>|<dir>...]\fR
  74 -Defragment files and/or directories.
  75 +\fBfilesystem defragment\fP\fI [-vcf] [-s start] [-l len] [-t size] <file>|<dir> [<file>|<dir>...]\fR
  76 +Defragment file data and/or directory metadata. To defragment all files in a
  77 +directory you have to specify each one on its own or use your shell wildcards.
  78 +
  79 +\fB-v\fP be verbose
  80 +
  81 +\fB-c\fP compress file contents while defragmenting
  82 +
  83 +\fB-f\fP flush filesystem after defragmenting
  84 +
  85 +\fB-s start\fP defragment only from byte \fIstart\fR onward
  86 +
  87 +\fB-l len\fP defragment only up to \fIlen\fR bytes
  88 +
  89 +\fB-t size\fP defragment only files at least \fIsize\fR bytes big
  90 +
  91 +NOTE: defragmenting with kernels up to 2.6.37 will unlink COW-ed copies of data, don't
  92 +use it if you use snapshots, have de-duplicated your data or made copies with
  93 +\fBcp --reflink\fP.
  94  .TP
  95
  96  \fBdevice scan\fR \fI[<device> [<device>..]]\fR
  97 --
  98 1.7.2.3
  99