tarantool / tarantool/doc

[4pt] Add details about buffer and C API

Open
#1,669 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

"Добавить для версии 2.6 про то, что buffer - это такой же объект, который доступен в сишном API, как box_ibuf_t."

"надо указать, что объекты буфера можно передавать во все сишные функции в качестве box_ibuf_t. В сишном апи про box_ibuf_t тоже надо сказать, что у этого типа есть луа представление - buffer. Только я не вижу, где у нас документация про box_ibuf_t. Это вроде бы в 2.6 заехало, но не могу найти ни на сайте, ни в гитхабе тикет."

https://www.tarantool.io/ru/doc/latest/reference/reference_lua/buffer/

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 referenced buffer documentation page and search the documentation for the C API type box_ibuf_t. Clarify that buffer objects can be passed to C functions as box_ibuf_t and that box_ibuf_t has the Lua representation buffer; done when both sides of this relationship are documented for version 2.6.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, lua
Domain
api, documentation
Issue type
Documentation
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.