Skip to content

Commit

Permalink
btrfs-progs: docs: cumulative update
Browse files Browse the repository at this point in the history
- formatting, typo fixes, corrections
- cross references
- enhancements
- revised and colored status page

Signed-off-by: David Sterba <[email protected]>
  • Loading branch information
kdave committed May 31, 2023
1 parent 99ed2a6 commit f328c5e
Show file tree
Hide file tree
Showing 13 changed files with 248 additions and 134 deletions.
11 changes: 8 additions & 3 deletions Documentation/Common-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,13 @@ statx
*stat*

fallocate modes
the *fallocate* syscall allows to manipulate file extents like punching
holes, preallocation or zeroing a range
the *fallocate* syscall allows to manipulate file extents

Supported modes:

- keep size (FALLOC_FL_KEEP_SIZE)
- hole punching (FALLOC_FL_PUNCH_HOLE)
- zero range (FALLOC_FL_ZERO_RANGE)

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

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


File attributes, XFLAGS
Expand Down
3 changes: 3 additions & 0 deletions Documentation/Custom-ioctls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ a command if available:
which is also exported in :file:`/sys/fs/btrfs/`

- query/set a subset of features on a mounted filesystem

Programming documentaion of the ioctls is in the manual page
:doc:`btrfs-ioctl(2)<btrfs-ioctl>`.
2 changes: 1 addition & 1 deletion Documentation/Feature-by-version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ features see [[Status]] page.

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

3.9 - lightweight send
A mode of *send* that does not add the actual file data to the stream
Expand Down
12 changes: 12 additions & 0 deletions Documentation/Interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,28 @@
Interoperability
================

.. _interop-nfs:

NFS
---

.. _interop-samba:

Samba
-----

.. _interop-cgroups:

cgroups
-------

.. _interop-fsverity:

fsverity
--------

.. _interop-idmapped:

idmapped mounts
---------------

Expand All @@ -27,5 +37,7 @@ overlayfs
SELinux
-------

.. _interop-io-uring:

io_uring
--------
2 changes: 1 addition & 1 deletion Documentation/Source-repositories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,6 @@ patch page to the command:

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

0 comments on commit f328c5e

Please sign in to comment.