CLI Example doc additions to fix the sysmod test failure

This commit is contained in:
rallytime 2016-07-14 17:34:02 -06:00
parent 41011d2fe5
commit 8b8e2a1dc3
3 changed files with 29 additions and 0 deletions

View File

@ -32,6 +32,21 @@ def __virtual__():
def update(user=None, env=None):
'''
Updates list of known packages.
user
The user to run cabal update with
env
Environment variables to set when invoking cabal. Uses the
same ``env`` format as the :py:func:`cmd.run
<salt.modules.cmdmod.run>` execution function.
CLI Example:
.. code-block:: bash
salt '*' cabal.update
'''
return __salt__['cmd.run_all']('cabal update', runas=user, env=env)
@ -148,6 +163,13 @@ def uninstall(pkg,
Environment variables to set when invoking cabal. Uses the
same ``env`` format as the :py:func:`cmd.run
<salt.modules.cmdmod.run>` execution function
CLI Example:
.. code-block:: bash
salt '*' cabal.uninstall ShellCheck
'''
cmd = ['ghc-pkg unregister']
cmd.append('"{0}"'.format(pkg))

View File

@ -784,6 +784,8 @@ def list_repos(profile='github'):
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.list_repos
@ -802,6 +804,8 @@ def list_private_repos(profile='github'):
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.list_private_repos
@ -823,6 +827,8 @@ def list_public_repos(profile='github'):
profile
The name of the profile configuration to use. Defaults to ``github``.
CLI Example:
.. code-block:: bash
salt myminion github.list_public_repos

View File

@ -81,6 +81,7 @@ class SysModuleTest(integration.ModuleCase):
noexample = set()
allow_failure = (
'cp.recv',
'libcloud_dns.get_driver',
'lxc.run_cmd',
'pkg.expand_repo_def',
'runtests_decorators.depends',