aboutsummaryrefslogtreecommitdiffstats
path: root/tools/create_changelog.py
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2022-03-01 08:09:37 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2022-03-01 12:09:58 +0100
commit0107a91db2bd86145fbcd65091bb6dc622842adb (patch)
tree2028680f3309ea64f3d6a4662d5e43db76ed365a /tools/create_changelog.py
parenteca08cee575b4d81290794901766eca777103862 (diff)
create_changelog: Add sample usage
Pick-to: 6.2 Change-Id: Ia0dcfcbf4ea14e4f59258f572ee3308e6ef42268 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'tools/create_changelog.py')
-rw-r--r--tools/create_changelog.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/tools/create_changelog.py b/tools/create_changelog.py
index b10dc9f82..b0fc6e718 100644
--- a/tools/create_changelog.py
+++ b/tools/create_changelog.py
@@ -69,6 +69,13 @@ shiboken_header = """***********************************************************
****************************************************************************
"""
+description = """
+PySide6 changelog tool
+
+Example usage:
+tools/create_changelog.py -v v6.2.3..HEAD -r 6.2.4
+"""
+
def parse_options() -> Namespace:
tag_msg = ("Tags, branches, or SHA to compare\n"
@@ -76,7 +83,7 @@ def parse_options() -> Namespace:
" v5.12.0..v5.12.1\n"
" cebc32a5..5.12")
- options = ArgumentParser(description="PySide6 changelog tool",
+ options = ArgumentParser(description=description,
formatter_class=RawTextHelpFormatter)
options.add_argument("-d",
"--directory",