docs: add note to deprecated flags

and regenerate docs

In the future these will be removed from the docs entirely but that
requires a patch to Cobra, for now we just add a deprecation note.

fixes #3104

docs/source/sctool/partials/sctool_backup.yaml

@@ -41,6 +41,7 @@ options:
 - name: interval
   shorthand: i
   usage: |
+    --interval is deprecated, please use `--cron` instead
     Time after which a successfully completed task would be run again, supported units are:
 
     'd' - days
@@ -59,10 +60,10 @@ options:
     The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
     The following syntax for glob patterns is supported:
 
-    '*' - matches any number of any characters including none
-    '?' - matches any single character
-    '[abc]' - matches one character given in the bracket
-    '[a-z]' - matches one character from the range given in the bracket
+    * '*' - matches any number of any characters including none
+    * '?' - matches any single character
+    * '[abc]' - matches one character given in the bracket
+    * '[a-z]' - matches one character from the range given in the bracket
 
     Patterns are evaluated from left to right.
     If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
@@ -99,9 +100,7 @@ options:
   usage: |
     The `number of backups` to store, once this number is reached, the next backup which comes in from this destination will initiate a purge of the oldest backup.
 - name: retention-days
-  usage: |
-    The number of days to retain a backup. All backups older than this will be purged.
-    Set to 0 for no limit (default 0)
+  default_value: "0"
 - name: retry-wait
   default_value: 10m
   usage: |
@@ -121,6 +120,7 @@ options:
 - name: start-date
   shorthand: s
   usage: |
+    --start-date is deprecated, please use `--cron` instead
     The date can be expressed relatively to now or as a RFC3339 formatted string.
     To run the task in 2 hours use 'now+2h', supported units are:
 

docs/source/sctool/partials/sctool_backup_list.yaml

@@ -24,10 +24,10 @@ options:
     The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
     The following syntax for glob patterns is supported:
 
-    '*' - matches any number of any characters including none
-    '?' - matches any single character
-    '[abc]' - matches one character given in the bracket
-    '[a-z]' - matches one character from the range given in the bracket
+    * '*' - matches any number of any characters including none
+    * '?' - matches any single character
+    * '[abc]' - matches one character given in the bracket
+    * '[a-z]' - matches one character from the range given in the bracket
 
     Patterns are evaluated from left to right.
     If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.

docs/source/sctool/partials/sctool_backup_update.yaml

@@ -42,6 +42,7 @@ options:
 - name: interval
   shorthand: i
   usage: |
+    --interval is deprecated, please use `--cron` instead
     Time after which a successfully completed task would be run again, supported units are:
 
     'd' - days
@@ -60,10 +61,10 @@ options:
     The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
     The following syntax for glob patterns is supported:
 
-    '*' - matches any number of any characters including none
-    '?' - matches any single character
-    '[abc]' - matches one character given in the bracket
-    '[a-z]' - matches one character from the range given in the bracket
+    * '*' - matches any number of any characters including none
+    * '?' - matches any single character
+    * '[abc]' - matches one character given in the bracket
+    * '[a-z]' - matches one character from the range given in the bracket
 
     Patterns are evaluated from left to right.
     If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
@@ -99,6 +100,8 @@ options:
   default_value: "7"
   usage: |
     The `number of backups` to store, once this number is reached, the next backup which comes in from this destination will initiate a purge of the oldest backup.
+- name: retention-days
+  default_value: "0"
 - name: retry-wait
   default_value: 10m
   usage: |
@@ -118,6 +121,7 @@ options:
 - name: start-date
   shorthand: s
   usage: |
+    --start-date is deprecated, please use `--cron` instead
     The date can be expressed relatively to now or as a RFC3339 formatted string.
     To run the task in 2 hours use 'now+2h', supported units are:
 

docs/source/sctool/partials/sctool_backup_validate.yaml

@@ -31,6 +31,7 @@ options:
 - name: interval
   shorthand: i
   usage: |
+    --interval is deprecated, please use `--cron` instead
     Time after which a successfully completed task would be run again, supported units are:
 
     'd' - days
@@ -69,6 +70,7 @@ options:
 - name: start-date
   shorthand: s
   usage: |
+    --start-date is deprecated, please use `--cron` instead
     The date can be expressed relatively to now or as a RFC3339 formatted string.
     To run the task in 2 hours use 'now+2h', supported units are:
 

docs/source/sctool/partials/sctool_backup_validate_update.yaml

@@ -28,6 +28,7 @@ options:
 - name: interval
   shorthand: i
   usage: |
+    --interval is deprecated, please use `--cron` instead
     Time after which a successfully completed task would be run again, supported units are:
 
     'd' - days
@@ -66,6 +67,7 @@ options:
 - name: start-date
   shorthand: s
   usage: |
+    --start-date is deprecated, please use `--cron` instead
     The date can be expressed relatively to now or as a RFC3339 formatted string.
     To run the task in 2 hours use 'now+2h', supported units are:
 

docs/source/sctool/partials/sctool_progress.yaml

@@ -39,10 +39,10 @@ options:
     The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
     The following syntax for glob patterns is supported:
 
-    '*' - matches any number of any characters including none
-    '?' - matches any single character
-    '[abc]' - matches one character given in the bracket
-    '[a-z]' - matches one character from the range given in the bracket
+    * '*' - matches any number of any characters including none
+    * '?' - matches any single character
+    * '[abc]' - matches one character given in the bracket
+    * '[a-z]' - matches one character from the range given in the bracket
 
     Patterns are evaluated from left to right.
     If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.

docs/source/sctool/partials/sctool_repair.yaml

@@ -62,6 +62,7 @@ options:
 - name: interval
   shorthand: i
   usage: |
+    --interval is deprecated, please use `--cron` instead
     Time after which a successfully completed task would be run again, supported units are:
 
     'd' - days
@@ -80,10 +81,10 @@ options:
     The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
     The following syntax for glob patterns is supported:
 
-    '*' - matches any number of any characters including none
-    '?' - matches any single character
-    '[abc]' - matches one character given in the bracket
-    '[a-z]' - matches one character from the range given in the bracket
+    * '*' - matches any number of any characters including none
+    * '?' - matches any single character
+    * '[abc]' - matches one character given in the bracket
+    * '[a-z]' - matches one character from the range given in the bracket
 
     Patterns are evaluated from left to right.
     If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
@@ -120,6 +121,7 @@ options:
 - name: start-date
   shorthand: s
   usage: |
+    --start-date is deprecated, please use `--cron` instead
     The date can be expressed relatively to now or as a RFC3339 formatted string.
     To run the task in 2 hours use 'now+2h', supported units are:
 

docs/source/sctool/partials/sctool_repair_update.yaml

@@ -61,6 +61,7 @@ options:
 - name: interval
   shorthand: i
   usage: |
+    --interval is deprecated, please use `--cron` instead
     Time after which a successfully completed task would be run again, supported units are:
 
     'd' - days
@@ -79,10 +80,10 @@ options:
     The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
     The following syntax for glob patterns is supported:
 
-    '*' - matches any number of any characters including none
-    '?' - matches any single character
-    '[abc]' - matches one character given in the bracket
-    '[a-z]' - matches one character from the range given in the bracket
+    * '*' - matches any number of any characters including none
+    * '?' - matches any single character
+    * '[abc]' - matches one character given in the bracket
+    * '[a-z]' - matches one character from the range given in the bracket
 
     Patterns are evaluated from left to right.
     If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
@@ -119,6 +120,7 @@ options:
 - name: start-date
   shorthand: s
   usage: |
+    --start-date is deprecated, please use `--cron` instead
     The date can be expressed relatively to now or as a RFC3339 formatted string.
     To run the task in 2 hours use 'now+2h', supported units are:
 

docs/source/sctool/partials/sctool_suspend.yaml

@@ -34,6 +34,7 @@ options:
 - name: interval
   shorthand: i
   usage: |
+    --interval is deprecated, please use `--cron` instead
     Time after which a successfully completed task would be run again, supported units are:
 
     'd' - days
@@ -63,6 +64,7 @@ options:
 - name: start-date
   shorthand: s
   usage: |
+    --start-date is deprecated, please use `--cron` instead
     The date can be expressed relatively to now or as a RFC3339 formatted string.
     To run the task in 2 hours use 'now+2h', supported units are:
 

docs/source/sctool/partials/sctool_suspend_update.yaml

@@ -26,6 +26,7 @@ options:
 - name: interval
   shorthand: i
   usage: |
+    --interval is deprecated, please use `--cron` instead
     Time after which a successfully completed task would be run again, supported units are:
 
     'd' - days
@@ -55,6 +56,7 @@ options:
 - name: start-date
   shorthand: s
   usage: |
+    --start-date is deprecated, please use `--cron` instead
     The date can be expressed relatively to now or as a RFC3339 formatted string.
     To run the task in 2 hours use 'now+2h', supported units are:
 

pkg/command/flag/task.yaml

@@ -21,6 +21,7 @@ timezone: |
   The default value is taken from this system, namely 'TZ' envvar or '/etc/localtime' file.
 
 interval: |
+  --interval is deprecated, please use `--cron` instead
   Time after which a successfully completed task would be run again, supported units are:
 
   * 'd' - days
@@ -33,6 +34,7 @@ interval: |
   For example, if you select '--interval 7d' task would run weekly at the '--start-date' time.
 
 start-date: |
+  --start-date is deprecated, please use `--cron` instead
   The date can be expressed relatively to now or as a RFC3339 formatted string.
   To run the task in 2 hours use 'now+2h', supported units are: