Skip to content

[3pt] Update description of the Tarantool start options #2021

@veod32

Description

@veod32

Update description of the Tarantool start options

Product: Tarantool
Since: all versions
Audience/target: all Tarantool users
Root document: https://www.tarantool.io/en/doc/latest/reference/configuration/#command-options
SME: any Core team developer
Peer reviewer:

Details

Description of the Tarantool start options is incomplete: only -h and -V are mentioned but there're much more.

What needs to be done:

  • Describe all the Tarantool start options. Use tarantool -h command to see the full list.
  • Mention the possibility fixed in Assertion at -l -e options tarantool#4775 — specifying an option and its value concatenated is possible: -lvalue, -evalue.
  • Reference this doc section from the Getting Started manual . Currently, in GS it's only described the "plain" Tarantool start without mentioning the options.
  • (Optional) Think of another place in the documentation to move this content to: it's not the obvious place to search for such type of information.

Definition of done

  • All the Tarantool start options are described in the documentation.
  • In Getting started chapter, there's a reference to the description of the Tarantool start options.

Metadata

Metadata

Assignees

Labels

add details[nature] More details needed, some info missing. Documentation is incomplete.server[area] Task relates to Tarantool's server (core) functionality

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions