diff mbox

[v2,13/13] btrfs-progs: Update Doc for btrfs-property

Message ID 1431331734-11714-14-git-send-email-quwenruo@cn.fujitsu.com (mailing list archive)
State Rejected, archived
Headers show

Commit Message

Qu Wenruo May 11, 2015, 8:08 a.m. UTC
Update offline related new function for btrfs-property.

Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
v2:
  Seperated from previous patch.
---
 Documentation/btrfs-property.asciidoc | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)
diff mbox

Patch

diff --git a/Documentation/btrfs-property.asciidoc b/Documentation/btrfs-property.asciidoc
index 8b9b7f0..c7239ef 100644
--- a/Documentation/btrfs-property.asciidoc
+++ b/Documentation/btrfs-property.asciidoc
@@ -32,7 +32,8 @@  The '-t <type>' option can be used to explicitly
 specify what type of object you meant. This is only needed when a
 property could be set for more then one object type.
 +
-Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]'.
+Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]', 'd[evice]' and
+'o[ffline]'.
 +
 Set the name of property by '<name>'. If no '<name>' is specified,
 all properties for the given object are printed. '<name>' is one of
@@ -44,6 +45,20 @@  label::::
 label of device
 compression::::
 compression setting for an inode: lzo, zlib, or "" (empty string)
+fsid::::
+fsid for an offline btrfs: 36 bytes UUID string in `printf`(3) format:
+"%08x-%04x-%04x-%04x-%012x"
+chunk_tree_uuid::::
+chunk tree uuid for an offline btrfs: 36 bytes UUID, same as 'fsid'.
+
+
+NOTE: To use 'fsid' and 'chunk_tree_uuid' in 'offline' type, '-t offline' must
+be specified explicitly, as most offline operation are dangerous and user
+should be aware of the danger.
+
+WARNING: If process of changing 'fsid' or 'chunk_tree_uuid' is canceled, the
+filesystem will not be mountable as it is in a inconsistent status. To make it
+mountable again, the uuid change needs to be reran and ensure it completes.
 
 *list* [-t <type>] <object>::
 Lists available properties with their descriptions for the given object.