Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unprivileged btrfs subvol list #893

Open
wants to merge 10 commits into
base: devel
Choose a base branch
from
37 changes: 32 additions & 5 deletions Documentation/btrfs-subvolume.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,20 +143,47 @@ list [options] [-G [\+|-]<value>] [-C [+|-]<value>] [--sort=rootid,gen,ogen,path

where *ID* is subvolume's (root)id, *generation* is an internal counter which is
updated every transaction, *parent_ID* is the same as the parent subvolume's id,
and *path* is the relative path of the subvolume to the top level subvolume.
and *path* is the path of the subvolume. The exact meaning of *path*
depends on the **Path filtering** option used.

If -O or -A is given, "top level" is replaced by "parent".

The subvolume's ID may be used by the subvolume set-default command,
or at mount time via the *subvolid=* option.

``Options``

Path filtering:

-O
Print <path> and all subvolumes below it, recursively. <path>
must be a subvolume. Paths are printed relative to <path>.

This may be used by unprivileged users, in which case this only
lists subvolumes that the user has access to.
-A
Print all subvolumes in the filesystem. Paths are printed
relative to the root of the filesystem.

You likely always want either -O or -A. The -o and -a options and the
default if no path filtering options are given have very confusing,
accidental behavior that is only kept for backwards compatibility.

-o
Print only subvolumes below specified <path>. Note that this is not a
recursive command, and won't show nested subvolumes under <path>.
Print only the immediate children subvolumes of the subvolume
containing <path>. Paths are printed relative to the root of
the filesystem.
-a
print all the subvolumes in the filesystem and distinguish between
absolute and relative path with respect to the given *path*.
Print all subvolumes in the filesystem other than the root
subvolume. Paths are printed relative to the root of the
filesystem, except that subvolumes that are not an immediate
child of the subvolume containing <path> are prefixed with
"<FS_TREE>/".

If none of these are given, print all subvolumes in the filesystem
other than the root subvolume. Paths below the subvolume containing
<path> are printed relative to that subvolume, and other paths are
printed relative to the root of the filesystem.

Field selection:

Expand Down
11 changes: 11 additions & 0 deletions Documentation/dev/ReleaseChecklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ Pre-release:

* write CHANGES entry (will be visible on RTD right away)

Python btrfsutil (pypi.org):

* rebuild whole project (regenerate constants.c)
* ``cd libbtrfsutil/python``
* edit ``setup.py`` version manually (the toplevel VERSION is not accessible
during dist build)
* ``python3 -m build`` -- build dist files
* ``twine check dist/*.tar.gz`` -- look for warnings
* ``twine upload dist/*.tar.gz`` -- make sure there's only the latest version,
*twine* must need access token to pypi.org

Release:

* tag release, sign
Expand Down
Loading