Skip to content

Added documentation for the fill command in debugger #380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
indigodarkwolf merged 1 commit into from
Mar 6, 2026
+1 −0
Merged

Added documentation for the fill command in debugger #380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,7 @@ The debugger uses its own command line with the following syntax:
|d %x|Change the code panel to view disassembly starting from the address %x.|
|m %x|Change the data panel to view memory starting from the address %x.|
|v %x|Display VERA RAM (VRAM) starting from address %x.|
|f %x %v [%n]|Fill memory address %x with value %v, optionally for %n number of bytes. In banked memory, the bank currently being displayed in the data panel is used, otherwise bank 0
Copy link
Copy Markdown
Contributor

@stople stople Feb 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

There is also an additional, optional "incr/step" parameter, specifying how much the address should increment between each consecutive write. Default is 1, as for the N number of bytes.

By the way, is there a reason for using " " instead of " " here?

Copy link
Copy Markdown
Contributor Author

@JimmyDansbo JimmyDansbo Feb 6, 2026

Choose a reason for hiding this comment

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

I is to ensure it does not create a linebreak

Copy link
Copy Markdown
Contributor

@stople stople Feb 6, 2026

Choose a reason for hiding this comment

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

Working with HTML, I have seen the code   used before (without properly understanding its purpose until reading up on the topic now). It makes perfect sense to add a nbsp character, although the source code may become less readable.

I am not sure what is used elsewhere in the documentation (if it is used at all). But, could the code   instead of   perhaps give the reader of the source code some better insight what this is, compared to a magic number?

At least now I know this is intentional, and that it serves a particular purpose. Always nice to learn something new!

Copy link
Copy Markdown
Contributor

@indigodarkwolf indigodarkwolf Mar 6, 2026

Choose a reason for hiding this comment

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

I don't know that we have a standard here, and I don't have strong feelings going either way, so I'm inclined to approve this as-is. If someone with a vested interest wants to hold a conversation or contradict me, feel free to do so. Heck, I'll even volunteer to swap the characters here myself, if necessary.

|b %s %d|Changes the current memory bank for disassembly and data. The %s param can be either 'ram' or 'rom', the %d is the memory bank to display (but see NOTE below!).|
|r %s %x|Changes the value in the specified register. Valid registers in the %s param are 'pc', 'a', 'b', 'c', 'd', 'k', 'dbr', 'x', 'y', and 'sp'. %x is the value to store in that register.|

Expand Down
Loading