saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Merge pull request #41948 from davidjb/patch-9

Browse source 
Fix Composer state's `name` docs; formatting
This commit is contained in:
Mike Place 2017-06-27 12:51:28 -05:00 • committed by GitHub
commit f0eb51df17
1 changed files with 29 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
salt/states/composer.py
View file

@ -66,17 +66,17 @@ def installed(name,
'''
Verify that the correct versions of composer dependencies are present.
dir
Directory location of the composer.json file.
name
Directory location of the ``composer.json`` file.
composer
Location of the composer.phar file. If not set composer will
just execute "composer" as if it is installed globally.
(i.e. /path/to/composer.phar)
Location of the ``composer.phar`` file. If not set composer will
just execute ``composer`` as if it is installed globally.
(i.e. ``/path/to/composer.phar``)
php
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
(i.e. ``/usr/bin/php``)
user
Which system user to run composer as.
@ -84,32 +84,32 @@ def installed(name,
.. versionadded:: 2014.1.4
prefer_source
--prefer-source option of composer.
``--prefer-source`` option of composer.
prefer_dist
--prefer-dist option of composer.
``--prefer-dist`` option of composer.
no_scripts
--no-scripts option of composer.
``--no-scripts`` option of composer.
no_plugins
--no-plugins option of composer.
``--no-plugins`` option of composer.
optimize
--optimize-autoloader option of composer. Recommended for production.
``--optimize-autoloader`` option of composer. Recommended for production.
no_dev
--no-dev option for composer. Recommended for production.
``--no-dev`` option for composer. Recommended for production.
quiet
--quiet option for composer. Whether or not to return output from composer.
``--quiet`` option for composer. Whether or not to return output from composer.
composer_home
$COMPOSER_HOME environment variable
``$COMPOSER_HOME`` environment variable
always_check
If True, _always_ run `composer install` in the directory. This is the
default behavior. If False, only run `composer install` if there is no
If ``True``, *always* run ``composer install`` in the directory. This is the
default behavior. If ``False``, only run ``composer install`` if there is no
vendor directory present.
'''
ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}
@ -193,17 +193,17 @@ def update(name,
Composer update the directory to ensure we have the latest versions
of all project dependencies.
dir
Directory location of the composer.json file.
name
Directory location of the ``composer.json`` file.
composer
Location of the composer.phar file. If not set composer will
just execute "composer" as if it is installed globally.
Location of the ``composer.phar`` file. If not set composer will
just execute ``composer`` as if it is installed globally.
(i.e. /path/to/composer.phar)
php
Location of the php executable to use with composer.
(i.e. /usr/bin/php)
(i.e. ``/usr/bin/php``)
user
Which system user to run composer as.
@ -211,28 +211,28 @@ def update(name,
.. versionadded:: 2014.1.4
prefer_source
--prefer-source option of composer.
``--prefer-source`` option of composer.
prefer_dist
--prefer-dist option of composer.
``--prefer-dist`` option of composer.
no_scripts
--no-scripts option of composer.
``--no-scripts`` option of composer.
no_plugins
--no-plugins option of composer.
``--no-plugins`` option of composer.
optimize
--optimize-autoloader option of composer. Recommended for production.
``--optimize-autoloader`` option of composer. Recommended for production.
no_dev
--no-dev option for composer. Recommended for production.
``--no-dev`` option for composer. Recommended for production.
quiet
--quiet option for composer. Whether or not to return output from composer.
``--quiet`` option for composer. Whether or not to return output from composer.
composer_home
$COMPOSER_HOME environment variable
``$COMPOSER_HOME`` environment variable
'''
ret = {'name': name, 'result': None, 'comment': '', 'changes': {}}