From c8f0bea2b0017cbca368aec84516a3588ef389aa Mon Sep 17 00:00:00 2001 From: Thomas S Hatch Date: Mon, 14 Mar 2011 16:52:19 -0600 Subject: [PATCH] clean up doc strings for pacman module --- salt/modules/pacman.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/salt/modules/pacman.py b/salt/modules/pacman.py index c84c477f49..9dd969d4a8 100644 --- a/salt/modules/pacman.py +++ b/salt/modules/pacman.py @@ -7,6 +7,9 @@ def list_pkgs(): ''' List the packages currently installed in a dict: {'': ''} + + CLI Example: + salt '*' pacman.list_pkgs ''' cmd = 'pacman -Q' ret = {} @@ -24,6 +27,9 @@ def refresh_db(): ''' Just run a pacman -Sy, return a dict: {'': Bool} + + CLI Example: + salt '*' pacman.refresh_db ''' cmd = 'pacman -Sy' ret = {} @@ -49,6 +55,9 @@ def install(pkg, refresh=False): Return a dict containing the new package names and versions: {'': {'old': '', 'new': '']} + + CLI Example: + salt '*' pacman.install ''' old = list_pkgs() cmd = 'pacman -S --noprogressbar --noconfirm ' + pkg @@ -79,6 +88,9 @@ def upgrade(): Return a dict containing the new package names and versions: {'': {'old': '', 'new': '']} + + CLI Example: + salt '*' pacman.upgrade ''' old = list_pkgs() cmd = 'pacman -Syu --noprogressbar --noconfirm '