[LU-1364] lfs 'poollist' is incorrectly recognised as 'pool_list' by lfs, the lfs manpage and the Manual. Created: 03/May/12  Updated: 27/Sep/12  Resolved: 27/Sep/12

Status: Resolved
Project: Lustre
Component/s: None
Affects Version/s: None
Fix Version/s: Lustre 2.3.0

Type: Bug Priority: Minor
Reporter: Richard Henwood (Inactive) Assignee: Bob Glossman (Inactive)
Resolution: Fixed Votes: 0
Labels: None

Severity: 3
Rank (Obsolete): 4608

 Description   

The convention with lfs commands is that they do not have underscores in them. for example:

lfs setstripe -d <dir>
lfs osts [path]
lfs poollist <filesystem>[.<pool>] | <pathname>
lfs quota [-q] [-v] ...
lfs quota -t <-u|-g> <filesystem>
lfs quotacheck [-ug] <filesystem>
lfs quotachown [-i] <filesystem>
lfs quotaon [-ugf] <filesystem>
lfs quotaoff [-ug] <filesystem>
lfs quotainv [-ug] [-f] <filesystem>

The lfs command currently wrongly requires a user to specify: pool_list.

The inline-help, Manual and test scripts should be updated to make them consistent.



 Comments   
Comment by Andreas Dilger [ 03/May/12 ]

The easiest way to avoid confusion here is to have "lfs" accept both "poollist" and "pool_list" call the same lfs_poollist() function, and leave the manual as is.

Comment by Peter Jones [ 07/May/12 ]

Bob

Could you please look into this one?

Thanks

Peter

Comment by Bob Glossman (Inactive) [ 14/May/12 ]

http://review.whamcloud.com/#change,2734

Have changed only lfs leaving the manual unchanged as Andreas suggested.

Comment by Andreas Dilger [ 15/May/12 ]

In further reflection on this issue, I think "lfs pool_list" is the preferred usage, to match all of the other "lctl pool_*" commands.

While it is true that "lfs poollist" was documented in both the user manual and the "lfs.1" man page, the "lfs pool_list" command is the only one that has been working this whole time. By the time that this patch is landed in a release there is no value to start accepting the "poollist" variant when we could have just fixed the documentation to match the actual usage. There can't really have been any population of existing users using "lfs poollist", which is the normal reason to accept multiple variants of a command.

This patch should instead be changed to update the lfs.1 man page (for master, b1_8, b2_1, and b2_2), which can be done with less risk than introducing a code change. The LUDOC-59 change should document the proper usage in the user manual.

Comment by Bob Glossman (Inactive) [ 15/May/12 ]

After review abandoning the code change to lfs and updating the lfs man page to reflect current usage and reality instead.

Comment by Jodi Levi (Inactive) [ 27/Sep/12 ]

Please let me know if this needs additional work and needs to be reopened.

Generated at Sat Feb 10 01:15:59 UTC 2024 using Jira 9.4.14#940014-sha1:734e6822bbf0d45eff9af51f82432957f73aa32c.