config: deprecate LabelType and CheckLabels#1521
Merged
BareosBot merged 3 commits intobareos:masterfrom Aug 24, 2023
Merged
Conversation
e6ec0fd to
f8de6ea
Compare
pstorz
requested changes
Aug 15, 2023
Member
There was a problem hiding this comment.
Wouldn't it be simpler to set the configuration directive itself to deprecated:
diff --git a/core/src/stored/stored_conf.cc b/core/src/stored/stored_conf.cc
index 173aeef20..ce04c58a3 100644
--- a/core/src/stored/stored_conf.cc
+++ b/core/src/stored/stored_conf.cc
@@ -198,7 +198,7 @@ static ResourceItem dev_items[] = {
{"MountPoint", CFG_TYPE_STRNAME, ITEM(res_dev, mount_point), 0, 0, NULL, NULL, NULL},
{"MountCommand", CFG_TYPE_STRNAME, ITEM(res_dev, mount_command), 0, 0, NULL, NULL, NULL},
{"UnmountCommand", CFG_TYPE_STRNAME, ITEM(res_dev, unmount_command), 0, 0, NULL, NULL, NULL},
- {"LabelType", CFG_TYPE_LABEL, ITEM(res_dev, label_type), 0, 0, NULL, NULL, NULL},
+ {"LabelType", CFG_TYPE_LABEL, ITEM(res_dev, label_type), 0, CFG_ITEM_DEPRECATED, NULL, "-23.0.0", NULL},
This creates a deprecation warning like this:
here are configuration warnings:
* using deprecated keyword LabelType on line 14 of file .../etc/bareos/bareos-sd.d/device/FileStorage.conf
Also, we probably need to update the documentation about the tape labels, see: https://docs.bareos.org/Appendix/Troubleshooting.html#tape-labels-ansi-or-ibm
Additionally, we probably want to deprecate also the directive CheckLabels. as it seems only to be used for IBM/ANSI Labels
f8de6ea to
272a7f4
Compare
LabelType and CheckLabels
pstorz
approved these changes
Aug 24, 2023
pstorz
approved these changes
Aug 24, 2023
pstorz
approved these changes
Aug 24, 2023
This is mostly to deprecate ANSI/IBM labels, and since deprecating them would make the Bareos label the only option, then just deprecating the whole config option is the way to go.
e897859 to
9b31f2c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds deprecates
LabelTypeandCheckLabels.We initially only wanted to deprecate ANSI/IBM labels, but since deprecating/removing them would make the Bareos label the default anyway, just removing the whole config option makes sense.
Please check
If you have any questions or problems, please give a comment in the PR.
Helpful documentation and best practices
Checklist for the reviewer of the PR (will be processed by the Bareos team)
Make sure you check/merge the PR using
devtools/pr-toolto have some simple automated checks run and a proper changelog record added.General
Source code quality