Archive-Team
/
zfs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 103 Wiki Activity

zfs(8): add requirements towards fs names 

Provide explicit requirements towards file system naming convention
in OpenZFS man pages.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Signed-off-by: szubersk <szuberskidamian@gmail.com>
Mitigates #13310
Closes #13315
This commit is contained in:
szubersk 2022-04-11 15:14:38 +02:00 committed by Brian Behlendorf
parent 3d149db1f3
commit 4f0be2bdb0
1 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
man/man8/zfs.8
View File

@ -57,13 +57,32 @@ The
.Nm
command configures ZFS datasets within a ZFS storage pool, as described in
.Xr zpool 8 .
A dataset is identified by a unique path within the ZFS namespace.
For example:
.Dl pool/{filesystem,volume,snapshot}
A dataset is identified by a unique path within the ZFS namespace:
.Pp
where the maximum length of a dataset name is
.Sy MAXNAMELEN Pq 256B
and the maximum amount of nesting allowed in a path is 50 levels deep.
.D1 Ar pool Ns Oo Sy / Ns Ar component Oc Ns Sy / Ns Ar component
.Pp
for example:
.Pp
.Dl rpool/var/log
.Pp
The maximum length of a dataset name is
.Sy ZFS_MAX_DATASET_NAME_LEN No - 1
ASCII characters (currently 255) satisfying
.Sy [A-Za-z_.:/ -] .
Additionally snapshots are allowed to contain a single
.Sy @
character, while bookmarks are allowed to contain a single
.Sy #
character.
.Sy /
is used as separator between components.
The maximum amount of nesting allowed in a path is
.Sy zfs_max_dataset_nesting
levels deep.
ZFS tunables
.Pq Sy zfs_*
are explained in
.Xr zfs 4 .
.Pp
A dataset can be one of the following:
.Bl -tag -offset Ds -width "file system"