qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things without worrying about compatibility. Naming is a mess. The code calls the device driver CirMemCharDriver, the public API calls it "memory", "memchardev", or "memchar", and the special commands are named like "memchar-FOO". "memory" is a particularly unfortunate choice, because there's another character device driver called MemoryDriver. Moreover, the device's distinctive property is that it's a ring buffer, not that's in memory. Therefore: * Rename CirMemCharDriver to RingBufCharDriver, and call the thing a "ringbuf" in the API. * Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO. * Rename device parameter from maxcapacity to size (simple words are good for you). * Clearly mark the parameter as optional in documentation. * Fix error reporting so that chardev-add reports to current monitor, not stderr. * Replace cirmem in C identifiers by ringbuf. * Rework documentation. Document the impact of our crappy UTF-8 handling on reading. * QMP examples that even work. I could split this up into multiple commits, but they'd change the same documentation lines multiple times. Not worth it. Signed-off-by:Markus Armbruster <armbru@redhat.com> Reviewed-by:
Eric Blake <eblake@redhat.com> Signed-off-by:
Anthony Liguori <aliguori@us.ibm.com>
Showing
- hmp-commands.hx 17 additions, 20 deletionshmp-commands.hx
- hmp.c 4 additions, 4 deletionshmp.c
- hmp.h 2 additions, 2 deletionshmp.h
- qapi-schema.json 29 additions, 18 deletionsqapi-schema.json
- qemu-char.c 36 additions, 29 deletionsqemu-char.c
- qemu-options.hx 5 additions, 8 deletionsqemu-options.hx
- qmp-commands.hx 29 additions, 26 deletionsqmp-commands.hx
Loading
Please register or sign in to comment