libretro / vice-libretro

Versatile Commodore 8-bit Emulator
GNU General Public License v2.0
40 stars 70 forks source link

[Doc,Monitor] data_type isn't defined anywhere #351

Closed Michaelangel007 closed 3 years ago

Michaelangel007 commented 3 years ago

In section 12.3 Memory Commands of the manual the following monitor commands are listed:

mem [<data_type>] [<address_opt_range>]
m   [<data_type>] [<address_opt_range>]

memchar [<data_type>] [<address_opt_range>]
mc      [<data_type>] [<address_opt_range>]

memsprite [<data_type>] [<address_opt_range>]
ms        [<data_type>] [<address_opt_range>]

The problem is that <data_type> is only listed in these 6 locations and not actually defined anywhere else.

The command memmapsave lists <format> and defines it as (0 = BMP, etc.), but the commands with <data_type> don't clarify this optional argument. I would have also expected it to be listed in Section 12.1 Terminology but alas it is not.

Can a user specify byte, int16, int32, float32 output? Or does this refer to hex, binary, decimal, octal output type? How does a user even know what the valid options are in the first place without resorting to looking at the implementation ?

Without examples, which sadly there aren't any, a user is left guessing in the dark what <data_type> refers to.

Also, shouldn't the manual call this <radix_type> to match the usage of t_radixtype and of the command ?

sonninnos commented 3 years ago

Hmm, this does not really concern this repo, since it has nothing to do with official VICE devs and documents, and also because monitor is removed from the core due to keeping the size smaller.

It can be pretty easily put back, but it still can't be used without adding some core options and hotkeys for triggering it.

Michaelangel007 commented 3 years ago

Thanks for the feedback. I'll log the bug upstream.