From d8955d556850fd024752ac6f431aa7f812fe1ec3 Mon Sep 17 00:00:00 2001 From: Abhishek Lekshmanan Date: Mon, 10 Oct 2016 21:36:29 +0200 Subject: [PATCH] scripts: add description to ceph-release-notes Signed-off-by: Abhishek Lekshmanan --- src/script/ceph-release-notes | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) 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", -- 2.47.3