Bug 257405 - FreeBSD Handbook: misuse of the phrase zpool
Summary: FreeBSD Handbook: misuse of the phrase zpool
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-doc (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-07-25 08:55 UTC by Graham Perrin
Modified: 2021-07-27 01:47 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin 2021-07-25 08:55:27 UTC
A pool is not a zpool. 

Avoid creating confusion around the command. 

<https://docs.freebsd.org/en/books/handbook/zfs/#zfs-zpool-create> 

> Creating a ZFS storage pool (zpool) …

– should be: 

> Creating a pool …

– and so on.
Comment 1 Ceri Davies freebsd_committer 2021-07-25 15:30:30 UTC
Please elaborate on why this is important.
Comment 2 Graham Perrin 2021-07-26 00:29:38 UTC
It's simply wrong. 

zpool is a command. 

I recall (years ago, before I began using FreeBSD) when I first began learning about ZFS, it was sometimes horribly confusing where the word was misused to describe things other than the command. 

"the storage zpool"; "a zpool"; "grow the zpool"; "zpool administration"; these phrases are wrong. 

(It's as wrong as writing, for example, "grow the gpart".)
Comment 3 Jamie Landeg-Jones 2021-07-27 01:47:27 UTC
Just sticking my nose in here :-)

Whilst debian refers to them as zpools ( https://wiki.ubuntu.com/ZFS/ZPool ), it seems they are wrong too - Oracle/Sun refer to them as pools:

https://docs.oracle.com/cd/E19253-01/819-5461/gaynr/index.html

as does openzfs: https://openzfs.github.io/openzfs-docs/man/8/zpool-import.8.html