[LU-11048] lctl pool commands have no man pages

• Type: Technical task
• Resolution: Fixed
• Priority: Minor
• Fix Version/s: Lustre 2.17.0
• Assignee: Fred Dilger
• Reporter: Andreas Dilger

Description

There is no man page for the lctl pool_new, pool_add, pool_remove, pool_destroy, and pool_list sub-commands.

Each command should get its own page like lustre/doc/lctl-pool_new.8.

Issue Links

• is related to: LU-13954 add OST pool quota options for lfs-quota.1 and lfs-setquota.1
• is related to: LU-4315 split lfs.1 and lctl.8 man pages into one page per subcommand

Comments

[Peter Jones]

Merged for 2.17

[Gerrit Updater]

"Oleg Drokin <[e-mail]>" merged in patch https://review.whamcloud.com/c/fs/lustre-release/+/56303/
Subject: LU-11048 docs: adding missing pool man pages
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: 3361112a4351d87941c7e7a637efae344cd77403

[Gerrit Updater]

"Frederick Dilger <[e-mail]>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/56303
Subject: LU-11048 docs: adding missing pool man pages
Project: fs/lustre-release
Branch: master
Current Patch Set: 1
Commit: 5aaba53f81fb1dfbb4679bb2b33a96d97fe7a174

[Fred Dilger]

It seems the example in lctl-pool_add.8 and lctl-pool_new.8 is wrong, and the description fails to mention that the numbers of the OSTs must be in hexa form XXXX and proceeded by OST|fsname-OST

however if using a list of OSTs it is ok to do something like OST[1-4].

[Andreas Dilger]

Man pages for lctl-pool_new.8 and lctl-pool_add.8 were added in patch https://review.whamcloud.com/34524 "LU-930 doc: man pages for lctl pool_new, pool_add", but pool_remove, pool_destroy, and pool_list are still missing.