Improve help of each command

[tools/sat.git] / commands / patch.py

diff --git a/commands/patch.py b/commands/patch.py
index 30b7332d69a5a89b76ba28b81813da367eea28b6..900753c684f715bb09233f2e3b2c95f11ac12518 100644 (file)
--- a/commands/patch.py
+++ b/commands/patch.py
@@ -25,7 +25,7 @@ import prepare
 # Define all possible option for patch command :  sat patch <options>
 parser = src.options.Options()
 parser.add_option('p', 'products', 'list2', 'products',
-    _('products to get the sources. This option can be'
+    _('Optional: products to get the sources. This option can be'
     ' passed several time to get the sources of several products.'))
 
 def apply_patch(config, product_info, max_product_name_len, logger):
@@ -118,7 +118,8 @@ def description():
     :rtype: str
     '''
     return _("The patch command apply the patches on the sources of "
-             "the application products if there is any")
+             "the application products if there is any.\n\nexample:\nsat "
+             "patch SALOME-master --products qt,boost")
   
 def run(args, runner, logger):
     '''method that is called when salomeTools is called with patch parameter.
@@ -149,7 +150,10 @@ def run(args, runner, logger):
     good_result = 0
     for __, product_info in products_infos:
         # Apply the patch
-        return_code, patch_res = apply_patch(runner.cfg, product_info, max_product_name_len, logger)
+        return_code, patch_res = apply_patch(runner.cfg,
+                                             product_info,
+                                             max_product_name_len,
+                                             logger)
         logger.write(patch_res, 1, False)
         if return_code:
             good_result += 1