From d6a07212ad3fa27eb7e0378cbe78d5cd559abcdb Mon Sep 17 00:00:00 2001
From: Ken Dreyer <kdreyer@redhat.com>
Date: Mar 07 2022 08:47:20 +0000
Subject: diff: improve --help text


Add a description for this command explaining that this tool writes its
output to the current working directory.

Expand the --help text for each command-line option.

---

diff --git a/compose_utils/diff.py b/compose_utils/diff.py
index 8cf793c..03d79c8 100644
--- a/compose_utils/diff.py
+++ b/compose_utils/diff.py
@@ -2,13 +2,21 @@
 
 
 import argparse
+from argparse import RawTextHelpFormatter
 import copy
 import json
 import os
-
 import productmd
 from kobo.rpmlib import parse_nvra
 
+DESCRIPTION = """
+Generate a difference in RPM packages between two composes.
+
+This is a bit more low-level than compose-changelog.
+
+This writes a set of diff files into the current working directory.
+"""
+
 
 class ComposeRpmsDiff(object):
     def get_srpms(self, rpmm):
@@ -308,11 +316,16 @@ class ComposeRpmsDiff(object):
 
 
 def main(argv=None):
-    parser = argparse.ArgumentParser()
-    parser.add_argument("--old", metavar="PATH", help="old compose", required=True)
-    parser.add_argument("--new", metavar="PATH", help="new compose", required=True)
-    parser.add_argument("-o", "--outputdir", help="output dir")
-    parser.add_argument("--name", help="log name appended to file name")
+    parser = argparse.ArgumentParser(description=DESCRIPTION,
+                                     formatter_class=RawTextHelpFormatter)
+
+    parser.add_argument("--old", metavar="PATH", help="old compose path or URL", required=True)
+    parser.add_argument("--new", metavar="PATH", help="new compose path or URL", required=True)
+    parser.add_argument("-o", "--outputdir",
+                        help="write logs to another location instead of the " \
+                             "current working directory")
+    parser.add_argument("--name", help='custom name for output files: ' \
+                                       '"diff-rpms-(name)"')
 
     args = parser.parse_args(argv)