tarantool / tarantool/doc

Command-line option `-d` for console debugger

Open Beginner friendly
#3,349 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2.11 debugger feature
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/7456

Product: Tarantool
Since: 2.11
Root document: console debugger docs (TBD in #3195)
SME: @ tsafin @ igormunkin

Details

-d target.lua in the tarantool console activates the console debugger on the specified file.

$ tarantool -d debug-target.lua
Tarantool debugger 2.11.0-entrypoint-852-g9e6ed28ae
type 'help' for interactive help
luadebug: Loaded for 2.11.0-entrypoint-852-g9e6ed28ae
break via debug-target.lua => debug-target.lua:1 in chunk at debug-target.lua:0
   1 => local date = require 'datetime'
   4
luadebug>

Please see third_party/lua/README-luadebug.md for a full description of different ways to activate debugging shell.
Requested by @tsafin in https://github.com/tarantool/tarantool/commit/a984fc0d530bcdd425899b8be5557acc13f38f4f.

Definition of done

  • the -d option is documented

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 third_party/lua/README-luadebug.md and the console debugger documentation referenced in the issue. Check how the -d target.lua activation is described, then document this option in the appropriate console debugger docs. Done means the -d option and its target-file behavior are documented.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.