summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSachin Pandit <spandit@redhat.com>2014-07-28 09:53:50 +0530
committerVijay Bellur <vbellur@redhat.com>2014-09-23 02:01:12 -0700
commitf7df69f61d22ed2b679cc91e1669a454d0c223d5 (patch)
treebacda9ae4bd8c203507309016977c6aaa9d66309 /doc
parentc5aa277ec26cd7cf4109bc8854af50a254edbbd9 (diff)
doc : man page and admin-guide for newly introduced snapshot delete option
Change-Id: Iab5e7f63d673a2040e8d83ab7280121ff468836e BUG: 1145084 Signed-off-by: Sachin Pandit <spandit@redhat.com> Reviewed-on: http://review.gluster.org/8378 Reviewed-by: Atin Mukherjee <amukherj@redhat.com> Tested-by: Gluster Build System <jenkins@build.gluster.com> Reviewed-by: Kaushal M <kaushal@redhat.com> Signed-off-by: Sachin Pandit <spandit@redhat.com> Reviewed-on: http://review.gluster.org/8799 Reviewed-by: Vijaikumar Mallikarjuna <vmallika@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/admin-guide/en-US/markdown/admin_managing_snapshots.md7
-rw-r--r--doc/gluster.84
2 files changed, 7 insertions, 4 deletions
diff --git a/doc/admin-guide/en-US/markdown/admin_managing_snapshots.md b/doc/admin-guide/en-US/markdown/admin_managing_snapshots.md
index 9da88b93eb1..3de64af56ef 100644
--- a/doc/admin-guide/en-US/markdown/admin_managing_snapshots.md
+++ b/doc/admin-guide/en-US/markdown/admin_managing_snapshots.md
@@ -53,10 +53,13 @@ list of snapshots.
**Deleting snaps**
Syntax :
-*gluster snapshot delete <snapname\>*
+*gluster snapshot delete \(all | <snapname\> | volume <volname\>\)*
Details :
-Deletes the specified snapshot.
+If snapname is specified then mentioned snapshot is deleted.
+If volname is specified then all snapshots belonging to that particular
+volume is deleted. If keyword *all* is used then all snapshots belonging
+to the system is deleted.
--------------------------------------------------------------------------
diff --git a/doc/gluster.8 b/doc/gluster.8
index 28811c5b3d4..e45c011b189 100644
--- a/doc/gluster.8
+++ b/doc/gluster.8
@@ -114,8 +114,8 @@ Creates a snapshot of a GlusterFS volume. User can provide a snap-name and a des
\fB\ snapshot restore <snapname> \fR
Restores an already taken snapshot of a GlusterFS volume. Snapshot restore is an offline activity therefore if the volume is online (in started state) then the restore operation will fail. Once the snapshot is restored it will not be available in the list of snapshots.
.TP
-\fB\ snapshot delete <snapname> \fR
-Deletes the specified snapshot.
+\fB\ snapshot delete ( all | <snapname> | volume <volname> ) \fR
+If snapname is specified then mentioned snapshot is deleted. If volname is specified then all snapshots belonging to that particular volume is deleted. If keyword *all* is used then all snapshots belonging to the system is deleted.
.TP
\fB\ snapshot list [volname] \fR
Lists all snapshots taken. If volname is provided, then only the snapshots belonging to that particular volume is listed.