linux-btrfs.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [BTRFS-PROGS][PATCH 5/7] btrfs filesystem restriper man page added
@ 2011-11-02 21:23 Goffredo Baroncelli
  0 siblings, 0 replies; only message in thread
From: Goffredo Baroncelli @ 2011-11-02 21:23 UTC (permalink / raw)
  To: linux-btrfs, Ilya Dryomov


[-- Attachment #1.1: Type: text/plain, Size: 3128 bytes --]

Added "btrfs filesystem restriper *" commands to the man page

Ilya,
could you be so kindly to take care of these info for the man page 
from now onwards ?

After merging this patch you can see this text in the man page doing:

make man/btrfs.8.in
man man/btrfs.8.in

Don't hesitate to contact me for further information.

Comments are welcome.

BR
G.Baroncelli

Signed-off-by: Goffredo Baroncelli <kreijack@inwind.it>

---
 btrfs_cmds.c |   79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 76 insertions(+), 3 deletions(-)

diff --git a/btrfs_cmds.c b/btrfs_cmds.c
index 265d2cd..967917e 100644
--- a/btrfs_cmds.c
+++ b/btrfs_cmds.c
@@ -1359,9 +1359,40 @@ static struct option restripe_longopts[] = {
 	{ 0, 0, 0, 0}
 };
 
-/*
- * [-d [filters]] [-m [filters]] [-s [filters]] [-vf]
- */
+/**** man: btrfs filesystem restripe start
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe start\b [-d [filters]] [-m [filters]] [-s [filters]] [-vf] \I<path>\i
+ * 
+ * Start restriper.
+ * 
+ * Start restriper.
+ * 
+ * \B-d\b	\Idata\i.
+ * 
+ * \B-m\b	\Imetadata\i.
+ * 
+ * \B-s\b	\Isystem\i.
+ * 
+ * \B-f\b	force.
+ * 
+ * \B-v\b	verbose.
+ * 
+ * \Ifilters\i may be a comma separated list of the following item
+ * 
+ * \Bprofile\b=raid0|raid1|raid10|single|dup ( multiple profiles allowed)
+ * 
+ * \Busage\b=<nnn>
+ * 
+ * \Bdevid\b=<nnn>
+ * 
+ * \Bconvert\b=raid0|raid1|radi10|single|dup (only one profile alloweda)
+ * 
+ * \Bvrange\b=[start]..[stop]
+ * 
+ * \Bdrange\b=[start]..[stop]
+ * 
+ ****/
+
 int do_restripe(int ac, char **av)
 {
 	int fd;
@@ -1478,6 +1509,16 @@ int do_restripe(int ac, char **av)
 	return 0;
 }
 
+/**** man: btrfs filesystem restripe cancel
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe cancel\b \I<path>\i
+ * 
+ * Cancel restriper.
+ * 
+ * Cancel restriper.
+ * 
+ ****/
+
 int do_restripe_cancel(int ac, char **av)
 {
 	int fd;
@@ -1504,6 +1545,16 @@ int do_restripe_cancel(int ac, char **av)
 	return 0;
 }
 
+/**** man: btrfs filesystem restripe pause
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe pause\b \I<path>\i
+ * 
+ * Pause restriper.
+ * 
+ * Pause restriper.
+ * 
+ ****/
+
 int do_restripe_pause(int ac, char **av)
 {
 	int fd;
@@ -1530,6 +1581,16 @@ int do_restripe_pause(int ac, char **av)
 	return 0;
 }
 
+/**** man: btrfs filesystem restripe resume
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe resume\b \I<path>\i
+ * 
+ * Resume interrupted restripe operation.
+ * 
+ * Resume interrupted restripe operation.
+ * 
+ ****/
+
 int do_restripe_resume(int ac, char **av)
 {
 	int fd;
@@ -1571,6 +1632,18 @@ static struct option restripe_progress_longopts[] = {
 	{ 0, 0, 0, 0}
 };
 
+/**** man: btrfs filesystem restripe status  
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe status\b [-v] \I<path>\i
+ * 
+ * Show status of running or paused restripe operation.
+ * 
+ * Show status of running or paused restripe operation.
+ *
+ * \B-v\b	verbose.
+ * 
+ ****/
+
 int do_restripe_progress(int ac, char **av)
 {
 	int fd;

-- 
gpg key@ keyserver.linux.it: Goffredo Baroncelli (ghigo) <kreijack@inwind.it>
Key fingerprint = 4769 7E51 5293 D36C 814E  C054 BF04 F161 3DC5 0512

[-- Attachment #1.2: send-via-kmail-attach-26955-1320267567-27032.msg --]
[-- Type: text/x-patch, Size: 2422 bytes --]

diff --git a/btrfs_cmds.c b/btrfs_cmds.c
index 265d2cd..967917e 100644
--- a/btrfs_cmds.c
+++ b/btrfs_cmds.c
@@ -1359,9 +1359,40 @@ static struct option restripe_longopts[] = {
 	{ 0, 0, 0, 0}
 };
 
-/*
- * [-d [filters]] [-m [filters]] [-s [filters]] [-vf]
- */
+/**** man: btrfs filesystem restripe start
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe start\b [-d [filters]] [-m [filters]] [-s [filters]] [-vf] \I<path>\i
+ * 
+ * Start restriper.
+ * 
+ * Start restriper.
+ * 
+ * \B-d\b	\Idata\i.
+ * 
+ * \B-m\b	\Imetadata\i.
+ * 
+ * \B-s\b	\Isystem\i.
+ * 
+ * \B-f\b	force.
+ * 
+ * \B-v\b	verbose.
+ * 
+ * \Ifilters\i may be a comma separated list of the following item
+ * 
+ * \Bprofile\b=raid0|raid1|raid10|single|dup ( multiple profiles allowed)
+ * 
+ * \Busage\b=<nnn>
+ * 
+ * \Bdevid\b=<nnn>
+ * 
+ * \Bconvert\b=raid0|raid1|radi10|single|dup (only one profile alloweda)
+ * 
+ * \Bvrange\b=[start]..[stop]
+ * 
+ * \Bdrange\b=[start]..[stop]
+ * 
+ ****/
+
 int do_restripe(int ac, char **av)
 {
 	int fd;
@@ -1478,6 +1509,16 @@ int do_restripe(int ac, char **av)
 	return 0;
 }
 
+/**** man: btrfs filesystem restripe cancel
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe cancel\b \I<path>\i
+ * 
+ * Cancel restriper.
+ * 
+ * Cancel restriper.
+ * 
+ ****/
+
 int do_restripe_cancel(int ac, char **av)
 {
 	int fd;
@@ -1504,6 +1545,16 @@ int do_restripe_cancel(int ac, char **av)
 	return 0;
 }
 
+/**** man: btrfs filesystem restripe pause
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe pause\b \I<path>\i
+ * 
+ * Pause restriper.
+ * 
+ * Pause restriper.
+ * 
+ ****/
+
 int do_restripe_pause(int ac, char **av)
 {
 	int fd;
@@ -1530,6 +1581,16 @@ int do_restripe_pause(int ac, char **av)
 	return 0;
 }
 
+/**** man: btrfs filesystem restripe resume
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe resume\b \I<path>\i
+ * 
+ * Resume interrupted restripe operation.
+ * 
+ * Resume interrupted restripe operation.
+ * 
+ ****/
+
 int do_restripe_resume(int ac, char **av)
 {
 	int fd;
@@ -1571,6 +1632,18 @@ static struct option restripe_progress_longopts[] = {
 	{ 0, 0, 0, 0}
 };
 
+/**** man: btrfs filesystem restripe status  
+ * 
+ * \Bbtrfs\b \Bfilesystem restripe status\b [-v] \I<path>\i
+ * 
+ * Show status of running or paused restripe operation.
+ * 
+ * Show status of running or paused restripe operation.
+ *
+ * \B-v\b	verbose.
+ * 
+ ****/
+
 int do_restripe_progress(int ac, char **av)
 {
 	int fd;


[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 190 bytes --]

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2011-11-02 21:23 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-11-02 21:23 [BTRFS-PROGS][PATCH 5/7] btrfs filesystem restriper man page added Goffredo Baroncelli

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).