tarantool / tarantool/doc

[2pt] Document luajit-gdb.py

Open
#1,982 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The luajit-gdb.py isn't mentioned in doc. That's no good.

SME: @igormunkin

[@veod32]:
Introduced in release 2.4.1.
Summary from the release notes (LuaJIT section):

Introduce luajit-gdb.py extension with commands for inspecting LuaJIT internals. The extension obliges one to provide gdbinfo for libluajit, otherwise loading fails. The extension provides the following commands:

  • lj-arch dumps values of LJ_64 and LJ_GC64 macro definitions
  • lj-tv dumps the type and GCobj info related to the given TValue
  • lj-str dumps the contents of the given GCstr
  • lj-tab dumps the contents of the given GCtab
  • lj-stack dumps Lua stack of the given lua_State
  • lj-state shows current VM, GC and JIT states
  • lj-gc shows current GC stats

More details in this cover letter

ToDo

  • The luajit-gdb.py script can be mentioned in some documentation section related to LuaJIT -- research where.
  • As for the script usage, there is an internal help that can be started from GDB (GNU Debugger). The help contains all the necessary info for developers, and there is no need to duplicate this in the Tarantool documentation.

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 by reviewing src/luajit-gdb.py and the LuaJIT section of the documentation to find an appropriate place for the reference. Use the release notes and linked cover letter for context, then add a mention of the script and its purpose without duplicating its internal GDB help. Done means the documentation points developers to luajit-gdb.py and explains what it provides.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.