[Openstack-docs] Prompts conventions

Steve Gordon sgordon at redhat.com
Mon Mar 10 16:19:14 UTC 2014


----- Original Message -----
> 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
> 

+1 to all of the above.

Thanks,

Steve



More information about the Openstack-docs mailing list