Skip to content

Commit

Permalink
zpoolprops.7: Fix max length of name of user property
Browse files Browse the repository at this point in the history
The documentation mentioned that the property name can be 256 characters
long. This was incorrect. The last byte is reserved for NUL, so the
name provided by the operator can be only 255 characters long.

Reviewed-by: Tony Hutter <[email protected]>
Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by: Alexander Motin <[email protected]>
Reviewed-by: Tino Reichardt <[email protected]>
Reviewed-by: Allan Jude <[email protected]>
Signed-off-by: Mateusz Piotrowski <[email protected]>
Sponsored-by: Klara, Inc.
Sponsored-by: Wasabi Technology, Inc.
Closes #16248
  • Loading branch information
0mp authored and behlendorf committed Aug 8, 2024
1 parent 7ceb9ad commit 2558518
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions man/man7/zpoolprops.7
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.\" Copyright (c) 2021, Colm Buckley <[email protected]>
.\" Copyright (c) 2023, Klara Inc.
.\"
.Dd January 14, 2024
.Dd July 29, 2024
.Dt ZPOOLPROPS 7
.Os
.
Expand Down Expand Up @@ -488,7 +488,7 @@ The expected convention is that the property name is divided into two portions
such as
.Ar module : Ns Ar property ,
but this namespace is not enforced by ZFS.
User property names can be at most 256 characters, and cannot begin with a dash
User property names can be at most 255 characters, and cannot begin with a dash
.Pq Qq Sy - .
.Pp
When making programmatic use of user properties, it is strongly suggested to use
Expand Down

0 comments on commit 2558518

Please sign in to comment.