From 9afdd3d188c9cbdc809346c7cb6da7a5c28a6955 Mon Sep 17 00:00:00 2001 From: Kevin Barbour Date: Tue, 12 Apr 2022 11:56:51 +0200 Subject: [PATCH] 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 | 14 +++++++------- .../source/sctool/partials/sctool_backup_list.yaml | 8 ++++---- .../sctool/partials/sctool_backup_update.yaml | 12 ++++++++---- .../sctool/partials/sctool_backup_validate.yaml | 2 ++ .../partials/sctool_backup_validate_update.yaml | 2 ++ docs/source/sctool/partials/sctool_progress.yaml | 8 ++++---- docs/source/sctool/partials/sctool_repair.yaml | 10 ++++++---- .../sctool/partials/sctool_repair_update.yaml | 10 ++++++---- docs/source/sctool/partials/sctool_suspend.yaml | 2 ++ .../sctool/partials/sctool_suspend_update.yaml | 2 ++ pkg/command/flag/task.yaml | 2 ++ 11 files changed, 45 insertions(+), 27 deletions(-) diff --git a/docs/source/sctool/partials/sctool_backup.yaml b/docs/source/sctool/partials/sctool_backup.yaml index 2be9c4c676..89a06269d5 100644 --- a/docs/source/sctool/partials/sctool_backup.yaml +++ b/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: diff --git a/docs/source/sctool/partials/sctool_backup_list.yaml b/docs/source/sctool/partials/sctool_backup_list.yaml index 5e8f21ee04..c21a01aacc 100644 --- a/docs/source/sctool/partials/sctool_backup_list.yaml +++ b/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*. diff --git a/docs/source/sctool/partials/sctool_backup_update.yaml b/docs/source/sctool/partials/sctool_backup_update.yaml index 77286b9d61..832e47278a 100644 --- a/docs/source/sctool/partials/sctool_backup_update.yaml +++ b/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: diff --git a/docs/source/sctool/partials/sctool_backup_validate.yaml b/docs/source/sctool/partials/sctool_backup_validate.yaml index cec0eefd87..e3a2323253 100644 --- a/docs/source/sctool/partials/sctool_backup_validate.yaml +++ b/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: diff --git a/docs/source/sctool/partials/sctool_backup_validate_update.yaml b/docs/source/sctool/partials/sctool_backup_validate_update.yaml index e7f844f466..1e44cac8f4 100644 --- a/docs/source/sctool/partials/sctool_backup_validate_update.yaml +++ b/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: diff --git a/docs/source/sctool/partials/sctool_progress.yaml b/docs/source/sctool/partials/sctool_progress.yaml index 63538f2820..8d8c8e405f 100644 --- a/docs/source/sctool/partials/sctool_progress.yaml +++ b/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*. diff --git a/docs/source/sctool/partials/sctool_repair.yaml b/docs/source/sctool/partials/sctool_repair.yaml index 8b33057c97..f11cf98a1c 100644 --- a/docs/source/sctool/partials/sctool_repair.yaml +++ b/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: diff --git a/docs/source/sctool/partials/sctool_repair_update.yaml b/docs/source/sctool/partials/sctool_repair_update.yaml index c9d91e228e..34b5ea1c2d 100644 --- a/docs/source/sctool/partials/sctool_repair_update.yaml +++ b/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: diff --git a/docs/source/sctool/partials/sctool_suspend.yaml b/docs/source/sctool/partials/sctool_suspend.yaml index 04fb9e1b42..30a8210107 100644 --- a/docs/source/sctool/partials/sctool_suspend.yaml +++ b/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: diff --git a/docs/source/sctool/partials/sctool_suspend_update.yaml b/docs/source/sctool/partials/sctool_suspend_update.yaml index b76ed17d52..00da1fb3e1 100644 --- a/docs/source/sctool/partials/sctool_suspend_update.yaml +++ b/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: diff --git a/pkg/command/flag/task.yaml b/pkg/command/flag/task.yaml index 0c5cfc78b4..6e80fa648f 100644 --- a/pkg/command/flag/task.yaml +++ b/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: