ianmcook commented on code in PR #3393: URL: https://github.com/apache/arrow-adbc/pull/3393#discussion_r2324072846
########## docs/source/format/driver_manifests.rst: ########## @@ -239,6 +241,12 @@ a string (single path) or a table of platform-specific paths. The ``Driver.shar needed to successfully load a driver manifest. The other keys are optional, but provide useful metadata about the driver. +The ``manifest_version`` key is currently not required, but if present, it must be set to 1. Driver +manager implementations must error upon reading a manifest with ``manifest_version`` higher than 1. +This is to prevent undefined behavior if breaking changes are made to the manifest format in the future. +In the future, manifests that use a manifest version higher than 1 will be required to include the +``manifest_version`` key. + Review Comment: I shortened and simplified the explanation in `driver_manifests.rst` but made the explanation in `versioning.rst` slightly longer and more pedantic. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
