tarantool / doc

Tarantool documentation
https://www.tarantool.io/en/doc/
Other
15 stars 43 forks source link

module api: new region, ibuf, key_def, tuple, Lua/C APIs #1611

Open Totktonada opened 4 years ago

Totktonada commented 4 years ago

We have added the bunch of new APIs in order to implement the new tuple-keydef and tuple-merger external modules. It would be good to document the new C structures and functions.

The relevant descriptions may be found in API comments in the header files, see the patchset. It was land to master (future 2.6.1), 2.5 (future 2.5.2), 2.4 (future 2.4.3) and 1.10 (future 1.10.8). Aside of the linked changes luaL_iscallable() was [backported]() to 1.10.

The work was done in the scope of the following issues:

https://github.com/tarantool/tarantool/issues/5273 https://github.com/tarantool/tarantool/issues/5384

BTW, is not it worth to generate the C API documentation from the Doxygen comments in the generated src/module.h? However first we should investigate the difference in the current state of the Doxygen comments and the RST docs.

NickVolynkin commented 3 years ago

BTW, is not it worth to generate the C API documentation from the Doxygen comments in the generated src/module.h?

Yes. We should autogenerate this documentation.

Totktonada commented 3 years ago

Yes. We should autogenerate this documentation.

Is there a related issue?

Totktonada commented 2 years ago

The box region is officially fiber local: https://github.com/tarantool/tarantool/pull/6874.