Add the "env" option to config:get()
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Since: 3.7.0
The new option allows controlling whether TT_* environment variables
are taken into account when retrieving configuration values.
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/config/#lua-function.config.get
- The
envoption controls the usage ofTT_*environment variables
inconfig:get(). - By default, environment variables are taken into account when the
instanceoption is not specified. - If
envis set tofalse, environment variables are ignored even
when theinstanceoption is not specified. - If
envis set totruetogether with theinstanceoption, an
error is raised.
Requested by @mandesero in https://github.com/tarantool/tarantool/commit/5f1f5af08f8c29147515bea54f878be9feffef4f.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the config:get() section at the linked root document and locate the documentation source for that page. Document the env option, its default behavior, how false disables TT_* variables, and that true with instance raises an error; done when the page reflects all listed rules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100