libbtrfsutil: update btrfs_util_delete_subvolume docs

btrfs_util_error btrfs_util_delete_subvolume requires elevated
privileges, despite the fact that the documentation does not say that.

The following does not work in all scenarios:

	$ btrfs subvolume create ~/mytest
	$ btrfs subvolume delete ~/mytest

Document the additional requirements.

Pull-request: #253
Issue: #252
Author: cezarmathe <me@cezarmathe.com>
Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
cezarmathe 2020-05-22 08:15:02 +03:00 committed by David Sterba
parent b602b22884
commit dbf60b488e
1 changed files with 7 additions and 0 deletions

View File

@ -471,6 +471,13 @@ enum btrfs_util_error btrfs_util_create_snapshot_fd2(int fd, int parent_fd,
* @path: Path of the subvolume to delete.
* @flags: Bitmask of BTRFS_UTIL_DELETE_SUBVOLUME_* flags.
*
* This requires appropriate privilege (CAP_SYS_ADMIN), unless the filesystem is
* mounted with 'user_subvol_rm_allowed'.
*
* NOTE: Since kernel 4.18 it is possible to delete an empty subvolume using
* rmdir. The sysfs file /sys/fs/btrfs/features/rmdir_subvol indicates whether
* this feature is enabled or not.
*
* Return: %BTRFS_UTIL_OK on success, non-zero error code on failure.
*/
enum btrfs_util_error btrfs_util_delete_subvolume(const char *path, int flags);