tarantool / tarantool/doc

clean up LuaJIT exported functions

Open
#3,575 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Related dev. issue(s): https://github.com/tarantool/tarantool/issues/3680

Product: Tarantool
Since: 3.0
Audience/target: developers
Root document: n/a
SME: @ igormunkin

Details

The list of the LuaJIT-related functions being exported (i.e. public)
from Tarantool should be updated. The actual list of the exported
symbols can be found within changeset (either extra/exports file or
related Lua test chunk).
Requested by @ igormunkin in https://github.com/tarantool/tarantool/commit/0c53d22b583fe233b13bdd161cd744dcbb2774dd.

Looks like there are no doc changes are required regarding this issue as we don't have a list of the LuaJIT functions in docs.

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

Inspect the extra/exports file and the related Lua test chunk mentioned in the issue, using commit 0c53d22b583fe233b13bdd161cd744dcbb2774dd and issue #3680 for context. Compare the current LuaJIT exported-symbol list with the requested cleanup; done means the export list is updated and relevant tests pass, with no documentation changes expected.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
build-system
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.