Merge pull request #1521

config: deprecate `LabelType` and `CheckLabels`
bareos · Aug 24, 2023 · 0fa0d94 · 0fa0d94
2 parents 4acf3b1 + 9b31f2c
commit 0fa0d94
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -92,6 +92,7 @@ and since Bareos version 20 this project adheres to [Semantic Versioning](https:
 - stored: automatically increment tape block size in case the buffer is too small [PR #1496]
 - ua_restore: change restore argument handling [PR #1516]
 - plugin-fd: allow fd plugins to (re-)set since-time and disable/re-enable timestamp/accurate checks [PR #1505]
+- config: deprecate `LabelType` and `CheckLabels` [PR #1521]
 
 ### Removed
 - remove no longer used pkglists [PR #1335]
@@ -234,6 +235,7 @@ and since Bareos version 20 this project adheres to [Semantic Versioning](https:
 [PR #1512]: https://github.com/bareos/bareos/pull/1512
 [PR #1516]: https://github.com/bareos/bareos/pull/1516
 [PR #1520]: https://github.com/bareos/bareos/pull/1520
+[PR #1521]: https://github.com/bareos/bareos/pull/1521
 [PR #1522]: https://github.com/bareos/bareos/pull/1522
 [PR #1524]: https://github.com/bareos/bareos/pull/1524
 [unreleased]: https://github.com/bareos/bareos/tree/master
diff --git a/core/src/dird/dird_conf.cc b/core/src/dird/dird_conf.cc
@@ -454,7 +454,7 @@ static ResourceItem pool_items[] = {
   { "Description", CFG_TYPE_STR, ITEM(res_pool, description_), 0, 0, NULL, NULL, NULL },
   { "PoolType", CFG_TYPE_POOLTYPE, ITEM(res_pool, pool_type), 0, CFG_ITEM_DEFAULT, "Backup", NULL, NULL },
   { "LabelFormat", CFG_TYPE_STRNAME, ITEM(res_pool, label_format), 0, 0, NULL, NULL, NULL },
-  { "LabelType", CFG_TYPE_LABEL, ITEM(res_pool, LabelType), 0, 0, NULL, NULL, NULL },
+  { "LabelType", CFG_TYPE_LABEL, ITEM(res_pool, LabelType), 0, CFG_ITEM_DEPRECATED, NULL, NULL, NULL },
   { "CleaningPrefix", CFG_TYPE_STRNAME, ITEM(res_pool, cleaning_prefix), 0, CFG_ITEM_DEFAULT, "CLN", NULL, NULL },
   { "UseCatalog", CFG_TYPE_BOOL, ITEM(res_pool, use_catalog), 0, CFG_ITEM_DEFAULT, "true", NULL, NULL },
   { "PurgeOldestVolume", CFG_TYPE_BOOL, ITEM(res_pool, purge_oldest_volume), 0, CFG_ITEM_DEFAULT, "false", NULL, NULL },

diff --git a/core/src/stored/stored_conf.cc b/core/src/stored/stored_conf.cc
@@ -168,7 +168,7 @@ static ResourceItem dev_items[] = {
   {"CloseOnPoll", CFG_TYPE_BIT, ITEM(res_dev, cap_bits), CAP_CLOSEONPOLL, CFG_ITEM_DEFAULT, "off", NULL, NULL},
   {"BlockPositioning", CFG_TYPE_BIT, ITEM(res_dev, cap_bits), CAP_POSITIONBLOCKS, CFG_ITEM_DEFAULT, "on", NULL, NULL},
   {"UseMtiocget", CFG_TYPE_BIT, ITEM(res_dev, cap_bits), CAP_MTIOCGET, CFG_ITEM_DEFAULT, "on", NULL, NULL},
-  {"CheckLabels", CFG_TYPE_BIT, ITEM(res_dev, cap_bits), CAP_CHECKLABELS, CFG_ITEM_DEFAULT, "off", NULL, NULL},
+  {"CheckLabels", CFG_TYPE_BIT, ITEM(res_dev, cap_bits), CAP_CHECKLABELS, CFG_ITEM_DEPRECATED | CFG_ITEM_DEFAULT, "off", NULL, NULL},
   {"RequiresMount", CFG_TYPE_BIT, ITEM(res_dev, cap_bits), CAP_REQMOUNT, CFG_ITEM_DEFAULT, "off", NULL, NULL},
   {"OfflineOnUnmount", CFG_TYPE_BIT, ITEM(res_dev, cap_bits), CAP_OFFLINEUNMOUNT, CFG_ITEM_DEFAULT, "off", NULL, NULL},
   {"BlockChecksum", CFG_TYPE_BIT, ITEM(res_dev, cap_bits), CAP_BLOCKCHECKSUM, CFG_ITEM_DEFAULT, "on", NULL, NULL},
@@ -200,7 +200,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, NULL, NULL},
   {"NoRewindOnClose", CFG_TYPE_BOOL, ITEM(res_dev, norewindonclose), 0, CFG_ITEM_DEFAULT, "true", NULL, NULL},
   {"DriveTapeAlertEnabled", CFG_TYPE_BOOL, ITEM(res_dev, drive_tapealert_enabled), 0, 0, NULL, NULL, NULL},
   {"DriveCryptoEnabled", CFG_TYPE_BOOL, ITEM(res_dev, drive_crypto_enabled), 0, 0, NULL, NULL, NULL},

diff --git a/docs/manuals/source/Appendix/Troubleshooting.rst b/docs/manuals/source/Appendix/Troubleshooting.rst
@@ -160,6 +160,12 @@ Below is a super stripped down |dir| configuration showing you the four places w
 Tape Labels: ANSI or IBM
 ------------------------
 
+.. warning::
+
+   ANSI/IBM labels have been deprecated as of Bareos 23.
+   Support will be removed in the future.
+
+
 .. index::
    single: Label; Tape Labels
    single: Tape; Label; ANSI

diff --git a/docs/manuals/source/include/autogenerated/bareos-dir-config-schema.json b/docs/manuals/source/include/autogenerated/bareos-dir-config-schema.json
@@ -2013,6 +2013,7 @@
         "LabelType": {
           "datatype": "LABEL",
           "code": 0,
+          "deprecated": true,
           "equals": true
         },
         "CleaningPrefix": {

diff --git a/docs/manuals/source/include/autogenerated/bareos-sd-config-schema.json b/docs/manuals/source/include/autogenerated/bareos-sd-config-schema.json
@@ -622,6 +622,7 @@
           "datatype": "BIT",
           "code": 22,
           "default_value": "off",
+          "deprecated": true,
           "equals": true
         },
         "RequiresMount": {
@@ -777,6 +778,7 @@
         "LabelType": {
           "datatype": "LABEL",
           "code": 0,
+          "deprecated": true,
           "equals": true
         },
         "NoRewindOnClose": {