path: root/Documentation
diff options
authorDimitri John Ledkov <>2018-05-08 14:17:29 -0700
committerDimitri John Ledkov <>2018-05-08 14:17:29 -0700
commitd00c9550da1801a0eaff5cedf4312e24691b31ea (patch)
tree3881ca1764ef792259e1b70f12c884a3ac0c0715 /Documentation
parentdab6d2181f1f194ec3a76d900cf2c6533379cbea (diff)
New upstream release.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/btrfs-balance.8.gzbin6108 -> 6104 bytes
-rw-r--r--Documentation/btrfs-check.8.gzbin2726 -> 2725 bytes
-rw-r--r--Documentation/btrfs-convert.8.gzbin2746 -> 2746 bytes
-rw-r--r--Documentation/btrfs-device.8.gzbin4832 -> 4832 bytes
-rw-r--r--Documentation/btrfs-filesystem.8.gzbin5879 -> 5878 bytes
-rw-r--r--Documentation/btrfs-find-root.8.gzbin863 -> 862 bytes
-rw-r--r--Documentation/btrfs-image.8.gzbin1464 -> 1464 bytes
-rw-r--r--Documentation/btrfs-inspect-internal.8.gzbin3037 -> 3078 bytes
-rw-r--r--Documentation/btrfs-map-logical.8.gzbin875 -> 875 bytes
-rw-r--r--Documentation/btrfs-property.8.gzbin1519 -> 1519 bytes
-rw-r--r--Documentation/btrfs-qgroup.8.gzbin2377 -> 2377 bytes
-rw-r--r--Documentation/btrfs-quota.8.gzbin4891 -> 4891 bytes
-rw-r--r--Documentation/btrfs-receive.8.gzbin2026 -> 2027 bytes
-rw-r--r--Documentation/btrfs-replace.8.gzbin1634 -> 1634 bytes
-rw-r--r--Documentation/btrfs-rescue.8.gzbin2047 -> 2047 bytes
-rw-r--r--Documentation/btrfs-restore.8.gzbin1980 -> 1979 bytes
-rw-r--r--Documentation/btrfs-scrub.8.gzbin2158 -> 2157 bytes
-rw-r--r--Documentation/btrfs-select-super.8.gzbin1267 -> 1248 bytes
-rw-r--r--Documentation/btrfs-send.8.gzbin1719 -> 1719 bytes
-rw-r--r--Documentation/btrfs-subvolume.8.gzbin3226 -> 3225 bytes
-rw-r--r--Documentation/btrfs.5.gzbin11006 -> 11324 bytes
-rw-r--r--Documentation/btrfs.8.gzbin2228 -> 2257 bytes
-rw-r--r--Documentation/btrfstune.8.gzbin2051 -> 2052 bytes
-rw-r--r--Documentation/fsck.btrfs.8.gzbin1128 -> 1129 bytes
-rw-r--r--Documentation/mkfs.btrfs.8.gzbin6542 -> 6542 bytes
37 files changed, 55 insertions, 22 deletions
diff --git a/Documentation/ b/Documentation/
index 64947afb..184647c4 100644
--- a/Documentation/
+++ b/Documentation/
@@ -102,9 +102,6 @@ install-man: man
$(MV) $(DESTDIR)$(man5dir)/btrfs-man5.5.gz $(DESTDIR)$(man5dir)/btrfs.5.gz
$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
$(LN_S) -f btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz
- $(LN_S) -f btrfs-rescue.8.gz $(DESTDIR)$(man8dir)/btrfs-zero-log.8.gz
- $(LN_S) -f btrfs-inspect-internal.8.gz $(DESTDIR)$(man8dir)/btrfs-debug-tree.8.gz
- $(LN_S) -f btrfs-inspect-internal.8.gz $(DESTDIR)$(man8dir)/btrfs-show-super.8.gz
cd $(DESTDIR)$(man8dir); rm -f btrfs-check.8.gz $(GZ_MAN8)
diff --git a/Documentation/btrfs-balance.8.gz b/Documentation/btrfs-balance.8.gz
index 4e7ff56e..f51c43d0 100644
--- a/Documentation/btrfs-balance.8.gz
+++ b/Documentation/btrfs-balance.8.gz
Binary files differ
diff --git a/Documentation/btrfs-balance.asciidoc b/Documentation/btrfs-balance.asciidoc
index 7017bed7..536243bc 100644
--- a/Documentation/btrfs-balance.asciidoc
+++ b/Documentation/btrfs-balance.asciidoc
@@ -204,7 +204,7 @@ The way balance operates, it usually needs to temporarily create a new block
group and move the old data there, before the old block group can be removed.
For that it needs the work space, otherwise it fails for ENOSPC reasons.
This is not the same ENOSPC as if the free space is exhausted. This refers to
-the space on the level of block groups, which are bigger parts of the filesytem
+the space on the level of block groups, which are bigger parts of the filesystem
that contain many file extents.
The free work space can be calculated from the output of the *btrfs filesystem show*
diff --git a/Documentation/btrfs-check.8.gz b/Documentation/btrfs-check.8.gz
index fde8c5fb..f811ae43 100644
--- a/Documentation/btrfs-check.8.gz
+++ b/Documentation/btrfs-check.8.gz
Binary files differ
diff --git a/Documentation/btrfs-check.asciidoc b/Documentation/btrfs-check.asciidoc
index cc76d846..b963eae5 100644
--- a/Documentation/btrfs-check.asciidoc
+++ b/Documentation/btrfs-check.asciidoc
@@ -122,7 +122,7 @@ NOTE: 'lowmem' mode does not work with '--repair' yet, and is still considered
-allow to work on a mounted filesystem. Note that this should work fine on a
+allow work on a mounted filesystem. Note that this should work fine on a
quiescent or read-only mounted filesystem but may crash if the device is
changed externally, eg. by the kernel module. Repair without mount checks is
not supported right now.
diff --git a/Documentation/btrfs-convert.8.gz b/Documentation/btrfs-convert.8.gz
index 2a283976..85f9cf3e 100644
--- a/Documentation/btrfs-convert.8.gz
+++ b/Documentation/btrfs-convert.8.gz
Binary files differ
diff --git a/Documentation/btrfs-debug-tree.8.gz b/Documentation/btrfs-debug-tree.8.gz
deleted file mode 120000
index e69216e2..00000000
--- a/Documentation/btrfs-debug-tree.8.gz
+++ /dev/null
@@ -1 +0,0 @@
-btrfs-inspect-internal.8.gz \ No newline at end of file
diff --git a/Documentation/btrfs-device.8.gz b/Documentation/btrfs-device.8.gz
index d2f09280..3daf4dbc 100644
--- a/Documentation/btrfs-device.8.gz
+++ b/Documentation/btrfs-device.8.gz
Binary files differ
diff --git a/Documentation/btrfs-device.asciidoc b/Documentation/btrfs-device.asciidoc
index 223ade5c..04d31503 100644
--- a/Documentation/btrfs-device.asciidoc
+++ b/Documentation/btrfs-device.asciidoc
@@ -124,7 +124,7 @@ statistics and the meaning.
Print the stats and reset the values to zero afterwards.
-Check if the stats are all zeros and return 0 it this is so. Set bit 6 of the
+Check if the stats are all zeros and return 0 if it is so. Set bit 6 of the
return code if any of the statistics is no-zero. The error values is 65 if
reading stats from at least one device failed, otherwise it's 64.
@@ -190,7 +190,7 @@ there's enough workspace for the conversion process, we can do:
$ btrfs balance start -mconvert=raid1 /mnt
-This operation can take a while, because al metadata have to be moved and all
+This operation can take a while, because all metadata have to be moved and all
block pointers updated. Depending on the physical locations of the old and new
blocks, the disk seeking is the key factor affecting performance.
diff --git a/Documentation/btrfs-filesystem.8.gz b/Documentation/btrfs-filesystem.8.gz
index 2955df08..91f00e79 100644
--- a/Documentation/btrfs-filesystem.8.gz
+++ b/Documentation/btrfs-filesystem.8.gz
Binary files differ
diff --git a/Documentation/btrfs-filesystem.asciidoc b/Documentation/btrfs-filesystem.asciidoc
index 13c2d7cc..f0a9ba4d 100644
--- a/Documentation/btrfs-filesystem.asciidoc
+++ b/Documentation/btrfs-filesystem.asciidoc
@@ -3,7 +3,7 @@ btrfs-filesystem(8)
-btrfs-filesystem - command group othat primarily does work on the whole filesystems
+btrfs-filesystem - command group that primarily does work on the whole filesystems
diff --git a/Documentation/btrfs-find-root.8.gz b/Documentation/btrfs-find-root.8.gz
index 11c03171..92fcc6b6 100644
--- a/Documentation/btrfs-find-root.8.gz
+++ b/Documentation/btrfs-find-root.8.gz
Binary files differ
diff --git a/Documentation/btrfs-image.8.gz b/Documentation/btrfs-image.8.gz
index be540124..b765137a 100644
--- a/Documentation/btrfs-image.8.gz
+++ b/Documentation/btrfs-image.8.gz
Binary files differ
diff --git a/Documentation/btrfs-inspect-internal.8.gz b/Documentation/btrfs-inspect-internal.8.gz
index 318ac56d..2fdc7275 100644
--- a/Documentation/btrfs-inspect-internal.8.gz
+++ b/Documentation/btrfs-inspect-internal.8.gz
Binary files differ
diff --git a/Documentation/btrfs-inspect-internal.asciidoc b/Documentation/btrfs-inspect-internal.asciidoc
index e072a943..e2db6466 100644
--- a/Documentation/btrfs-inspect-internal.asciidoc
+++ b/Documentation/btrfs-inspect-internal.asciidoc
@@ -87,6 +87,8 @@ the respective tree root block offset
print only the uuid tree information, empty output if the tree does not exist
-b <block_num>::::
print info of the specified block only
+use with '-b', print all children tree blocks of '<block_num>'
-t <tree_id>::::
print only the tree with the specified ID, where the ID can be numerical or
common name in a flexible human readable form
diff --git a/Documentation/btrfs-man5.asciidoc b/Documentation/btrfs-man5.asciidoc
index 367736ce..0529496a 100644
--- a/Documentation/btrfs-man5.asciidoc
+++ b/Documentation/btrfs-man5.asciidoc
@@ -14,9 +14,11 @@ tools. Currently covers:
2. filesystem features
-3. file attributes
+3. filesystem limits
-4. control device
+4. file attributes
+5. control device
@@ -208,7 +210,7 @@ system at that point.
Enable discarding of freed file blocks. This is useful for SSD devices, thinly
provisioned LUNs, or virtual machine images; however, every storage layer must
support discard for it to work. if the backing device does not support
-asynchronous queued TRIM, then this operation can severly degrade performance,
+asynchronous queued TRIM, then this operation can severely degrade performance,
because a synchronous TRIM operation will be attempted instead. Queued TRIM
requires newer than SATA revision 3.1 chipsets and devices.
@@ -221,7 +223,7 @@ of actually discarding the blocks.
If discarding is not necessary to be done at the block freeing time, there's
`fstrim`(8) tool that lets the filesystem discard all free blocks in a batch,
-possibly not much interfering with other operations. Also, the the device may
+possibly not much interfering with other operations. Also, the device may
ignore the TRIM command if the range is too small, so running the batch discard
can actually discard the blocks.
@@ -287,7 +289,7 @@ checksums don't fit inside a single page.
Don't use this option unless you really need it. The inode number limit
on 64bit system is 2^64^, which is practically enough for the whole filesystem
-lifetime. Due to implemention of linux VFS layer, the inode numbers on 32bit
+lifetime. Due to implementation of linux VFS layer, the inode numbers on 32bit
systems are only 32 bits wide. This lowers the limit significantly and makes
it possible to reach it. In such case, this mount option will help.
Alternatively, files with high inode numbers can be copied to a new subvolume
@@ -413,7 +415,7 @@ will disable all SSD options.
Mount subvolume from 'path' rather than the toplevel subvolume. The
-'path' is always treated as relative to the the toplevel subvolume.
+'path' is always treated as relative to the toplevel subvolume.
This mount option overrides the default subvolume set for the given filesystem.
@@ -608,6 +610,40 @@ the filesystem contains or contained a raid56 profile of block groups
reduced-size metadata for extent references, saves a few percent of metadata
+maximum file name length::
+maximum symlink target length::
+depends on the 'nodesize' value, for 4k it's 3949 bytes, for larger nodesize
+it's 4095
+The symlink target may not be a valid path, ie the path name components
+can exceed the limits, there's no content validation at `symlink`(3) creation.
+maximum number of inodes::
+2^64^ but depends on the available metadata space as the inodes are created
+inode numbers::
+minimum number: 256 (for subvolumes), regular files and directories: 257
+maximum file length::
+inherent limit of btrfs is 2^64^ (16 EiB) but the linux VFS limit is 2^63^ (8 EiB)
+maximum number of subvolumes::
+2^64^ but depends on the available metadata space, the space consumed by all
+subvolume metadata includes bookeeping of the shared extents can be large (MiB,
+maximum number of hardlinks of a file in a directory::
+65536 when the `extref` feature is turned on during mkfs (default), roughly
+100 otherwise
The btrfs filesystem supports setting the following file attributes using the
diff --git a/Documentation/btrfs-map-logical.8.gz b/Documentation/btrfs-map-logical.8.gz
index 2f9a9c12..00d0c048 100644
--- a/Documentation/btrfs-map-logical.8.gz
+++ b/Documentation/btrfs-map-logical.8.gz
Binary files differ
diff --git a/Documentation/btrfs-property.8.gz b/Documentation/btrfs-property.8.gz
index b05b0a6d..4a8101aa 100644
--- a/Documentation/btrfs-property.8.gz
+++ b/Documentation/btrfs-property.8.gz
Binary files differ
diff --git a/Documentation/btrfs-qgroup.8.gz b/Documentation/btrfs-qgroup.8.gz
index f76382ef..13feefed 100644
--- a/Documentation/btrfs-qgroup.8.gz
+++ b/Documentation/btrfs-qgroup.8.gz
Binary files differ
diff --git a/Documentation/btrfs-quota.8.gz b/Documentation/btrfs-quota.8.gz
index 45c9b665..c400008e 100644
--- a/Documentation/btrfs-quota.8.gz
+++ b/Documentation/btrfs-quota.8.gz
Binary files differ
diff --git a/Documentation/btrfs-receive.8.gz b/Documentation/btrfs-receive.8.gz
index f0d644e8..5b782a3d 100644
--- a/Documentation/btrfs-receive.8.gz
+++ b/Documentation/btrfs-receive.8.gz
Binary files differ
diff --git a/Documentation/btrfs-replace.8.gz b/Documentation/btrfs-replace.8.gz
index fe411c4f..ca3cb8ff 100644
--- a/Documentation/btrfs-replace.8.gz
+++ b/Documentation/btrfs-replace.8.gz
Binary files differ
diff --git a/Documentation/btrfs-rescue.8.gz b/Documentation/btrfs-rescue.8.gz
index 061456ac..681dae38 100644
--- a/Documentation/btrfs-rescue.8.gz
+++ b/Documentation/btrfs-rescue.8.gz
Binary files differ
diff --git a/Documentation/btrfs-restore.8.gz b/Documentation/btrfs-restore.8.gz
index 75181ba5..3a7371ce 100644
--- a/Documentation/btrfs-restore.8.gz
+++ b/Documentation/btrfs-restore.8.gz
Binary files differ
diff --git a/Documentation/btrfs-scrub.8.gz b/Documentation/btrfs-scrub.8.gz
index 331c1a9b..8aa92d8f 100644
--- a/Documentation/btrfs-scrub.8.gz
+++ b/Documentation/btrfs-scrub.8.gz
Binary files differ
diff --git a/Documentation/btrfs-select-super.8.gz b/Documentation/btrfs-select-super.8.gz
index d1bd2502..d0afda32 100644
--- a/Documentation/btrfs-select-super.8.gz
+++ b/Documentation/btrfs-select-super.8.gz
Binary files differ
diff --git a/Documentation/btrfs-select-super.asciidoc b/Documentation/btrfs-select-super.asciidoc
index 6e94a034..e3bca98b 100644
--- a/Documentation/btrfs-select-super.asciidoc
+++ b/Documentation/btrfs-select-super.asciidoc
@@ -21,8 +21,7 @@ The filesystem specified by 'device' must not be mounted.
NOTE: *Prior to overwriting the primary superblock, please make sure that the backup
copies are valid!*
-To dump a superblock use the *btrfs inspect-internal
-dump-super* command, or the obsolete command *btrfs-show-super*.
+To dump a superblock use the *btrfs inspect-internal dump-super* command.
Then run the check (in the non-repair mode) using the command *btrfs check -s*
where '-s' specifies the superblock copy to use.
diff --git a/Documentation/btrfs-send.8.gz b/Documentation/btrfs-send.8.gz
index 808a4bb2..0f31ed82 100644
--- a/Documentation/btrfs-send.8.gz
+++ b/Documentation/btrfs-send.8.gz
Binary files differ
diff --git a/Documentation/btrfs-show-super.8.gz b/Documentation/btrfs-show-super.8.gz
deleted file mode 120000
index e69216e2..00000000
--- a/Documentation/btrfs-show-super.8.gz
+++ /dev/null
@@ -1 +0,0 @@
-btrfs-inspect-internal.8.gz \ No newline at end of file
diff --git a/Documentation/btrfs-subvolume.8.gz b/Documentation/btrfs-subvolume.8.gz
index ba8ff190..90e7a138 100644
--- a/Documentation/btrfs-subvolume.8.gz
+++ b/Documentation/btrfs-subvolume.8.gz
Binary files differ
diff --git a/Documentation/btrfs-zero-log.8.gz b/Documentation/btrfs-zero-log.8.gz
deleted file mode 120000
index 7c007012..00000000
--- a/Documentation/btrfs-zero-log.8.gz
+++ /dev/null
@@ -1 +0,0 @@
-btrfs-rescue.8.gz \ No newline at end of file
diff --git a/Documentation/btrfs.5.gz b/Documentation/btrfs.5.gz
index c33db2bb..9ead78aa 100644
--- a/Documentation/btrfs.5.gz
+++ b/Documentation/btrfs.5.gz
Binary files differ
diff --git a/Documentation/btrfs.8.gz b/Documentation/btrfs.8.gz
index 1ad76a10..b7584036 100644
--- a/Documentation/btrfs.8.gz
+++ b/Documentation/btrfs.8.gz
Binary files differ
diff --git a/Documentation/btrfs.asciidoc b/Documentation/btrfs.asciidoc
index 82530234..7316ac09 100644
--- a/Documentation/btrfs.asciidoc
+++ b/Documentation/btrfs.asciidoc
@@ -120,9 +120,11 @@ Tools that are still in active use without an equivalent in *btrfs*:
Deprecated and obsolete tools:
-*btrfs-debug-tree*:: moved to *btrfs inspect-internal dump-tree*
-*btrfs-show-super*:: moved to *btrfs inspect-internal dump-super*
-*btrfs-zero-log*:: moved to *btrfs rescue zero-log*
+*btrfs-debug-tree*:: moved to *btrfs inspect-internal dump-tree*. Removed from
+source distribution.
+*btrfs-show-super*:: moved to *btrfs inspect-internal dump-super*, standalone
+*btrfs-zero-log*:: moved to *btrfs rescue zero-log*, standalone removed.
diff --git a/Documentation/btrfstune.8.gz b/Documentation/btrfstune.8.gz
index 2a4babfc..9c403588 100644
--- a/Documentation/btrfstune.8.gz
+++ b/Documentation/btrfstune.8.gz
Binary files differ
diff --git a/Documentation/fsck.btrfs.8.gz b/Documentation/fsck.btrfs.8.gz
index e47e730c..997d4db8 100644
--- a/Documentation/fsck.btrfs.8.gz
+++ b/Documentation/fsck.btrfs.8.gz
Binary files differ
diff --git a/Documentation/mkfs.btrfs.8.gz b/Documentation/mkfs.btrfs.8.gz
index 36275e8b..b0b86e15 100644
--- a/Documentation/mkfs.btrfs.8.gz
+++ b/Documentation/mkfs.btrfs.8.gz
Binary files differ