tarantool / tarantool/doc

Deprecate wal_cleanup_delay

Open
#4,479 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.3 reference wal
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Dev. issue: https://github.com/tarantool/tarantool/issues/10154

Product: Tarantool
Since: 3.3.0
Root document:

SME: @ drewdzzz

Details

Connected with #4478, #4670

The option wal_cleanup_delay is deprecated starting from Tarantool 3.3.0.
The new compat module option wal_cleanup_delay_deprecation was
introduced to control whether the option is still available.
With the old behavior, which is the default in Tarantool 3.3.0,
the option is still available and has the same default value, but a
deprecation warning is logged when it is set manually. With the new
behavior, an error is raised on any attempt to set this option, but its
default value isn't actually changed.

(Please create https://tarantool.io/compat/wal_cleanup_delay_deprecation)

We are planning to switch the compat option to the new behavior
starting from Tarantool 4.0 with the ability to revert to the
old behavior. Starting from Tarantool 5.0 we are planning to
drop wal_cleanup_delay completely - the behavior will be the same
as when this option is set to zero.
Requested by @drewdzzz in https://github.com/tarantool/tarantool/commit/9eb397499372224d7b847ea86a7fa79972f898da.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the persistence and configuration reference documents listed as the root documents, then review the existing configuration documentation for wal_cleanup_delay. Document its deprecation, the wal_cleanup_delay_deprecation compatibility option, and the planned behavior described in the issue. Done means the affected references and the requested compatibility-option page are present and consistent with the stated version behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.