tarantool / tarantool/doc

feedback: Submodule box.cfg | Tarantool

Open
#3,219 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Product: Tarantool
Root document: https://www.tarantool.io/en/doc/latest/reference/configuration/#configuration-parameters
SME: @ Totktonada

Details

<…>

|Submodule box.cfg
|The
box.cfg submodule is used for specifying
server configuratio<…>

https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_cfg/

For some box.cfg options it is important in which order they are set. For example, setting 'replication', including self, before 'listen' makes no sense - box.cfg{replication = {'localhost:3301'}, listen = 3301} Replication won't be able to connect to a not being listened port. In the table below for each option can be set a number. An option is set before all other options having a bigger number. Options without a number are installed after others in an undefined order. The table works for reconfiguration only. Order of first configuration is hardcoded in C and can't be changed.

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 root configuration page and the box.cfg reference linked in the issue. Review the explanation of option-setting order and its table, then update the documentation so the reconfiguration ordering rules and limitations are clear and complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.