Skip to content

Commit f328c5e

Browse files
committed
btrfs-progs: docs: cumulative update
- formatting, typo fixes, corrections - cross references - enhancements - revised and colored status page Signed-off-by: David Sterba <[email protected]>
1 parent 99ed2a6 commit f328c5e

13 files changed

+248
-134
lines changed

Documentation/Common-features.rst

+8-3
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,13 @@ statx
1616
*stat*
1717

1818
fallocate modes
19-
the *fallocate* syscall allows to manipulate file extents like punching
20-
holes, preallocation or zeroing a range
19+
the *fallocate* syscall allows to manipulate file extents
20+
21+
Supported modes:
22+
23+
- keep size (FALLOC_FL_KEEP_SIZE)
24+
- hole punching (FALLOC_FL_PUNCH_HOLE)
25+
- zero range (FALLOC_FL_ZERO_RANGE)
2126

2227
FIEMAP
2328
an ioctl that enumerates file extents, related tool is :command:`filefrag`
@@ -39,7 +44,7 @@ xattr, acl
3944

4045
cross-rename
4146
mode of *renameat2* syscall that can atomically swap 2 directory
42-
entries (files/directories/subvolumes)
47+
entries (files/directories/subvolumes/symlinks) within the same filesystem
4348

4449

4550
File attributes, XFLAGS

Documentation/Custom-ioctls.rst

+3
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ a command if available:
1919
which is also exported in :file:`/sys/fs/btrfs/`
2020

2121
- query/set a subset of features on a mounted filesystem
22+
23+
Programming documentaion of the ioctls is in the manual page
24+
:doc:`btrfs-ioctl(2)<btrfs-ioctl>`.

Documentation/Feature-by-version.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ features see [[Status]] page.
7171

7272
.. note::
7373
Disabled since 3.14 (and backported to some stable kernel versions)
74-
due to problems. Will be enabled in the future.
74+
due to problems. Has been completely removed in 5.6.
7575

7676
3.9 - lightweight send
7777
A mode of *send* that does not add the actual file data to the stream

Documentation/Interoperability.rst

+12
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,28 @@
33
Interoperability
44
================
55

6+
.. _interop-nfs:
7+
68
NFS
79
---
810

11+
.. _interop-samba:
12+
913
Samba
1014
-----
1115

16+
.. _interop-cgroups:
17+
1218
cgroups
1319
-------
1420

21+
.. _interop-fsverity:
22+
1523
fsverity
1624
--------
1725

26+
.. _interop-idmapped:
27+
1828
idmapped mounts
1929
---------------
2030

@@ -27,5 +37,7 @@ overlayfs
2737
SELinux
2838
-------
2939

40+
.. _interop-io-uring:
41+
3042
io_uring
3143
--------

Documentation/Source-repositories.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,6 @@ patch page to the command:
108108

109109
.. code-block:: bash
110110
111-
$ wget -O - '<nowiki>https://patchwork.kernel.org/patch/123456/mbox</nowiki>' | git am -
111+
$ wget -O - 'https://patchwork.kernel.org/patch/123456/mbox' | git am -
112112
113113
You may want to add *--reject*, or decide otherwise what to do with the patch.

0 commit comments

Comments
 (0)