tarantool / tarantool/doc

Add the "env" option to config:get()

Open Beginner friendly
#5,644 0 comments 0 reactions 0 assignees View on GitHub

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 env option controls the usage of TT_* environment variables
    in config:get().
  • By default, environment variables are taken into account when the
    instance option is not specified.
  • If env is set to false, environment variables are ignored even
    when the instance option is not specified.
  • If env is set to true together with the instance option, an
    error is raised.
    Requested by @mandesero in https://github.com/tarantool/tarantool/commit/5f1f5af08f8c29147515bea54f878be9feffef4f.

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 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.