tests: Document how to add new replies files

[libvirt] [PATCH] tests: Document how to add new replies files

Andrea Bolognani posted 1 patch 5 years, 8 months ago

Download mbox

Test syntax-check passed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20190313132924.7957-1-abologna@redhat.com

tests/qemucapabilitiestest.c | 8 ++++++++
1 file changed, 8 insertions(+)

Expand all Fold all

[libvirt] [PATCH] tests: Document how to add new replies files

Posted by Andrea Bolognani 5 years, 8 months ago

We already document how to generate them, so might as well
go the extra mile and document the remaining steps.

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
---
 tests/qemucapabilitiestest.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/tests/qemucapabilitiestest.c b/tests/qemucapabilitiestest.c
index 16c2832ffb..4c9b7c5322 100644
--- a/tests/qemucapabilitiestest.c
+++ b/tests/qemucapabilitiestest.c
@@ -230,6 +230,14 @@ mymain(void)
      *
      * If you manually edit replies files you can run
      * "tests/qemucapsfixreplies foo.replies" to fix the replies ids.
+     *
+     * Once a replies file has been generated and tweaked if necessary,
+     * you can drop it into tests/qemucapabilitiesdata/ (with a sensible
+     * name - look at what's already there for inspiration) and test
+     * programs will automatically pick it up.
+     *
+     * To generate the corresponding output files after a new replies
+     * file has been added, run "VIR_TEST_REGENERATE_OUTPUT=1 make check".
      */
 
     testQemuDataReset(&data);
-- 
2.20.1

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] tests: Document how to add new replies files

Posted by Michal Privoznik 5 years, 8 months ago

On 3/13/19 2:29 PM, Andrea Bolognani wrote:
> We already document how to generate them, so might as well
> go the extra mile and document the remaining steps.
> 
> Signed-off-by: Andrea Bolognani <abologna@redhat.com>
> ---
>   tests/qemucapabilitiestest.c | 8 ++++++++
>   1 file changed, 8 insertions(+)

ACK

Michal

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list