[1.29] feat/cct-868: Subset of list command options marked as deprecated

* Options --available, --all, --ondate, --servicelevel --no-overlap --match-install, --pool-only, --afterdate were marked as deprecated in ListCommand definition of their help string. * The options were marked as deprecated in list command manuald page. CARD ID: cct-868
candlepin · Oct 25, 2024 · cc3155f · cc3155f
1 parent 061187c
commit cc3155f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 15 deletions.
diff --git a/man/subscription-manager.8 b/man/subscription-manager.8
@@ -614,17 +614,17 @@ command lists all of the subscriptions that are compatible with a system. The op
 .B --afterdate=YYYY-MM-DD
 Shows pools that are active on or after the given date. This is only used with the
 .B --available
-option.
+option. (deprecated)
 
 .TP
 .B --all
 Lists all possible subscriptions that have been purchased, even if they don't match the architecture of the system. This is used with the
 .B --available
-option.
+option. (deprecated)
 
 .TP
 .B --available
-Lists available subscriptions which are not yet attached to the system.
+Lists available subscriptions which are not yet attached to the system. (deprecated)
 
 .TP
 .B --consumed
@@ -638,19 +638,19 @@ Lists products which are currently installed on the system which may (or may not
 .B --ondate=YYYY-MM-DD
 Sets the date to use to search for active and available subscriptions. The default (if not explicitly passed) is today's date; using a later date looks for subscriptions which will be active then. This is only used with the
 .B --available
-option.
+option. (deprecated)
 
 .TP
 .B --no-overlap
 Shows pools which provide products that are not already covered; only used with
 .B --available
-option.
+option. (deprecated)
 
 .TP
 .B --match-installed
 Shows only subscriptions matching products that are currently installed; only used with
 .B --available
-option.
+option. (deprecated)
 
 .TP
 .B --matches=SEARCH
@@ -661,7 +661,7 @@ question mark or asterisk. Likewise, to represent a backslash, it must be escape
 
 .TP
 .B --pool-only
-Limits the output of --available and --consumed such that only the pool IDs are displayed. No labels or errors will be printed if this option is specified.
+Limits the output of --available and --consumed such that only the pool IDs are displayed. No labels or errors will be printed if this option is specified. (deprecated)
 
 .SS REFRESH OPTIONS
 The

diff --git a/src/subscription_manager/cli_command/list.py b/src/subscription_manager/cli_command/list.py
@@ -217,18 +217,19 @@ def __init__(self):
         self.parser.add_argument(
             "--available",
             action="store_true",
-            help=_("show those subscriptions which are available"),
+            help=_("show those subscriptions which are available (deprecated)"),
         )
         self.parser.add_argument(
             "--all",
             action="store_true",
-            help=_("used with --available to ensure all subscriptions are returned"),
+            help=_("used with --available to ensure all subscriptions are returned (deprecated)"),
         )
         self.parser.add_argument(
             "--ondate",
             dest="on_date",
             help=_(
-                "date to search on, defaults to today's date, only used with --available (example: {example})"
+                "date to search on, defaults to today's date, "
+                "only used with --available (example: {example}) (deprecated)"
             ).format(example=strftime("%Y-%m-%d", localtime())),
         )
         self.parser.add_argument(
@@ -241,23 +242,23 @@ def __init__(self):
             dest="service_level",
             help=_(
                 "shows only subscriptions matching the specified service level; "
-                "only used with --available and --consumed"
+                "only used with --available and --consumed (deprecated)"
             ),
         )
         self.parser.add_argument(
             "--no-overlap",
             action="store_true",
             help=_(
                 "shows pools which provide products that are not already covered; "
-                "only used with --available"
+                "only used with --available (deprecated)"
             ),
         )
         self.parser.add_argument(
             "--match-installed",
             action="store_true",
             help=_(
                 "shows only subscriptions matching products that are currently installed; "
-                "only used with --available"
+                "only used with --available (deprecated)"
             ),
         )
         self.parser.add_argument(
@@ -275,15 +276,15 @@ def __init__(self):
             action="store_true",
             help=_(
                 "lists only the pool IDs for applicable available or consumed subscriptions; "
-                "only used with --available and --consumed"
+                "only used with --available and --consumed (deprecated)"
             ),
         )
         self.parser.add_argument(
             "--afterdate",
             dest="after_date",
             help=_(
                 "show pools that are active on or after the given date; "
-                "only used with --available (example: {example})"
+                "only used with --available (example: {example}) (deprecated)"
             ).format(example=strftime("%Y-%m-%d", localtime())),
         )