summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/debugger/annotation.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/debugger/annotation.rst')
-rw-r--r--docs/source/debugger/annotation.rst103
1 files changed, 103 insertions, 0 deletions
diff --git a/docs/source/debugger/annotation.rst b/docs/source/debugger/annotation.rst
new file mode 100644
index 00000000000..6ada5497000
--- /dev/null
+++ b/docs/source/debugger/annotation.rst
@@ -0,0 +1,103 @@
+.. _debugger-annotation-list:
+
+Code Annotation Debugger Commands
+=================================
+
+
+You can also type **help <command>** for further details on each command in the MAME Debugger interface.
+
+| :ref:`debugger-command-comadd` -- adds a comment to the disassembled code at given address
+| :ref:`debugger-command-comdelete` -- removes a comment from the given address
+| :ref:`debugger-command-comsave` -- save the current comments to a file
+| :ref:`debugger-command-comlist` -- print currently available comments from file
+| :ref:`debugger-command-commit` -- gives a bulk comadd then comsave command
+
+
+ .. _debugger-command-comadd:
+
+Comadd
+------
+
+| **comadd[//] <address>,<comment>**
+|
+| Adds a string <comment> to the disassembled code at <address>. The shortcut for this command is simply '//'
+|
+| Examples:
+|
+| comadd 0, hello world.
+|
+| Adds the comment 'hello world.' to the code at address 0x0
+|
+| // 10, undocumented opcode!
+|
+| Adds the comment 'undocumented opcode!' to the code at address 0x10
+
+
+ .. _debugger-command-comdelete:
+
+Comdelete
+---------
+
+| **comdelete**
+|
+| Deletes the comment at the specified memory offset. The comment which is deleted is in the currently active memory bank.
+|
+| Examples:
+|
+| comdelete 10
+|
+| Deletes the comment at code address 0x10 (using the current memory bank settings)
+
+
+ .. _debugger-command-comsave:
+
+Comsave
+-------
+
+| **comsave**
+|
+| Saves the working comments to the driver's XML comment file.
+|
+| Examples:
+|
+| comsave
+|
+| Saves the comments to the driver's comment file
+
+
+ .. _debugger-command-comlist:
+
+Comlist
+-------
+
+| **comlist**
+|
+| Prints the currently available comment file in human readable form in debugger output window.
+|
+| Examples:
+|
+| comlist
+|
+| Shows currently available comments.
+
+
+ .. _debugger-command-commit:
+
+Commit
+------
+
+| **commit[/*] <address>,<comment>**
+|
+| Adds a string <comment> to the disassembled code at <address> then saves to file. Basically same as comadd + comsave via a single line.
+| The shortcut for this command is simply \'\/\*\'
+|
+| Examples:
+|
+| commit 0, hello world.
+|
+| Adds the comment 'hello world.' to the code at address 0x0
+|
+| /* 10, undocumented opcode!
+|
+| Adds the comment 'undocumented opcode!' to the code at address 0x10
+