* [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories
@ 2017-06-06 15:01 Paolo Bonzini
2017-06-06 15:08 ` Daniel P. Berrange
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Paolo Bonzini @ 2017-06-06 15:01 UTC (permalink / raw)
To: qemu-devel; +Cc: stefanha, thuth, peter.maydell, berrange
Developer documentation should be its own manual. As a start, move all
developer-oriented files to a separate directory.
Also move non-text files to their own directories: docs/config/ for
QEMU -readconfig input, and docs/spin/ for formal models to be used
with the SPIN model checker.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
docs/{ => config}/ich9-ehci-uhci.cfg | 0
docs/{ => config}/mach-virt-graphical.cfg | 0
docs/{ => config}/mach-virt-serial.cfg | 0
docs/{ => config}/q35-emulated.cfg | 0
docs/{ => config}/q35-virtio-graphical.cfg | 0
docs/{ => config}/q35-virtio-serial.cfg | 0
docs/{ => devel}/atomics.txt | 0
docs/{ => devel}/bitmaps.md | 0
docs/{ => devel}/blkdebug.txt | 0
docs/{ => devel}/blkverify.txt | 0
docs/{ => devel}/build-system.txt | 0
docs/{ => devel}/lockcnt.txt | 0
docs/{ => devel}/memory.txt | 0
docs/{ => devel}/migration.txt | 0
docs/{ => devel}/multi-thread-tcg.txt | 0
docs/{ => devel}/multiple-iothreads.txt | 0
docs/{ => devel}/qapi-code-gen.txt | 0
docs/{ => devel}/rcu.txt | 0
docs/{ => devel}/tracing.txt | 0
docs/{ => devel}/virtio-migration.txt | 0
docs/{ => devel}/writing-qmp-commands.txt | 0
docs/{ => spin}/aio_notify.promela | 0
docs/{ => spin}/aio_notify_accept.promela | 0
docs/{ => spin}/aio_notify_bug.promela | 0
docs/{ => spin}/tcg-exclusive.promela | 0
docs/{ => spin}/win32-qemu-event.promela | 0
26 files changed, 0 insertions(+), 0 deletions(-)
rename docs/{ => config}/ich9-ehci-uhci.cfg (100%)
rename docs/{ => config}/mach-virt-graphical.cfg (100%)
rename docs/{ => config}/mach-virt-serial.cfg (100%)
rename docs/{ => config}/q35-emulated.cfg (100%)
rename docs/{ => config}/q35-virtio-graphical.cfg (100%)
rename docs/{ => config}/q35-virtio-serial.cfg (100%)
rename docs/{ => devel}/atomics.txt (100%)
rename docs/{ => devel}/bitmaps.md (100%)
rename docs/{ => devel}/blkdebug.txt (100%)
rename docs/{ => devel}/blkverify.txt (100%)
rename docs/{ => devel}/build-system.txt (100%)
rename docs/{ => devel}/lockcnt.txt (100%)
rename docs/{ => devel}/memory.txt (100%)
rename docs/{ => devel}/migration.txt (100%)
rename docs/{ => devel}/multi-thread-tcg.txt (100%)
rename docs/{ => devel}/multiple-iothreads.txt (100%)
rename docs/{ => devel}/qapi-code-gen.txt (100%)
rename docs/{ => devel}/rcu.txt (100%)
rename docs/{ => devel}/tracing.txt (100%)
rename docs/{ => devel}/virtio-migration.txt (100%)
rename docs/{ => devel}/writing-qmp-commands.txt (100%)
rename docs/{ => spin}/aio_notify.promela (100%)
rename docs/{ => spin}/aio_notify_accept.promela (100%)
rename docs/{ => spin}/aio_notify_bug.promela (100%)
rename docs/{ => spin}/tcg-exclusive.promela (100%)
rename docs/{ => spin}/win32-qemu-event.promela (100%)
diff --git a/docs/ich9-ehci-uhci.cfg b/docs/config/ich9-ehci-uhci.cfg
similarity index 100%
rename from docs/ich9-ehci-uhci.cfg
rename to docs/config/ich9-ehci-uhci.cfg
diff --git a/docs/mach-virt-graphical.cfg b/docs/config/mach-virt-graphical.cfg
similarity index 100%
rename from docs/mach-virt-graphical.cfg
rename to docs/config/mach-virt-graphical.cfg
diff --git a/docs/mach-virt-serial.cfg b/docs/config/mach-virt-serial.cfg
similarity index 100%
rename from docs/mach-virt-serial.cfg
rename to docs/config/mach-virt-serial.cfg
diff --git a/docs/q35-emulated.cfg b/docs/config/q35-emulated.cfg
similarity index 100%
rename from docs/q35-emulated.cfg
rename to docs/config/q35-emulated.cfg
diff --git a/docs/q35-virtio-graphical.cfg b/docs/config/q35-virtio-graphical.cfg
similarity index 100%
rename from docs/q35-virtio-graphical.cfg
rename to docs/config/q35-virtio-graphical.cfg
diff --git a/docs/q35-virtio-serial.cfg b/docs/config/q35-virtio-serial.cfg
similarity index 100%
rename from docs/q35-virtio-serial.cfg
rename to docs/config/q35-virtio-serial.cfg
diff --git a/docs/atomics.txt b/docs/devel/atomics.txt
similarity index 100%
rename from docs/atomics.txt
rename to docs/devel/atomics.txt
diff --git a/docs/bitmaps.md b/docs/devel/bitmaps.md
similarity index 100%
rename from docs/bitmaps.md
rename to docs/devel/bitmaps.md
diff --git a/docs/blkdebug.txt b/docs/devel/blkdebug.txt
similarity index 100%
rename from docs/blkdebug.txt
rename to docs/devel/blkdebug.txt
diff --git a/docs/blkverify.txt b/docs/devel/blkverify.txt
similarity index 100%
rename from docs/blkverify.txt
rename to docs/devel/blkverify.txt
diff --git a/docs/build-system.txt b/docs/devel/build-system.txt
similarity index 100%
rename from docs/build-system.txt
rename to docs/devel/build-system.txt
diff --git a/docs/lockcnt.txt b/docs/devel/lockcnt.txt
similarity index 100%
rename from docs/lockcnt.txt
rename to docs/devel/lockcnt.txt
diff --git a/docs/memory.txt b/docs/devel/memory.txt
similarity index 100%
rename from docs/memory.txt
rename to docs/devel/memory.txt
diff --git a/docs/migration.txt b/docs/devel/migration.txt
similarity index 100%
rename from docs/migration.txt
rename to docs/devel/migration.txt
diff --git a/docs/multi-thread-tcg.txt b/docs/devel/multi-thread-tcg.txt
similarity index 100%
rename from docs/multi-thread-tcg.txt
rename to docs/devel/multi-thread-tcg.txt
diff --git a/docs/multiple-iothreads.txt b/docs/devel/multiple-iothreads.txt
similarity index 100%
rename from docs/multiple-iothreads.txt
rename to docs/devel/multiple-iothreads.txt
diff --git a/docs/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
similarity index 100%
rename from docs/qapi-code-gen.txt
rename to docs/devel/qapi-code-gen.txt
diff --git a/docs/rcu.txt b/docs/devel/rcu.txt
similarity index 100%
rename from docs/rcu.txt
rename to docs/devel/rcu.txt
diff --git a/docs/tracing.txt b/docs/devel/tracing.txt
similarity index 100%
rename from docs/tracing.txt
rename to docs/devel/tracing.txt
diff --git a/docs/virtio-migration.txt b/docs/devel/virtio-migration.txt
similarity index 100%
rename from docs/virtio-migration.txt
rename to docs/devel/virtio-migration.txt
diff --git a/docs/writing-qmp-commands.txt b/docs/devel/writing-qmp-commands.txt
similarity index 100%
rename from docs/writing-qmp-commands.txt
rename to docs/devel/writing-qmp-commands.txt
diff --git a/docs/aio_notify.promela b/docs/spin/aio_notify.promela
similarity index 100%
rename from docs/aio_notify.promela
rename to docs/spin/aio_notify.promela
diff --git a/docs/aio_notify_accept.promela b/docs/spin/aio_notify_accept.promela
similarity index 100%
rename from docs/aio_notify_accept.promela
rename to docs/spin/aio_notify_accept.promela
diff --git a/docs/aio_notify_bug.promela b/docs/spin/aio_notify_bug.promela
similarity index 100%
rename from docs/aio_notify_bug.promela
rename to docs/spin/aio_notify_bug.promela
diff --git a/docs/tcg-exclusive.promela b/docs/spin/tcg-exclusive.promela
similarity index 100%
rename from docs/tcg-exclusive.promela
rename to docs/spin/tcg-exclusive.promela
diff --git a/docs/win32-qemu-event.promela b/docs/spin/win32-qemu-event.promela
similarity index 100%
rename from docs/win32-qemu-event.promela
rename to docs/spin/win32-qemu-event.promela
--
2.13.0
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories
2017-06-06 15:01 [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories Paolo Bonzini
@ 2017-06-06 15:08 ` Daniel P. Berrange
2017-06-06 15:26 ` Thomas Huth
2017-06-06 15:34 ` Philippe Mathieu-Daudé
2 siblings, 0 replies; 5+ messages in thread
From: Daniel P. Berrange @ 2017-06-06 15:08 UTC (permalink / raw)
To: Paolo Bonzini; +Cc: qemu-devel, stefanha, thuth, peter.maydell
On Tue, Jun 06, 2017 at 05:01:15PM +0200, Paolo Bonzini wrote:
> Developer documentation should be its own manual. As a start, move all
> developer-oriented files to a separate directory.
>
> Also move non-text files to their own directories: docs/config/ for
> QEMU -readconfig input, and docs/spin/ for formal models to be used
> with the SPIN model checker.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
> docs/{ => config}/ich9-ehci-uhci.cfg | 0
> docs/{ => config}/mach-virt-graphical.cfg | 0
> docs/{ => config}/mach-virt-serial.cfg | 0
> docs/{ => config}/q35-emulated.cfg | 0
> docs/{ => config}/q35-virtio-graphical.cfg | 0
> docs/{ => config}/q35-virtio-serial.cfg | 0
> docs/{ => devel}/atomics.txt | 0
> docs/{ => devel}/bitmaps.md | 0
> docs/{ => devel}/blkdebug.txt | 0
> docs/{ => devel}/blkverify.txt | 0
> docs/{ => devel}/build-system.txt | 0
> docs/{ => devel}/lockcnt.txt | 0
> docs/{ => devel}/memory.txt | 0
> docs/{ => devel}/migration.txt | 0
> docs/{ => devel}/multi-thread-tcg.txt | 0
> docs/{ => devel}/multiple-iothreads.txt | 0
> docs/{ => devel}/qapi-code-gen.txt | 0
> docs/{ => devel}/rcu.txt | 0
> docs/{ => devel}/tracing.txt | 0
> docs/{ => devel}/virtio-migration.txt | 0
> docs/{ => devel}/writing-qmp-commands.txt | 0
> docs/{ => spin}/aio_notify.promela | 0
> docs/{ => spin}/aio_notify_accept.promela | 0
> docs/{ => spin}/aio_notify_bug.promela | 0
> docs/{ => spin}/tcg-exclusive.promela | 0
> docs/{ => spin}/win32-qemu-event.promela | 0
> 26 files changed, 0 insertions(+), 0 deletions(-)
> rename docs/{ => config}/ich9-ehci-uhci.cfg (100%)
> rename docs/{ => config}/mach-virt-graphical.cfg (100%)
> rename docs/{ => config}/mach-virt-serial.cfg (100%)
> rename docs/{ => config}/q35-emulated.cfg (100%)
> rename docs/{ => config}/q35-virtio-graphical.cfg (100%)
> rename docs/{ => config}/q35-virtio-serial.cfg (100%)
> rename docs/{ => devel}/atomics.txt (100%)
> rename docs/{ => devel}/bitmaps.md (100%)
> rename docs/{ => devel}/blkdebug.txt (100%)
> rename docs/{ => devel}/blkverify.txt (100%)
> rename docs/{ => devel}/build-system.txt (100%)
> rename docs/{ => devel}/lockcnt.txt (100%)
> rename docs/{ => devel}/memory.txt (100%)
> rename docs/{ => devel}/migration.txt (100%)
> rename docs/{ => devel}/multi-thread-tcg.txt (100%)
> rename docs/{ => devel}/multiple-iothreads.txt (100%)
> rename docs/{ => devel}/qapi-code-gen.txt (100%)
> rename docs/{ => devel}/rcu.txt (100%)
> rename docs/{ => devel}/tracing.txt (100%)
> rename docs/{ => devel}/virtio-migration.txt (100%)
> rename docs/{ => devel}/writing-qmp-commands.txt (100%)
> rename docs/{ => spin}/aio_notify.promela (100%)
> rename docs/{ => spin}/aio_notify_accept.promela (100%)
> rename docs/{ => spin}/aio_notify_bug.promela (100%)
> rename docs/{ => spin}/tcg-exclusive.promela (100%)
> rename docs/{ => spin}/win32-qemu-event.promela (100%)
Reviewed-by: Daniel P. Berrange <berrange@redhat.com>
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories
2017-06-06 15:01 [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories Paolo Bonzini
2017-06-06 15:08 ` Daniel P. Berrange
@ 2017-06-06 15:26 ` Thomas Huth
2017-06-06 15:34 ` Philippe Mathieu-Daudé
2 siblings, 0 replies; 5+ messages in thread
From: Thomas Huth @ 2017-06-06 15:26 UTC (permalink / raw)
To: Paolo Bonzini, qemu-devel; +Cc: stefanha, peter.maydell, berrange
On 06.06.2017 17:01, Paolo Bonzini wrote:
> Developer documentation should be its own manual. As a start, move all
> developer-oriented files to a separate directory.
>
> Also move non-text files to their own directories: docs/config/ for
> QEMU -readconfig input, and docs/spin/ for formal models to be used
> with the SPIN model checker.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
> docs/{ => config}/ich9-ehci-uhci.cfg | 0
> docs/{ => config}/mach-virt-graphical.cfg | 0
> docs/{ => config}/mach-virt-serial.cfg | 0
> docs/{ => config}/q35-emulated.cfg | 0
> docs/{ => config}/q35-virtio-graphical.cfg | 0
> docs/{ => config}/q35-virtio-serial.cfg | 0
> docs/{ => devel}/atomics.txt | 0
> docs/{ => devel}/bitmaps.md | 0
> docs/{ => devel}/blkdebug.txt | 0
> docs/{ => devel}/blkverify.txt | 0
> docs/{ => devel}/build-system.txt | 0
> docs/{ => devel}/lockcnt.txt | 0
> docs/{ => devel}/memory.txt | 0
> docs/{ => devel}/migration.txt | 0
> docs/{ => devel}/multi-thread-tcg.txt | 0
> docs/{ => devel}/multiple-iothreads.txt | 0
> docs/{ => devel}/qapi-code-gen.txt | 0
> docs/{ => devel}/rcu.txt | 0
> docs/{ => devel}/tracing.txt | 0
> docs/{ => devel}/virtio-migration.txt | 0
> docs/{ => devel}/writing-qmp-commands.txt | 0
> docs/{ => spin}/aio_notify.promela | 0
> docs/{ => spin}/aio_notify_accept.promela | 0
> docs/{ => spin}/aio_notify_bug.promela | 0
> docs/{ => spin}/tcg-exclusive.promela | 0
> docs/{ => spin}/win32-qemu-event.promela | 0
> 26 files changed, 0 insertions(+), 0 deletions(-)
Reviewed-by: Thomas Huth <thuth@redhat.com>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories
2017-06-06 15:01 [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories Paolo Bonzini
2017-06-06 15:08 ` Daniel P. Berrange
2017-06-06 15:26 ` Thomas Huth
@ 2017-06-06 15:34 ` Philippe Mathieu-Daudé
2017-06-06 16:10 ` Paolo Bonzini
2 siblings, 1 reply; 5+ messages in thread
From: Philippe Mathieu-Daudé @ 2017-06-06 15:34 UTC (permalink / raw)
To: Paolo Bonzini, qemu-devel; +Cc: peter.maydell, thuth, stefanha
Very good idea!
On 06/06/2017 12:01 PM, Paolo Bonzini wrote:
> Developer documentation should be its own manual. As a start, move all
> developer-oriented files to a separate directory.
>
> Also move non-text files to their own directories: docs/config/ for
> QEMU -readconfig input, and docs/spin/ for formal models to be used
> with the SPIN model checker.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
> ---
> docs/{ => config}/ich9-ehci-uhci.cfg | 0
> docs/{ => config}/mach-virt-graphical.cfg | 0
> docs/{ => config}/mach-virt-serial.cfg | 0
> docs/{ => config}/q35-emulated.cfg | 0
> docs/{ => config}/q35-virtio-graphical.cfg | 0
> docs/{ => config}/q35-virtio-serial.cfg | 0
> docs/{ => devel}/atomics.txt | 0
> docs/{ => devel}/bitmaps.md | 0
> docs/{ => devel}/blkdebug.txt | 0
> docs/{ => devel}/blkverify.txt | 0
> docs/{ => devel}/build-system.txt | 0
> docs/{ => devel}/lockcnt.txt | 0
> docs/{ => devel}/memory.txt | 0
> docs/{ => devel}/migration.txt | 0
> docs/{ => devel}/multi-thread-tcg.txt | 0
> docs/{ => devel}/multiple-iothreads.txt | 0
> docs/{ => devel}/qapi-code-gen.txt | 0
> docs/{ => devel}/rcu.txt | 0
> docs/{ => devel}/tracing.txt | 0
> docs/{ => devel}/virtio-migration.txt | 0
> docs/{ => devel}/writing-qmp-commands.txt | 0
> docs/{ => spin}/aio_notify.promela | 0
> docs/{ => spin}/aio_notify_accept.promela | 0
> docs/{ => spin}/aio_notify_bug.promela | 0
> docs/{ => spin}/tcg-exclusive.promela | 0
> docs/{ => spin}/win32-qemu-event.promela | 0
> 26 files changed, 0 insertions(+), 0 deletions(-)
> rename docs/{ => config}/ich9-ehci-uhci.cfg (100%)
> rename docs/{ => config}/mach-virt-graphical.cfg (100%)
> rename docs/{ => config}/mach-virt-serial.cfg (100%)
> rename docs/{ => config}/q35-emulated.cfg (100%)
> rename docs/{ => config}/q35-virtio-graphical.cfg (100%)
> rename docs/{ => config}/q35-virtio-serial.cfg (100%)
> rename docs/{ => devel}/atomics.txt (100%)
> rename docs/{ => devel}/bitmaps.md (100%)
> rename docs/{ => devel}/blkdebug.txt (100%)
> rename docs/{ => devel}/blkverify.txt (100%)
> rename docs/{ => devel}/build-system.txt (100%)
> rename docs/{ => devel}/lockcnt.txt (100%)
> rename docs/{ => devel}/memory.txt (100%)
> rename docs/{ => devel}/migration.txt (100%)
> rename docs/{ => devel}/multi-thread-tcg.txt (100%)
> rename docs/{ => devel}/multiple-iothreads.txt (100%)
> rename docs/{ => devel}/qapi-code-gen.txt (100%)
> rename docs/{ => devel}/rcu.txt (100%)
> rename docs/{ => devel}/tracing.txt (100%)
> rename docs/{ => devel}/virtio-migration.txt (100%)
> rename docs/{ => devel}/writing-qmp-commands.txt (100%)
> rename docs/{ => spin}/aio_notify.promela (100%)
> rename docs/{ => spin}/aio_notify_accept.promela (100%)
> rename docs/{ => spin}/aio_notify_bug.promela (100%)
> rename docs/{ => spin}/tcg-exclusive.promela (100%)
> rename docs/{ => spin}/win32-qemu-event.promela (100%)
>
> diff --git a/docs/ich9-ehci-uhci.cfg b/docs/config/ich9-ehci-uhci.cfg
> similarity index 100%
> rename from docs/ich9-ehci-uhci.cfg
> rename to docs/config/ich9-ehci-uhci.cfg
> diff --git a/docs/mach-virt-graphical.cfg b/docs/config/mach-virt-graphical.cfg
> similarity index 100%
> rename from docs/mach-virt-graphical.cfg
> rename to docs/config/mach-virt-graphical.cfg
> diff --git a/docs/mach-virt-serial.cfg b/docs/config/mach-virt-serial.cfg
> similarity index 100%
> rename from docs/mach-virt-serial.cfg
> rename to docs/config/mach-virt-serial.cfg
> diff --git a/docs/q35-emulated.cfg b/docs/config/q35-emulated.cfg
> similarity index 100%
> rename from docs/q35-emulated.cfg
> rename to docs/config/q35-emulated.cfg
> diff --git a/docs/q35-virtio-graphical.cfg b/docs/config/q35-virtio-graphical.cfg
> similarity index 100%
> rename from docs/q35-virtio-graphical.cfg
> rename to docs/config/q35-virtio-graphical.cfg
> diff --git a/docs/q35-virtio-serial.cfg b/docs/config/q35-virtio-serial.cfg
> similarity index 100%
> rename from docs/q35-virtio-serial.cfg
> rename to docs/config/q35-virtio-serial.cfg
> diff --git a/docs/atomics.txt b/docs/devel/atomics.txt
> similarity index 100%
> rename from docs/atomics.txt
> rename to docs/devel/atomics.txt
> diff --git a/docs/bitmaps.md b/docs/devel/bitmaps.md
> similarity index 100%
> rename from docs/bitmaps.md
> rename to docs/devel/bitmaps.md
> diff --git a/docs/blkdebug.txt b/docs/devel/blkdebug.txt
> similarity index 100%
> rename from docs/blkdebug.txt
> rename to docs/devel/blkdebug.txt
> diff --git a/docs/blkverify.txt b/docs/devel/blkverify.txt
> similarity index 100%
> rename from docs/blkverify.txt
> rename to docs/devel/blkverify.txt
> diff --git a/docs/build-system.txt b/docs/devel/build-system.txt
> similarity index 100%
> rename from docs/build-system.txt
> rename to docs/devel/build-system.txt
> diff --git a/docs/lockcnt.txt b/docs/devel/lockcnt.txt
> similarity index 100%
> rename from docs/lockcnt.txt
> rename to docs/devel/lockcnt.txt
> diff --git a/docs/memory.txt b/docs/devel/memory.txt
> similarity index 100%
> rename from docs/memory.txt
> rename to docs/devel/memory.txt
> diff --git a/docs/migration.txt b/docs/devel/migration.txt
> similarity index 100%
> rename from docs/migration.txt
> rename to docs/devel/migration.txt
> diff --git a/docs/multi-thread-tcg.txt b/docs/devel/multi-thread-tcg.txt
> similarity index 100%
> rename from docs/multi-thread-tcg.txt
> rename to docs/devel/multi-thread-tcg.txt
> diff --git a/docs/multiple-iothreads.txt b/docs/devel/multiple-iothreads.txt
> similarity index 100%
> rename from docs/multiple-iothreads.txt
> rename to docs/devel/multiple-iothreads.txt
> diff --git a/docs/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
> similarity index 100%
> rename from docs/qapi-code-gen.txt
> rename to docs/devel/qapi-code-gen.txt
> diff --git a/docs/rcu.txt b/docs/devel/rcu.txt
> similarity index 100%
> rename from docs/rcu.txt
> rename to docs/devel/rcu.txt
> diff --git a/docs/tracing.txt b/docs/devel/tracing.txt
> similarity index 100%
> rename from docs/tracing.txt
> rename to docs/devel/tracing.txt
> diff --git a/docs/virtio-migration.txt b/docs/devel/virtio-migration.txt
> similarity index 100%
> rename from docs/virtio-migration.txt
> rename to docs/devel/virtio-migration.txt
> diff --git a/docs/writing-qmp-commands.txt b/docs/devel/writing-qmp-commands.txt
> similarity index 100%
> rename from docs/writing-qmp-commands.txt
> rename to docs/devel/writing-qmp-commands.txt
> diff --git a/docs/aio_notify.promela b/docs/spin/aio_notify.promela
> similarity index 100%
> rename from docs/aio_notify.promela
> rename to docs/spin/aio_notify.promela
> diff --git a/docs/aio_notify_accept.promela b/docs/spin/aio_notify_accept.promela
> similarity index 100%
> rename from docs/aio_notify_accept.promela
> rename to docs/spin/aio_notify_accept.promela
> diff --git a/docs/aio_notify_bug.promela b/docs/spin/aio_notify_bug.promela
> similarity index 100%
> rename from docs/aio_notify_bug.promela
> rename to docs/spin/aio_notify_bug.promela
> diff --git a/docs/tcg-exclusive.promela b/docs/spin/tcg-exclusive.promela
> similarity index 100%
> rename from docs/tcg-exclusive.promela
> rename to docs/spin/tcg-exclusive.promela
> diff --git a/docs/win32-qemu-event.promela b/docs/spin/win32-qemu-event.promela
> similarity index 100%
> rename from docs/win32-qemu-event.promela
> rename to docs/spin/win32-qemu-event.promela
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories
2017-06-06 15:34 ` Philippe Mathieu-Daudé
@ 2017-06-06 16:10 ` Paolo Bonzini
0 siblings, 0 replies; 5+ messages in thread
From: Paolo Bonzini @ 2017-06-06 16:10 UTC (permalink / raw)
To: Philippe Mathieu-Daudé, qemu-devel; +Cc: peter.maydell, thuth, stefanha
On 06/06/2017 17:34, Philippe Mathieu-Daudé wrote:
> Very good idea!
You may be interested in some of the projects listed at
http://wiki.qemu.org/Features/Documentation.
In particular:
* annotate developer documentation in docs/ with the corresponding C
source code, so as to prioritize where to add doc comments
* move tcg/README to docs/devel
* move user mode emulation to a separate manual (the "features" section
probably should be in both the user-mode and full-system emulator manuals
* split qemu-doc.texi into various .texi files in docs/ (to be included
with @include)
Thanks,
Paolo
> On 06/06/2017 12:01 PM, Paolo Bonzini wrote:
>> Developer documentation should be its own manual. As a start, move all
>> developer-oriented files to a separate directory.
>>
>> Also move non-text files to their own directories: docs/config/ for
>> QEMU -readconfig input, and docs/spin/ for formal models to be used
>> with the SPIN model checker.
>>
>> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
>
> Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
>
>> ---
>> docs/{ => config}/ich9-ehci-uhci.cfg | 0
>> docs/{ => config}/mach-virt-graphical.cfg | 0
>> docs/{ => config}/mach-virt-serial.cfg | 0
>> docs/{ => config}/q35-emulated.cfg | 0
>> docs/{ => config}/q35-virtio-graphical.cfg | 0
>> docs/{ => config}/q35-virtio-serial.cfg | 0
>> docs/{ => devel}/atomics.txt | 0
>> docs/{ => devel}/bitmaps.md | 0
>> docs/{ => devel}/blkdebug.txt | 0
>> docs/{ => devel}/blkverify.txt | 0
>> docs/{ => devel}/build-system.txt | 0
>> docs/{ => devel}/lockcnt.txt | 0
>> docs/{ => devel}/memory.txt | 0
>> docs/{ => devel}/migration.txt | 0
>> docs/{ => devel}/multi-thread-tcg.txt | 0
>> docs/{ => devel}/multiple-iothreads.txt | 0
>> docs/{ => devel}/qapi-code-gen.txt | 0
>> docs/{ => devel}/rcu.txt | 0
>> docs/{ => devel}/tracing.txt | 0
>> docs/{ => devel}/virtio-migration.txt | 0
>> docs/{ => devel}/writing-qmp-commands.txt | 0
>> docs/{ => spin}/aio_notify.promela | 0
>> docs/{ => spin}/aio_notify_accept.promela | 0
>> docs/{ => spin}/aio_notify_bug.promela | 0
>> docs/{ => spin}/tcg-exclusive.promela | 0
>> docs/{ => spin}/win32-qemu-event.promela | 0
>> 26 files changed, 0 insertions(+), 0 deletions(-)
>> rename docs/{ => config}/ich9-ehci-uhci.cfg (100%)
>> rename docs/{ => config}/mach-virt-graphical.cfg (100%)
>> rename docs/{ => config}/mach-virt-serial.cfg (100%)
>> rename docs/{ => config}/q35-emulated.cfg (100%)
>> rename docs/{ => config}/q35-virtio-graphical.cfg (100%)
>> rename docs/{ => config}/q35-virtio-serial.cfg (100%)
>> rename docs/{ => devel}/atomics.txt (100%)
>> rename docs/{ => devel}/bitmaps.md (100%)
>> rename docs/{ => devel}/blkdebug.txt (100%)
>> rename docs/{ => devel}/blkverify.txt (100%)
>> rename docs/{ => devel}/build-system.txt (100%)
>> rename docs/{ => devel}/lockcnt.txt (100%)
>> rename docs/{ => devel}/memory.txt (100%)
>> rename docs/{ => devel}/migration.txt (100%)
>> rename docs/{ => devel}/multi-thread-tcg.txt (100%)
>> rename docs/{ => devel}/multiple-iothreads.txt (100%)
>> rename docs/{ => devel}/qapi-code-gen.txt (100%)
>> rename docs/{ => devel}/rcu.txt (100%)
>> rename docs/{ => devel}/tracing.txt (100%)
>> rename docs/{ => devel}/virtio-migration.txt (100%)
>> rename docs/{ => devel}/writing-qmp-commands.txt (100%)
>> rename docs/{ => spin}/aio_notify.promela (100%)
>> rename docs/{ => spin}/aio_notify_accept.promela (100%)
>> rename docs/{ => spin}/aio_notify_bug.promela (100%)
>> rename docs/{ => spin}/tcg-exclusive.promela (100%)
>> rename docs/{ => spin}/win32-qemu-event.promela (100%)
>>
>> diff --git a/docs/ich9-ehci-uhci.cfg b/docs/config/ich9-ehci-uhci.cfg
>> similarity index 100%
>> rename from docs/ich9-ehci-uhci.cfg
>> rename to docs/config/ich9-ehci-uhci.cfg
>> diff --git a/docs/mach-virt-graphical.cfg
>> b/docs/config/mach-virt-graphical.cfg
>> similarity index 100%
>> rename from docs/mach-virt-graphical.cfg
>> rename to docs/config/mach-virt-graphical.cfg
>> diff --git a/docs/mach-virt-serial.cfg b/docs/config/mach-virt-serial.cfg
>> similarity index 100%
>> rename from docs/mach-virt-serial.cfg
>> rename to docs/config/mach-virt-serial.cfg
>> diff --git a/docs/q35-emulated.cfg b/docs/config/q35-emulated.cfg
>> similarity index 100%
>> rename from docs/q35-emulated.cfg
>> rename to docs/config/q35-emulated.cfg
>> diff --git a/docs/q35-virtio-graphical.cfg
>> b/docs/config/q35-virtio-graphical.cfg
>> similarity index 100%
>> rename from docs/q35-virtio-graphical.cfg
>> rename to docs/config/q35-virtio-graphical.cfg
>> diff --git a/docs/q35-virtio-serial.cfg
>> b/docs/config/q35-virtio-serial.cfg
>> similarity index 100%
>> rename from docs/q35-virtio-serial.cfg
>> rename to docs/config/q35-virtio-serial.cfg
>> diff --git a/docs/atomics.txt b/docs/devel/atomics.txt
>> similarity index 100%
>> rename from docs/atomics.txt
>> rename to docs/devel/atomics.txt
>> diff --git a/docs/bitmaps.md b/docs/devel/bitmaps.md
>> similarity index 100%
>> rename from docs/bitmaps.md
>> rename to docs/devel/bitmaps.md
>> diff --git a/docs/blkdebug.txt b/docs/devel/blkdebug.txt
>> similarity index 100%
>> rename from docs/blkdebug.txt
>> rename to docs/devel/blkdebug.txt
>> diff --git a/docs/blkverify.txt b/docs/devel/blkverify.txt
>> similarity index 100%
>> rename from docs/blkverify.txt
>> rename to docs/devel/blkverify.txt
>> diff --git a/docs/build-system.txt b/docs/devel/build-system.txt
>> similarity index 100%
>> rename from docs/build-system.txt
>> rename to docs/devel/build-system.txt
>> diff --git a/docs/lockcnt.txt b/docs/devel/lockcnt.txt
>> similarity index 100%
>> rename from docs/lockcnt.txt
>> rename to docs/devel/lockcnt.txt
>> diff --git a/docs/memory.txt b/docs/devel/memory.txt
>> similarity index 100%
>> rename from docs/memory.txt
>> rename to docs/devel/memory.txt
>> diff --git a/docs/migration.txt b/docs/devel/migration.txt
>> similarity index 100%
>> rename from docs/migration.txt
>> rename to docs/devel/migration.txt
>> diff --git a/docs/multi-thread-tcg.txt b/docs/devel/multi-thread-tcg.txt
>> similarity index 100%
>> rename from docs/multi-thread-tcg.txt
>> rename to docs/devel/multi-thread-tcg.txt
>> diff --git a/docs/multiple-iothreads.txt
>> b/docs/devel/multiple-iothreads.txt
>> similarity index 100%
>> rename from docs/multiple-iothreads.txt
>> rename to docs/devel/multiple-iothreads.txt
>> diff --git a/docs/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
>> similarity index 100%
>> rename from docs/qapi-code-gen.txt
>> rename to docs/devel/qapi-code-gen.txt
>> diff --git a/docs/rcu.txt b/docs/devel/rcu.txt
>> similarity index 100%
>> rename from docs/rcu.txt
>> rename to docs/devel/rcu.txt
>> diff --git a/docs/tracing.txt b/docs/devel/tracing.txt
>> similarity index 100%
>> rename from docs/tracing.txt
>> rename to docs/devel/tracing.txt
>> diff --git a/docs/virtio-migration.txt b/docs/devel/virtio-migration.txt
>> similarity index 100%
>> rename from docs/virtio-migration.txt
>> rename to docs/devel/virtio-migration.txt
>> diff --git a/docs/writing-qmp-commands.txt
>> b/docs/devel/writing-qmp-commands.txt
>> similarity index 100%
>> rename from docs/writing-qmp-commands.txt
>> rename to docs/devel/writing-qmp-commands.txt
>> diff --git a/docs/aio_notify.promela b/docs/spin/aio_notify.promela
>> similarity index 100%
>> rename from docs/aio_notify.promela
>> rename to docs/spin/aio_notify.promela
>> diff --git a/docs/aio_notify_accept.promela
>> b/docs/spin/aio_notify_accept.promela
>> similarity index 100%
>> rename from docs/aio_notify_accept.promela
>> rename to docs/spin/aio_notify_accept.promela
>> diff --git a/docs/aio_notify_bug.promela
>> b/docs/spin/aio_notify_bug.promela
>> similarity index 100%
>> rename from docs/aio_notify_bug.promela
>> rename to docs/spin/aio_notify_bug.promela
>> diff --git a/docs/tcg-exclusive.promela b/docs/spin/tcg-exclusive.promela
>> similarity index 100%
>> rename from docs/tcg-exclusive.promela
>> rename to docs/spin/tcg-exclusive.promela
>> diff --git a/docs/win32-qemu-event.promela
>> b/docs/spin/win32-qemu-event.promela
>> similarity index 100%
>> rename from docs/win32-qemu-event.promela
>> rename to docs/spin/win32-qemu-event.promela
>>
>
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2017-06-06 16:10 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-06-06 15:01 [Qemu-devel] [PATCH] docs: create config/, devel/ and spin/ subdirectories Paolo Bonzini
2017-06-06 15:08 ` Daniel P. Berrange
2017-06-06 15:26 ` Thomas Huth
2017-06-06 15:34 ` Philippe Mathieu-Daudé
2017-06-06 16:10 ` Paolo Bonzini
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).