Merge pull request #6316 from terminalmage/docstring-tweaks

Update mysql docstrings to reflect new features
This commit is contained in:
Erik Johnson 2013-07-25 14:17:30 -07:00
commit a52773e940
2 changed files with 14 additions and 13 deletions

View File

@ -17,10 +17,11 @@ Module to provide MySQL compatibility to salt.
mysql.default_file: '/etc/mysql/debian.cnf'
.. note::
Version 0.16.1 will add the option to set passwordless logins, as well
as supply the connection arguments directly from the CLI or in an SLS
file.
.. versionchanged:: 0.16.1
Connection arguments from the minion config file can be overridden on the
CLI by using the arguments defined :doc:`here
</ref/states/all/salt.states.mysql_user>`. Additionally, it is now possible
to setup a user with no password.
'''
# Import python libs
@ -563,8 +564,8 @@ def user_exists(user,
if passwordless login is permitted by omitting ``password`` and
``password_hash``, and using ``passwordless=True``.
.. note::
The ``passwordless`` option will be available in version 0.16.1.
.. versionadded:: 0.16.1
The ``passwordless`` option was added.
CLI Example::
@ -660,8 +661,8 @@ def user_create(user,
If ``True``, then ``password`` and ``password_hash`` can be omitted (or
set to ``None``) to permit a passwordless login.
.. note::
The ``allow_passwordless`` option will be available in version 0.16.1.
.. versionadded:: 0.16.1
The ``allow_passwordless`` option was added.
CLI Examples::
@ -741,8 +742,8 @@ def user_chpass(user,
If ``True``, then ``password`` and ``password_hash`` can be omitted (or
set to ``None``) to permit a passwordless login.
.. note::
The ``allow_passwordless`` option will be available in version 0.16.1.
.. versionadded:: 0.16.1
The ``allow_passwordless`` option was added.
CLI Examples::

View File

@ -15,6 +15,9 @@ information.
- password: bobcat
.. versionadded:: 0.16.1
Authentication overrides have been added.
The MySQL authentication information specified in the minion config file can be
overidden in states using the following arguments: ``connection_host``,
``connection_port``, ``connection_user``, ``connection_pass``,
@ -28,9 +31,6 @@ overidden in states using the following arguments: ``connection_host``,
- password: bobcat
- connection_user: someuser
- connection_pass: somepass
.. note::
Authentication overrides will be available in version 0.16.1.
'''
# Import python libs