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

Add compat configuration options reference #4352

Merged
merged 7 commits into from
Jul 12, 2024
Merged

Conversation

p7nov
Copy link
Contributor

@p7nov p7nov commented Jul 9, 2024

Resolves #3937

Add documentation on the compat part of the configuration scheme:

Deployment: https://docs.d.tarantool.io/en/doc/gh-3937-config-compat/reference/configuration/configuration_reference/#compat

Note

Some compat options available in the config are not documented yet in the compat module reference. Need to cross-link their doc pages (when ready) with descriptions in the config reference.

@p7nov p7nov marked this pull request as draft July 9, 2024 11:13
@p7nov p7nov marked this pull request as ready for review July 10, 2024 07:38
@p7nov p7nov requested a review from ImeevMA July 10, 2024 07:50
@p7nov p7nov requested a review from andreyaksenov July 12, 2024 03:26
Copy link
Contributor

@andreyaksenov andreyaksenov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Several minor comments

doc/reference/configuration/configuration_reference.rst Outdated Show resolved Hide resolved
doc/reference/configuration/configuration_reference.rst Outdated Show resolved Hide resolved
doc/reference/configuration/configuration_reference.rst Outdated Show resolved Hide resolved
doc/reference/configuration/configuration_reference.rst Outdated Show resolved Hide resolved
doc/reference/configuration/configuration_reference.rst Outdated Show resolved Hide resolved

.. _configuration_reference_compat_error_unpack:

.. confval:: compat.box_error_unpack_type_and_code
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since 3.1.0.


.. _configuration_reference_compat_error_serialize:

.. confval:: compat.box_error_serialize_verbose
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this option first appeared in 3.1.0. Let's add Since here.

doc/reference/configuration/configuration_reference.rst Outdated Show resolved Hide resolved
p7nov and others added 3 commits July 12, 2024 14:53
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
@p7nov p7nov merged commit d841ea7 into latest Jul 12, 2024
1 check passed
@p7nov p7nov deleted the gh-3937-config-compat branch July 12, 2024 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

config: compat options
3 participants