the parameter "function" maybe an Optional arguments

Bug #1835719 reported by zhangbei on 2019-07-08
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
StarlingX
Low
zhangbei

Bug Description

when exec cli system help host-stor-add,i find the parameter "function" is a Optional arguments(include by []),
but in fact it devides to Positional arguments,i think it maybu a question.
system help host-stor-add
usage: system host-stor-add [--journal-location [<journal_location>]]
                            [--journal-size [<size of the journal GiB>]]
                            [--tier-uuid [<storage tier uuid>]]
                            <hostname or id> [<function>] <idisk_uuid>

Add a storage to a host.

Positional arguments:
  <hostname or id> Name or ID of host [REQUIRED]
  <function> Type of the stor (default: osd)
  <idisk_uuid> uuid of disk [REQUIRED]

Optional arguments:
  --journal-location [<journal_location>]
                        Location of stor's journal
  --journal-size [<size of the journal (GiB)>]
                        Size of stor's journal, in GiB
  --tier-uuid [<storage tier uuid>]
                        storage tier to assign this OSD

Ghada Khalil (gkhalil) wrote :

Low priority / not gating - minor issue with the help for one cli cmd

Changed in starlingx:
importance: Undecided → Low
status: New → Triaged
zhangbei (zb-ccc) on 2019-07-09
Changed in starlingx:
assignee: nobody → zhangbei (zb-ccc)

Fix proposed to branch: master
Review: https://review.opendev.org/669783

Changed in starlingx:
status: Triaged → In Progress
zhangbei (zb-ccc) wrote :

The revised help information is as follows:
system help host-stor-add
usage: system host-stor-add [--function [<function>]]
                            [--journal-location [<journal_location>]]
                            [--journal-size [<size of the journal GiB>]]
                            [--tier-uuid [<storage tier uuid>]]
                            <hostname or id> <idisk_uuid>

Add a storage to a host.

Positional arguments:
  <hostname or id> Name or ID of host [REQUIRED]
  <idisk_uuid> uuid of disk [REQUIRED]

Optional arguments:
  --function [<function>]
                        Type of the stor (default: osd)
  --journal-location [<journal_location>]
                        Location of stor's journal
  --journal-size [<size of the journal (GiB)>]
                        Size of stor's journal, in GiB
  --tier-uuid [<storage tier uuid>]
                        storage tier to assign this OSD

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers