[v2] libxl: Fix comment for LIBXL_HAVE_VMTRACE_BUF_KB

Commit Message

Petr Beneš Feb. 13, 2024, 2:56 p.m. UTC

From: Petr Beneš <[e-mail]>

It's located in libxl_domain_build_info, not libxl_domain_create_info.

Signed-off-by: Petr Beneš <[e-mail]>
Acked-by: Anthony PERARD <[e-mail]>
---
 tools/include/libxl.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jan Beulich Feb. 13, 2024, 3:02 p.m. UTC | #1

On 13.02.2024 15:56, Petr Beneš wrote:
> From: Petr Beneš <[e-mail]>
> 
> It's located in libxl_domain_build_info, not libxl_domain_create_info.
> 
> Signed-off-by: Petr Beneš <[e-mail]>
> Acked-by: Anthony PERARD <[e-mail]>

Any reason you didn't also add the Fixes: tag that Anthony suggested
to put there (for me to recognize that this may need backporting;
didn't check yet when that earlier commit went in)?

Jan

Petr Beneš Feb. 13, 2024, 3:08 p.m. UTC | #2

> On Tue, Feb 13, 2024 at 4:02 PM Jan Beulich <[e-mail]> wrote:
>
> On 13.02.2024 15:56, Petr Beneš wrote:
> > From: Petr Beneš <[e-mail]>
> >
> > It's located in libxl_domain_build_info, not libxl_domain_create_info.
> >
> > Signed-off-by: Petr Beneš <[e-mail]>
> > Acked-by: Anthony PERARD <[e-mail]>
>
> Any reason you didn't also add the Fixes: tag that Anthony suggested
> to put there (for me to recognize that this may need backporting;
> didn't check yet when that earlier commit went in)?
>
> Jan

Apologies. No other reason that it's my first experience with creating
v2 patch and I honestly didn't know that the "Fixes: tag" suggestion
was directed at me. How should I proceed from here?

P.

Jan Beulich Feb. 13, 2024, 3:27 p.m. UTC | #3

On 13.02.2024 16:08, Petr Beneš wrote:
>> On Tue, Feb 13, 2024 at 4:02 PM Jan Beulich <[e-mail]> wrote:
>>
>> On 13.02.2024 15:56, Petr Beneš wrote:
>>> From: Petr Beneš <[e-mail]>
>>>
>>> It's located in libxl_domain_build_info, not libxl_domain_create_info.
>>>
>>> Signed-off-by: Petr Beneš <[e-mail]>
>>> Acked-by: Anthony PERARD <[e-mail]>
>>
>> Any reason you didn't also add the Fixes: tag that Anthony suggested
>> to put there (for me to recognize that this may need backporting;
>> didn't check yet when that earlier commit went in)?
> 
> Apologies. No other reason that it's my first experience with creating
> v2 patch and I honestly didn't know that the "Fixes: tag" suggestion
> was directed at me. How should I proceed from here?

I'll try to remember to insert it while committing.

Jan

Luca Fancellu Feb. 13, 2024, 3:36 p.m. UTC | #4

> On 13 Feb 2024, at 15:27, Jan Beulich <[e-mail]> wrote:
> 
> On 13.02.2024 16:08, Petr Beneš wrote:
>>> On Tue, Feb 13, 2024 at 4:02 PM Jan Beulich <[e-mail]> wrote:
>>> 
>>> On 13.02.2024 15:56, Petr Beneš wrote:
>>>> From: Petr Beneš <[e-mail]>
>>>> 
>>>> It's located in libxl_domain_build_info, not libxl_domain_create_info.
>>>> 
>>>> Signed-off-by: Petr Beneš <[e-mail]>
>>>> Acked-by: Anthony PERARD <[e-mail]>
>>> 
>>> Any reason you didn't also add the Fixes: tag that Anthony suggested
>>> to put there (for me to recognize that this may need backporting;
>>> didn't check yet when that earlier commit went in)?
>> 
>> Apologies. No other reason that it's my first experience with creating
>> v2 patch and I honestly didn't know that the "Fixes: tag" suggestion
>> was directed at me. How should I proceed from here?

Hi Petr,

In this case Jan will try to take care of that, if you are interested on how to do that,
the section ‘1.2 The commit message’ of https://xenbits.xen.org/docs/unstable/process/sending-patches.html
will explain how to setup git to have the correct configuration for the fixes tag, afterwards you can just:

1) take the SHA of the commit who introduced the issue:
    git blame -L<line num from>,<line num to> -- <path to the file>

2) Get the Fixes tag to be put in the commit message:
    git show --pretty=fixes <SHA>
    
    You will see as first line something along the line: “Fixes: 6e9ccda5e475 (“bla bla bla bla bla bla")"

There could be better git command to obtain the same thing, but I always use the above.

Cheers,
Luca

Patch

diff --git a/tools/include/libxl.h b/tools/include/libxl.h
index f1652b1664..46bc774126 100644
--- a/tools/include/libxl.h
+++ b/tools/include/libxl.h
@@ -519,7 +519,7 @@ 
 #define LIBXL_HAVE_PHYSINFO_CAP_VMTRACE 1
 
 /*
- * LIBXL_HAVE_VMTRACE_BUF_KB indicates that libxl_domain_create_info has a
+ * LIBXL_HAVE_VMTRACE_BUF_KB indicates that libxl_domain_build_info has a
  * vmtrace_buf_kb parameter, which allows to enable pre-allocation of
  * processor tracing buffers of given size.
  */