<div class="gmail_extra"><br><br><div class="gmail_quote">On Tue, May 1, 2012 at 1:54 PM, Adam Spiers <span dir="ltr"><<a href="mailto:aspiers@suse.com" target="_blank">aspiers@suse.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div class="im">Matt Joyce (<a href="mailto:matt@nycresistor.com">matt@nycresistor.com</a>) wrote:<br>
> >  3. I think it would be good if the HIG recommended that, at least<br>
> >     when subcommands are permitted, single arguments '--help' and<br>
> >     'help' always generate identical output:<br>
> ><br>
> >       <a href="https://bugs.launchpad.net/keystone/+bug/936399" target="_blank">https://bugs.launchpad.net/keystone/+bug/936399</a><br>
> >       <a href="https://review.openstack.org/#/c/6460/" target="_blank">https://review.openstack.org/#/c/6460/</a><br>
><br>
> Same for Version ( --version )<br>
<br>
</div>Good point!  I've added some draft text to the wiki page for that,<br>
partially pinched from:<br>
<br>
  <a href="http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces" target="_blank">http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces</a><br>
<br>
As you can see, the GNU standards go into great detail regarding<br>
--version; I don't know if we want to be as stringent, particularly<br>
regarding copyright / license notices, but there's some good food for<br>
thought there.<br></blockquote><div><br></div><div>The version flag is also handled by argparse automatically. We can set the version string to whatever we want, of course.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

<div class="im"><br>
> >  5. I think it would be good if the HIG specified what sort of help<br>
> >     text should be included alongside error messages of (say) the<br>
> >     "you didn't give the right number of arguments" variety, and<br>
> >     whether the error message should appear before or after that help<br>
> >     text.  My vote is after, because it's far easier for the human<br>
> >     eye to locate the end of a command's output than the beginning,<br>
> >     especially if the beginning has scrolled off the top of the<br>
> >     terminal.<br>
><br>
> I wonder if this event tracking is relevant to metering.  At the very<br>
> least it could be relevant to an audit log / revision history.<br>
><br>
> Curious if that's outside the scope of the CLI.   For one, I believe<br>
> it would be worthwhile to be able to integrate with the APIs to<br>
> provide a recall of past events and results.<br>
<br>
</div>Agreed - while server-side auditing is a more important component than<br>
client-side, having both sounds potentially useful to me too.  And<br>
while it's outside the scope of a CLI HIG discussion, it's<br>
nevertheless relevant to any work on a unified CLI.<br>
<div class="HOEnZb"><div class="h5"><br>
_______________________________________________<br>
Mailing list: <a href="https://launchpad.net/~openstack" target="_blank">https://launchpad.net/~openstack</a><br>
Post to     : <a href="mailto:openstack@lists.launchpad.net">openstack@lists.launchpad.net</a><br>
Unsubscribe : <a href="https://launchpad.net/~openstack" target="_blank">https://launchpad.net/~openstack</a><br>
More help   : <a href="https://help.launchpad.net/ListHelp" target="_blank">https://help.launchpad.net/ListHelp</a><br>
</div></div></blockquote></div><br></div>