[LUDOC-59] poollist is the accepted usage of pool_list. Created: 14/May/12 Updated: 27/Nov/12 Resolved: 15/May/12 |
|
| Status: | Closed |
| Project: | Lustre Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Minor |
| Reporter: | Richard Henwood (Inactive) | Assignee: | Richard Henwood (Inactive) |
| Resolution: | Won't Fix | Votes: | 0 |
| Labels: | None | ||
| Rank (Obsolete): | 7155 |
| Description |
|
lfs now supports poollist and pool_list. The manual uses both - but uses poollist more often. poollist is the consistent usage so the manual should eradicate use of the term pool_list. |
| Comments |
| Comment by Richard Henwood (Inactive) [ 14/May/12 ] |
|
for review: |
| Comment by Andreas Dilger [ 15/May/12 ] |
|
Richard, I'm not sure I understand why you think "poollist" is preferable over "pool_list"? All of the other OST pools commands in the lctl tool are using "pool_*", for example "lctl pool_new", "lctl pool_add", "lctl pool_destroy", and also "lctl pool_list". The lfs tool (which is what is under discussion here) also has "lfs pool_list", which is consistent with all of those other commands, but this one for users to use. |
| Comment by Richard Henwood (Inactive) [ 15/May/12 ] |
|
Ah, thanks for taking the time to provide this clarification. I was looking at lfs. All lfs commands that are a concatenation of two words do not have a underscore between them, except pool_list. The proposed change to the manual is for lctl - I didn't notice this. I will abandon this change and thank you for checking the details and taking time to explain to me. |
| Comment by Richard Henwood (Inactive) [ 15/May/12 ] |
|
The change targetted lctl - which does use pool_* to keep consistency. |
| Comment by Andreas Dilger [ 15/May/12 ] |
|
While it doesn't make sense to change "lctl pool_list" to "lctl poollist" in the manual, are there cases where the "lfs pool_list" and "lfs poollist" are used inconsistently? I'd prefer to only have a single version documented everywhere (IMHO "lfs pool_list", since this is the only version that has actually worked), and only allow "lfs poollist" for a limited time for those few people that read the manual... |
| 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.
|