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

'zpool get' command help output has two small errors #16876

Open
opsec opened this issue Dec 17, 2024 · 1 comment
Open

'zpool get' command help output has two small errors #16876

opsec opened this issue Dec 17, 2024 · 1 comment
Labels
Type: Defect Incorrect behavior (e.g. crash, hang)

Comments

@opsec
Copy link

opsec commented Dec 17, 2024

System information

Type Version/Name
Distribution Name FreeBSD
Distribution Version 15 and earlier
Kernel Version FreeBSD
Architecture amd64
OpenZFS Version zfs-2.2.99-474-FreeBSD_g8f1b7a6fa

Describe the problem you're observing

zpool set
shows a list of properties and explainers. Two small errors:

  • the property "capacity" is a and not a
  • the property "name" is missing.

see also:
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=204626

Describe how to reproduce the problem

see above

Include any warning/errors/backtraces from the system logs

@opsec opsec added the Type: Defect Incorrect behavior (e.g. crash, hang) label Dec 17, 2024
@robn
Copy link
Member

robn commented Dec 18, 2024

Thanks for the report!

First is easy fixed, good eye: #16881.

The second is .. interesting. As best I can tell, name isn't a real property, and is marked "hidden" and handled specially (ditto the dataset and vdev name properties). I suspect it's excluded because if not, this special handling would have to be invoked for every "get all properties" request, which complicates the code, and possibly add overheads.

Still, there is a difference between usage information and actually doing the work. We could list "hidden" properties in zpool get in the same way, but call them out with something like "these properties are only shown when explicitly asked for". Would that be useful, or just more confusing?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Defect Incorrect behavior (e.g. crash, hang)
Projects
None yet
Development

No branches or pull requests

2 participants