tarantool / tarantool/doc

Document tarantool.build.linking

Open
#2,710 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2.10 example feature reference server
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: ecosystem
Since: 2.10
Audience/target: developers
Root document:
https://www.tarantool.io/en/doc/latest/reference/reference_lua/tarantool/
SME: @ locker

Update the example and explain what dynamic and static linking means (clues: 1, 2).


It shows linking type (dynamic or static):

tarantool> require('tarantool').build.linking
---
- dynamic
...

Please update the tarantool module documentation:

https://www.tarantool.io/en/doc/latest/reference/reference_lua/tarantool/
Requested by @locker in https://github.com/tarantool/tarantool/commit/d3893c530209f937538c7f545b4b5743478b0f0c.

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 tarantool module reference at https://www.tarantool.io/en/doc/latest/reference/reference_lua/tarantool/ and locate the tarantool.build.linking entry and its example. Update the example and explain the difference between dynamic and static linking, using the linked references for background; done means the documented value and explanation are accurate and clear.

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
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.