[PATCH 1/2] docs: Clarify hypervisor support for nwfilter profiles

Jim Fehlig via Devel posted 2 patches 1 year, 5 months ago
[PATCH 1/2] docs: Clarify hypervisor support for nwfilter profiles
Posted by Jim Fehlig via Devel 1 year, 5 months ago
Enhance the 'since' annotation of <filterref> documentation to note
it's only supported by the QEMU, LXC, and ch hypervisor drivers.

Signed-off-by: Jim Fehlig <jfehlig@suse.com>
---
 docs/formatdomain.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 47d3e2125e..8e8a9660fc 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6205,10 +6205,10 @@ hypervisor tries to reconnect.
 Traffic filtering with NWFilter
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-:since:`Since 0.8.0` an ``nwfilter`` profile can be assigned to a domain
-interface, which allows configuring traffic filter rules for the virtual
-machine. See the `nwfilter <formatnwfilter.html>`__ documentation for more
-complete details.
+:since:`Since 0.8.0 (QEMU), 0.9.3 (LXC), 10.1.0 (Cloud Hypervisor)` an ``nwfilter``
+profile can be assigned to a domain interface, which allows configuring traffic
+filter rules for the virtual machine. See the `nwfilter <formatnwfilter.html>`__
+documentation for more complete details.
 
 ::
 
-- 
2.35.3
Re: [PATCH 1/2] docs: Clarify hypervisor support for nwfilter profiles
Posted by Demi Marie Obenour 1 year, 5 months ago
On Wed, Sep 11, 2024 at 03:02:41PM -0600, Jim Fehlig wrote:
> Enhance the 'since' annotation of <filterref> documentation to note
> it's only supported by the QEMU, LXC, and ch hypervisor drivers.
> 
> Signed-off-by: Jim Fehlig <jfehlig@suse.com>
> ---
>  docs/formatdomain.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
> index 47d3e2125e..8e8a9660fc 100644
> --- a/docs/formatdomain.rst
> +++ b/docs/formatdomain.rst
> @@ -6205,10 +6205,10 @@ hypervisor tries to reconnect.
>  Traffic filtering with NWFilter
>  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>  
> -:since:`Since 0.8.0` an ``nwfilter`` profile can be assigned to a domain
> -interface, which allows configuring traffic filter rules for the virtual
> -machine. See the `nwfilter <formatnwfilter.html>`__ documentation for more
> -complete details.
> +:since:`Since 0.8.0 (QEMU), 0.9.3 (LXC), 10.1.0 (Cloud Hypervisor)` an ``nwfilter``
> +profile can be assigned to a domain interface, which allows configuring traffic
> +filter rules for the virtual machine. See the `nwfilter <formatnwfilter.html>`__
> +documentation for more complete details.
>  
>  ::
>  
> -- 
> 2.35.3

Should this have a

Suggested-by: Demi Marie Obenour <demi@invisiblethingslab.com>

tag?

In any case:

Acked-by: Demi Marie Obenour <demi@invisiblethingslab.com>
-- 
Sincerely,
Demi Marie Obenour (she/her/hers)
Invisible Things Lab
Re: [PATCH 1/2] docs: Clarify hypervisor support for nwfilter profiles
Posted by Jim Fehlig via Devel 1 year, 5 months ago
On 9/11/24 15:54, Demi Marie Obenour wrote:
> On Wed, Sep 11, 2024 at 03:02:41PM -0600, Jim Fehlig wrote:
>> Enhance the 'since' annotation of <filterref> documentation to note
>> it's only supported by the QEMU, LXC, and ch hypervisor drivers.
>>
>> Signed-off-by: Jim Fehlig <jfehlig@suse.com>
>> ---
>>   docs/formatdomain.rst | 8 ++++----
>>   1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
>> index 47d3e2125e..8e8a9660fc 100644
>> --- a/docs/formatdomain.rst
>> +++ b/docs/formatdomain.rst
>> @@ -6205,10 +6205,10 @@ hypervisor tries to reconnect.
>>   Traffic filtering with NWFilter
>>   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>>   
>> -:since:`Since 0.8.0` an ``nwfilter`` profile can be assigned to a domain
>> -interface, which allows configuring traffic filter rules for the virtual
>> -machine. See the `nwfilter <formatnwfilter.html>`__ documentation for more
>> -complete details.
>> +:since:`Since 0.8.0 (QEMU), 0.9.3 (LXC), 10.1.0 (Cloud Hypervisor)` an ``nwfilter``
>> +profile can be assigned to a domain interface, which allows configuring traffic
>> +filter rules for the virtual machine. See the `nwfilter <formatnwfilter.html>`__
>> +documentation for more complete details.
>>   
>>   ::
>>   
>> -- 
>> 2.35.3
> 
> Should this have a
> 
> Suggested-by: Demi Marie Obenour <demi@invisiblethingslab.com>
> 
> tag?

I've added that.

> In any case:
> 
> Acked-by: Demi Marie Obenour <demi@invisiblethingslab.com>

I don't recall use of 'Acked-by' in libvirt for a long time. 'git log' seems to 
confirm that. Neither the contributor or committer guidelines say much about it

https://libvirt.org/hacking.html
https://libvirt.org/committer-guidelines.html

I'm happy to add it, or 'Reviewed-by' if you're fine with that, but would like 
to hear opinions from other maintainers on this topic.

Regards,
Jim
Re: [PATCH 1/2] docs: Clarify hypervisor support for nwfilter profiles
Posted by Laine Stump 1 year, 5 months ago
On 9/11/24 6:44 PM, Jim Fehlig via Devel wrote:
> On 9/11/24 15:54, Demi Marie Obenour wrote:
>> On Wed, Sep 11, 2024 at 03:02:41PM -0600, Jim Fehlig wrote:
>>> Enhance the 'since' annotation of <filterref> documentation to note
>>> it's only supported by the QEMU, LXC, and ch hypervisor drivers.
>>>
>>> Signed-off-by: Jim Fehlig <jfehlig@suse.com>
>>> ---
>>>   docs/formatdomain.rst | 8 ++++----
>>>   1 file changed, 4 insertions(+), 4 deletions(-)
>>>
>>> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
>>> index 47d3e2125e..8e8a9660fc 100644
>>> --- a/docs/formatdomain.rst
>>> +++ b/docs/formatdomain.rst
>>> @@ -6205,10 +6205,10 @@ hypervisor tries to reconnect.
>>>   Traffic filtering with NWFilter
>>>   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>>> -:since:`Since 0.8.0` an ``nwfilter`` profile can be assigned to a 
>>> domain
>>> -interface, which allows configuring traffic filter rules for the 
>>> virtual
>>> -machine. See the `nwfilter <formatnwfilter.html>`__ documentation 
>>> for more
>>> -complete details.
>>> +:since:`Since 0.8.0 (QEMU), 0.9.3 (LXC), 10.1.0 (Cloud Hypervisor)` 
>>> an ``nwfilter``
>>> +profile can be assigned to a domain interface, which allows 
>>> configuring traffic
>>> +filter rules for the virtual machine. See the `nwfilter 
>>> <formatnwfilter.html>`__
>>> +documentation for more complete details.
>>>   ::
>>> -- 
>>> 2.35.3
>>
>> Should this have a
>>
>> Suggested-by: Demi Marie Obenour <demi@invisiblethingslab.com>
>>
>> tag?
> 
> I've added that.
> 
>> In any case:
>>
>> Acked-by: Demi Marie Obenour <demi@invisiblethingslab.com>
> 
> I don't recall use of 'Acked-by' in libvirt for a long time. 'git log' 
> seems to confirm that. Neither the contributor or committer guidelines 
> say much about it
> 
> https://libvirt.org/hacking.html
> https://libvirt.org/committer-guidelines.html
> 
> I'm happy to add it, or 'Reviewed-by' if you're fine with that, but 
> would like to hear opinions from other maintainers on this topic.

A *long* time ago before we used the Reviewed-by: tag we used to approve 
patches by replying "ACK" in an email, but we've always put Reviewed-by: 
in git.
Re: [PATCH 1/2] docs: Clarify hypervisor support for nwfilter profiles
Posted by Laine Stump 1 year, 5 months ago
On 9/11/24 5:02 PM, Jim Fehlig via Devel wrote:
> Enhance the 'since' annotation of <filterref> documentation to note
> it's only supported by the QEMU, LXC, and ch hypervisor drivers.
> 
> Signed-off-by: Jim Fehlig <jfehlig@suse.com>
> ---
>   docs/formatdomain.rst | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
> index 47d3e2125e..8e8a9660fc 100644
> --- a/docs/formatdomain.rst
> +++ b/docs/formatdomain.rst
> @@ -6205,10 +6205,10 @@ hypervisor tries to reconnect.
>   Traffic filtering with NWFilter
>   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>   
> -:since:`Since 0.8.0` an ``nwfilter`` profile can be assigned to a domain
> -interface, which allows configuring traffic filter rules for the virtual
> -machine. See the `nwfilter <formatnwfilter.html>`__ documentation for more
> -complete details.
> +:since:`Since 0.8.0 (QEMU), 0.9.3 (LXC), 10.1.0 (Cloud Hypervisor)` an ``nwfilter``
> +profile can be assigned to a domain interface, which allows configuring traffic
> +filter rules for the virtual machine. See the `nwfilter <formatnwfilter.html>`__
> +documentation for more complete details.

It's preexisting, but I would have said "allows configuring network 
traffic filter rules".

Reviewed-by: Laine Stump <laine@redhat.com>
Re: [PATCH 1/2] docs: Clarify hypervisor support for nwfilter profiles
Posted by Jim Fehlig via Devel 1 year, 5 months ago
On 9/11/24 16:08, Laine Stump wrote:
> On 9/11/24 5:02 PM, Jim Fehlig via Devel wrote:
>> Enhance the 'since' annotation of <filterref> documentation to note
>> it's only supported by the QEMU, LXC, and ch hypervisor drivers.
>>
>> Signed-off-by: Jim Fehlig <jfehlig@suse.com>
>> ---
>>   docs/formatdomain.rst | 8 ++++----
>>   1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
>> index 47d3e2125e..8e8a9660fc 100644
>> --- a/docs/formatdomain.rst
>> +++ b/docs/formatdomain.rst
>> @@ -6205,10 +6205,10 @@ hypervisor tries to reconnect.
>>   Traffic filtering with NWFilter
>>   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>> -:since:`Since 0.8.0` an ``nwfilter`` profile can be assigned to a domain
>> -interface, which allows configuring traffic filter rules for the virtual
>> -machine. See the `nwfilter <formatnwfilter.html>`__ documentation for more
>> -complete details.
>> +:since:`Since 0.8.0 (QEMU), 0.9.3 (LXC), 10.1.0 (Cloud Hypervisor)` an 
>> ``nwfilter``
>> +profile can be assigned to a domain interface, which allows configuring traffic
>> +filter rules for the virtual machine. See the `nwfilter <formatnwfilter.html>`__
>> +documentation for more complete details.
> 
> It's preexisting, but I would have said "allows configuring network traffic 
> filter rules".

I've added 'network' to that sentence in my local branch.

> 
> Reviewed-by: Laine Stump <laine@redhat.com>

Thanks!

Regards,
Jim
Re: [PATCH 1/2] docs: Clarify hypervisor support for nwfilter profiles
Posted by Jim Fehlig via Devel 1 year, 4 months ago
On 9/11/24 16:47, Jim Fehlig wrote:
> On 9/11/24 16:08, Laine Stump wrote:
>> On 9/11/24 5:02 PM, Jim Fehlig via Devel wrote:
>>> Enhance the 'since' annotation of <filterref> documentation to note
>>> it's only supported by the QEMU, LXC, and ch hypervisor drivers.
>>>
>>> Signed-off-by: Jim Fehlig <jfehlig@suse.com>
>>> ---
>>>   docs/formatdomain.rst | 8 ++++----
>>>   1 file changed, 4 insertions(+), 4 deletions(-)
>>>
>>> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
>>> index 47d3e2125e..8e8a9660fc 100644
>>> --- a/docs/formatdomain.rst
>>> +++ b/docs/formatdomain.rst
>>> @@ -6205,10 +6205,10 @@ hypervisor tries to reconnect.
>>>   Traffic filtering with NWFilter
>>>   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>>> -:since:`Since 0.8.0` an ``nwfilter`` profile can be assigned to a domain
>>> -interface, which allows configuring traffic filter rules for the virtual
>>> -machine. See the `nwfilter <formatnwfilter.html>`__ documentation for more
>>> -complete details.
>>> +:since:`Since 0.8.0 (QEMU), 0.9.3 (LXC), 10.1.0 (Cloud Hypervisor)` an 
>>> ``nwfilter``
>>> +profile can be assigned to a domain interface, which allows configuring traffic
>>> +filter rules for the virtual machine. See the `nwfilter 
>>> <formatnwfilter.html>`__
>>> +documentation for more complete details.
>>
>> It's preexisting, but I would have said "allows configuring network traffic 
>> filter rules".
> 
> I've added 'network' to that sentence in my local branch.
> 
>>
>> Reviewed-by: Laine Stump <laine@redhat.com>

I've pushed this patch now. I'll send V2 of patch2 in a bit.

Regards,
Jim