Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation Feature Request] Define Minimum Version for Configuration Parameters #2100

Open
tomswartz07 opened this issue Jun 21, 2023 · 1 comment

Comments

@tomswartz07
Copy link

Given the subtle changes in additional config parameters as each version is released, it may be extremely useful to define the version at which each parameter was introduced.

As an example:

S3 support has been present for a long time, but only recently (v2.38) was S3 KMS support added: https://pgbackrest.org/release.html#2.38

Documenting the 'minimum supported version' in the configuration sections would help to make this much more obvious:
Using the above example, this section https://pgbackrest.org/configuration.html#section-repository/option-repo-s3-kms-key-id would include a Minimum Version: 2.38 section

@dwsteele dwsteele self-assigned this Jul 7, 2023
@dwsteele
Copy link
Member

dwsteele commented Jul 7, 2023

This definitely seems like a good idea. There are two thing that will make it a bit tricky:

  1. Sometimes the option is not new but just one of the values, e.g. repo-type=gcs.

  2. It's not clear how we would handle deprecated options. For instance, pg1-path is only valid since 2.00, but the deprecated equivalent db-path has been around since 1.00 and db1-path since 1.06. We could just ignore versions before 2.00 but the same thing has been going on since 2.00 as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants