Skip to content

[#8] debug entry point with the command line#14

Merged
lavocatt merged 1 commit into
arkmq-org:mainfrom
lavocatt:feature/debug
Sep 29, 2025
Merged

[#8] debug entry point with the command line#14
lavocatt merged 1 commit into
arkmq-org:mainfrom
lavocatt:feature/debug

Conversation

@lavocatt

Copy link
Copy Markdown
Member

The idea is that a user can use -D to enter debug at a specific point. A completion script can be installed on the system, and will help the user know the correct parameter for -D. -s works now the same as -D.

@brusdev brusdev left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Debugging the tutorial without changing the sources is a nice improvement and the completion feature is great (it would deserve its own PR)

Comment thread README.md Outdated
-i, --interactive Prompt to press enter between each chunk
-s, --start-from string Start from a specific stage name
-s, --start-from string Start from a specific stage (stage or file@stage)
-D, --debug-from string Start debugging from a specific stage or chunk (stage, stage/chunkID, or file@stage/chunkID)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The debug option is often used to increase the verbosity of the log. Another alternative could be --break-at

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes this makes a lot of sense, I'll update the name of the option to --break-at and -B

@lavocatt

Copy link
Copy Markdown
Member Author

@brusdev I've extracted the autocompletion feature in #15

The -D flag allows users to start debugging from:
- A specific stage: -D stage2
- A specific chunk by ID: -D stage2/myChunkID
- A specific chunk by index: -D stage2/0
- A specific file when running directories: -D myfile@stage2/chunk

This enhances the existing -s flag by adding chunk-level granularity
and enables targeted debugging workflows.
@lavocatt lavocatt merged commit 70b9cc4 into arkmq-org:main Sep 29, 2025
2 checks passed
@brusdev

brusdev commented Sep 30, 2025

Copy link
Copy Markdown
Member

I have just figured out that the commit message points to -D option.

@lavocatt

Copy link
Copy Markdown
Member Author

Ah yes, an inattentive mistake. That happens sometimes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants