feat(smd): add list alias to rfe and component get commands - #121
feat(smd): add list alias to rfe and component get commands#121TheSabari07 wants to merge 1 commit into
Conversation
Signed-off-by: Sabari07 <sabursd18@gmail.com>
|
|
||
| *get* [-F _format_] [--nid _nid_] [--xname _xname_] | ||
| Get all components or one identified by xname or node ID. | ||
| Get all components or one identified by xname or node ID. Note: `list` is an available alias for this command. |
There was a problem hiding this comment.
@synackd Is this how you want to specify aliases in the man page documentation or do you have another way?
There was a problem hiding this comment.
We'll want the aliases to be discoverable, so they should be near the top of the command section. I'm thinking we do it like this:
*get* [-F _format_] [--nid _nid_] [--xname _xname_]
Aliases: *list*
Get all components or one identified by xname or node ID.
This seems idiomatic with manual pages of some other popular projects I've come across.
|
One thing that stood out at a glance is that this only covers |
|
Yes, we'll want to implement this for all commands that have a |
|
Thanks for the feedback, @synackd and @davidallendj! Just to confirm, can I start implementing the man page formatting as suggested and add the list alias to all get subcommands across the entire CLI? |
|
Yes. All service commands with a |
Okay @synackd, |
Checklist
make test(or equivalent) locally and all tests passgit commit -s) with my real name and email<filename>.licensesidecarLICENSES/directoryDescription
Summary:
This PR introduces
listas an alias for theochami smd rfe getandochami smd component getcommands.Motivation and Context:
Older CSM-based commands lacked a
listalias, causing inconsistencies in user experience when compared to newer commands in the OpenCHAMI CLI. This simple quality-of-life update allows users to typelistintuitively while mapping directly to the underlyinggetlogic. The respectivemanpages (ochami-smd.1.sc) have also been updated to reflect the availability of the alias.Fixes #(issue)
#116
Type of Change
For more info, see Contributing Guidelines.