openstack-manuals

Installation Guide - Standardize CLI argument formatting

Bug #1287890 reported by Matt Kassawara
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Wishlist
Christian Berendt
openstack-manuals juno

Bug Description

I noticed some inconsistencies with CLI argument formatting throughout the installation guide. I suspect subtle variations among services in prior releases caused these inconsistencies. However, all services in Icehouse appear to use "--argument value" and "--multiword-argument value" instead of "--argument=value" and "--multiword_argument=value".

Revision history for this message
Stephen Gordon (sgordon) wrote :

Either probably still works but we should pick a format and stick to it.

Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Wishlist
Tom Fifield (fifieldt)
Changed in openstack-manuals:
milestone: icehouse → juno
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

Please add this to https://wiki.openstack.org/wiki/Documentation/Conventions and announce it so that we review and write properly.

Revision history for this message
Andreas Jaeger (jaegerandi) wrote :

Proposal - see also mailing list discussion from today:

https://wiki.openstack.org/wiki/Documentation/Conventions#Client_arguments:_.22--option_ARGUMENT.22

Revision history for this message
Anne Gentle (annegentle) wrote :

Happy with no equal signs as convention.

Andreas Jaeger (jaegerandi)
Changed in openstack-manuals:
assignee: nobody → Christian Berendt (berendt)
status: Confirmed → In Progress
Matt Kassawara (ionosphere80)
Changed in openstack-manuals:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.