Code conventions

Follow these guidelines:

  • Do not use “-y” for package install

    When you describe package installation, do not use the -y option. Instead, use apt-get install package, yum install package, or zypper install package.

  • Use “–option ARGUMENT”

    The OpenStack CLI supports both --option ARGUMENT and --option=ARGUMENT. In technical publications, use --option ARGUMENT.

  • Use capital letters with underscores for parameters

    When you write parameters in an example command, use capital letters for the parameters, with underscore as a delimiter. For example:

    $ openstack user create --project PROJECT_A --password PASSWORD USERNAME

    If necessary, describe the parameters immediately after the example command block. For example, for the PASSWORD parameter:

    Replace ``PASSWORD`` with a suitable password.