Skip to content

Commit

Permalink
zfs(8): add requirements towards fs names
Browse files Browse the repository at this point in the history
Provide explicit requirements towards file system naming convention
in OpenZFS man pages.

Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by: Ahelenia Ziemiańska <[email protected]>
Signed-off-by: szubersk <[email protected]>
Mitigates openzfs#13310
Closes openzfs#13315
  • Loading branch information
szubersk authored and andrewc12 committed Sep 23, 2022
1 parent cded762 commit d722603
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions man/man8/zfs.8
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit d722603

Please sign in to comment.