scripts: add description to ceph-release-notes

Signed-off-by: Abhishek Lekshmanan <alekshmanan@suse.com>

1 files changed, 12 insertions, 1 deletions

diff --git a/src/script/ceph-release-notes b/src/script/ceph-release-notes
index 31b936f8d5d..ea7125aa648 100755
--- a/src/script/ceph-release-notes
+++ b/src/script/ceph-release-notes
@@ -166,7 +166,18 @@ def make_release_notes(gh, repo, ref, plaintext, verbose, strict):
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser()
+    desc = '''
+    Make ceph release notes for a given revision. Eg usage:
+
+    $ ceph-release-notes -r tags/v0.87..origin/giant $(git rev-parse --show-toplevel)
+
+    It is recommended to set the github env. token in order to avoid
+    hitting the api rate limits.
+    '''
+
+    parser = argparse.ArgumentParser(description=desc,
+                                     formatter_class=argparse.RawTextHelpFormatter)
+
     parser.add_argument("--rev", "-r",
                         help="git revision range for creating release notes")
     parser.add_argument("--text", "-t",