improve osd help by adding example of activation by paths

Signed-off-by: Alfredo Deza <alfredo.deza@inktank.com>

diff --git a/ceph_deploy/osd.py b/ceph_deploy/osd.py
index 178f73730c652e859b703650e9c2a7dc8cd5ba8b..bfe032315fe15bdefd5ac4c825dde79e03b0fd8d 100644 (file)
--- a/ceph_deploy/osd.py
+++ b/ceph_deploy/osd.py
@@ -2,6 +2,7 @@ import argparse
 import logging
 import os
 import sys
+from textwrap import dedent
 
 from cStringIO import StringIO
 
@@ -410,6 +411,21 @@ def make(parser):
     """
     Prepare a data disk on remote host.
     """
+    sub_command_help = dedent("""
+    Manage OSDs by preparing a data disk on remote host.
+
+    For paths, first prepare and then activate:
+
+        ceph-deploy osd prepare {osd-node-name}:/path/to/osd
+        ceph-deploy osd activate {osd-node-name}:/path/to/osd
+
+    For disks or journals the `create` command will do prepare and activate
+    for you.
+    """
+    )
+    parser.formatter_class  = argparse.RawDescriptionHelpFormatter
+    parser.description = sub_command_help
+
     parser.add_argument(
         'subcommand',
         metavar='SUBCOMMAND',
@@ -471,7 +487,7 @@ def make_disk(parser):
         nargs='+',
         metavar='HOST:DISK',
         type=colon_separated,
-        help='host and disk to zap',
+        help='host and disk (or path)',
         )
     parser.add_argument(
         '--zap-disk',