Open Stack

Thank you all for the feedback!

I've updated the wiki and will get started on the 'conventions used in 
this book' part.

Gauvain

Objectif Libre - Infrastructure et Formations Linux
http://www.objectif-libre.com

Le 2014-03-10 17:07, Gauvain Pocentek a écrit :
> Hello,
> 
> We have a lot of shell prompts in the documentation, and there
> doesn't seem to be a convention defining in which case $ or # should
> be used. We also have an inconsistent use of sudo.
> 
> I'd like to suggest the following convention:
> 
> * use # for commands that *need* root privileges to work (*-manage,
> mysqladmin, service...)
> * use $ for commands that don't require root privileges (all the 
> clients)
> * never use sudo
> * add a "Conventions used in this book" section in all guides (as is
> done in all the tech books I ever read) to explain what the prompts
> actually mean:
>   - # => you must be root or use sudo
>   - $ => you can run the command as unprivileged user, but as root as 
> well
> 
> I guess you can call this nitpicking but I've seen a couple of users
> confused in bug reports, and consistency is Good anyway :)
> 
> Let me know what you think and if we agree on this (or an updated
> proposal) I'll update the wiki and start working on this (might be a
> simple way to get started for newcomers as well).
> 
> Thanks,
> Gauvain
> 
> Objectif Libre - Infrastructure et Formations Linux
> http://www.objectif-libre.com
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs