[PATCH] docs: add precision about capstone for execlog plugin

Alexandre Iooss posted 1 patch 6 months, 1 week ago
docs/devel/tcg-plugins.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
[PATCH] docs: add precision about capstone for execlog plugin
Posted by Alexandre Iooss 6 months, 1 week ago
Some people are wondering why they get an empty string as disassembly.
Most of the time, they configured QEMU without Capstone support.
Let's document this behaviour to help users.

Signed-off-by: Alexandre Iooss <erdnaxe@crans.org>
---
 docs/devel/tcg-plugins.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst
index 9cc09d8c3d..f7d7b9e3a4 100644
--- a/docs/devel/tcg-plugins.rst
+++ b/docs/devel/tcg-plugins.rst
@@ -539,7 +539,9 @@ which will output an execution trace following this structure::
   0, 0xd34, 0xf9c8f000, "bl #0x10c8"
   0, 0x10c8, 0xfff96c43, "ldr r3, [r0, #0x44]", load, 0x200000e4, RAM
 
-the output can be filtered to only track certain instructions or
+Please note that you need to configure QEMU with Capstone support to get disassembly.
+
+The output can be filtered to only track certain instructions or
 addresses using the ``ifilter`` or ``afilter`` options. You can stack the
 arguments if required::
 
-- 
2.30.2
Re: [PATCH] docs: add precision about capstone for execlog plugin
Posted by Pierrick Bouvier 6 months, 1 week ago
On 6/20/24 06:57, Alexandre Iooss wrote:
> Some people are wondering why they get an empty string as disassembly.
> Most of the time, they configured QEMU without Capstone support.
> Let's document this behaviour to help users.
> 
> Signed-off-by: Alexandre Iooss <erdnaxe@crans.org>
> ---
>   docs/devel/tcg-plugins.rst | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst
> index 9cc09d8c3d..f7d7b9e3a4 100644
> --- a/docs/devel/tcg-plugins.rst
> +++ b/docs/devel/tcg-plugins.rst
> @@ -539,7 +539,9 @@ which will output an execution trace following this structure::
>     0, 0xd34, 0xf9c8f000, "bl #0x10c8"
>     0, 0x10c8, 0xfff96c43, "ldr r3, [r0, #0x44]", load, 0x200000e4, RAM
>   
> -the output can be filtered to only track certain instructions or
> +Please note that you need to configure QEMU with Capstone support to get disassembly.
> +
> +The output can be filtered to only track certain instructions or
>   addresses using the ``ifilter`` or ``afilter`` options. You can stack the
>   arguments if required::
>   

Reviewed-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>