From: Artem Bityutskiy <artem.bityutskiy@intel.com>
Date: Thu, 20 Dec 2012 08:21:19 +0000 (+0200)
Subject: bmaptool: provied a link to the docs in help output
X-Git-Tag: v2.0~24
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f95696e37b390da292f7b46e9b5b22def64d55d7;p=tools%2Fbmap-tools.git

bmaptool: provied a link to the docs in help output

Change-Id: Id4d130ee29af411119ff5218ff99190f011f12a8
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>
---

diff --git a/TODO b/TODO
index fbb5913..0589c93 100644
--- a/TODO
+++ b/TODO
@@ -5,5 +5,3 @@
    better to know if something is not exactly as expected.
 6. When file size is unknown, implement a "wheel" instead of progress bar
 7. Add locking to all classes
-8. bmaptool: no need to print lengthy docstring in --help - provide the
-   documentation URL
diff --git a/bmaptool b/bmaptool
index 0cc6e29..1d0c04a 100755
--- a/bmaptool
+++ b/bmaptool
@@ -4,7 +4,6 @@
 # License: GPLv2
 # Author: Artem Bityutskiy <artem.bityutskiy@linux.intel.com>
 
-# Note! We use the below docstring for the program help text as well.
 """ This is a tool to generate block map files (bmap) and to copy files using
 bmap. Generally speaking, these tools are about writing large image files
 quickly.
@@ -262,7 +261,10 @@ def create_command(args, log):
 def parse_arguments():
     """ A helper function which parses the input arguments. """
 
-    parser = argparse.ArgumentParser(description = __doc__, prog = 'bmaptool')
+    text = "Create block map (bmap) and copy files using bmap. The " \
+           "documentation can be found here: " \
+           "source.tizen.org/documentation/reference/bmaptool"
+    parser = argparse.ArgumentParser(description = text, prog = 'bmaptool')
 
     # The --version option
     parser.add_argument("--version", action = "version", \