[2pt] Document luajit-gdb.py
Nobody has claimed this yet.
- 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-archdumps values of LJ_64 and LJ_GC64 macro definitionslj-tvdumps the type and GCobj info related to the given TValuelj-strdumps the contents of the given GCstrlj-tabdumps the contents of the given GCtablj-stackdumps Lua stack of the given lua_Statelj-stateshows current VM, GC and JIT stateslj-gcshows 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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