Skip to content

Commit 9a34ae5

Browse files
committed
doc/cephfs: edit grammar in snapshots.rst
This commit improves the grammar in doc/cephfs/snapshots.rst. The PR associated with this commit follows from ceph#61240, the PR raised by Neeraj Pratap Singh to introduce information about snapshots into the CephFS documentation. See also https://tracker.ceph.com/issues/68974. Signed-off-by: Zac Dover <[email protected]>
1 parent 8056c23 commit 9a34ae5

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

doc/cephfs/snapshots.rst

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,45 @@
22
CephFS Snapshots
33
================
44

5-
CephFS snapshots create an immutable view of the file system at the point
6-
in time they are taken. CephFS support snapshots which is managed in a
7-
special hidden subdirectory named ``.snap`` .Snapshots are created using
8-
``mkdir`` inside this directory.
5+
CephFS snapshots create an immutable view of the file system at the point in
6+
time they are taken. CephFS snapshots are managed in a special hidden
7+
subdirectory named ``.snap``. Snapshots are created using ``mkdir`` inside the
8+
``.snap`` directory.
99

10-
Snapshots can be exposed with a different name by changing the following client configurations.
10+
Snapshots can be exposed with different names by changing the following client
11+
configurations:
1112

1213
- ``snapdirname`` which is a mount option for kernel clients
1314
- ``client_snapdir`` which is a mount option for ceph-fuse.
1415

1516
Snapshot Creation
1617
==================
1718

18-
CephFS snapshot feature is enabled by default on new file systems. To enable
19-
it on existing file systems, use the command below.
19+
The CephFS snapshot feature is enabled by default on new file systems. To
20+
enable the CephFS snapshot feature on existing file systems, use the command
21+
below.
2022

2123
.. code-block:: bash
2224
2325
$ ceph fs set <fs_name> allow_new_snaps true
2426
25-
When snapshots are enabled, all directories in CephFS will have a special ``.snap``
26-
directory. (You may configure a different name with the client snapdir setting if
27-
you wish.)
28-
To create a CephFS snapshot, create a subdirectory under ``.snap`` with a name of
29-
your choice.
30-
For example, to create a snapshot on directory ``/file1/``, invoke ``mkdir /file1/.snap/snapshot-name``
27+
When snapshots are enabled, all directories in CephFS will have a special
28+
``.snap`` directory. (You may configure a different name with the client's
29+
``snapdir`` setting if you wish.) To create a CephFS snapshot, create a
30+
subdirectory under ``.snap`` with a name of your choice. For example, to
31+
create a snapshot on directory ``/file1/``, run the command ``mkdir
32+
/file1/.snap/snapshot-name``:
3133

3234
.. code-block:: bash
3335
3436
$ touch file1
3537
$ cd .snap
3638
$ mkdir my_snapshot
3739
38-
Using snapshot to recover data
40+
Using Snapshots to Recover Data
3941
===============================
4042

41-
Snapshots can also be used to recover some deleted files.
43+
Snapshots can also be used to recover deleted files:
4244

4345
- ``create a file1 and create snapshot snap1``
4446

@@ -75,9 +77,9 @@ Snapshots can also be used to recover some deleted files.
7577
Snapshot Deletion
7678
==================
7779

78-
Snapshots are deleted by invoking ``rmdir`` on the ``.snap`` directory they are
79-
rooted in. (Attempts to delete a directory which roots the snapshots will fail;
80-
you must delete the snapshots first.)
80+
Snapshots are deleted by running ``rmdir`` on the ``.snap`` directory that they
81+
are rooted in. (Attempts to delete a directory that roots the snapshots will
82+
fail. You must delete the snapshots first.)
8183

8284
.. code-block:: bash
8385

0 commit comments

Comments
 (0)