Re: [PATCH] virtio: fix virtio_config_ops kerneldocs

2022-12-20 Thread Ricardo Cañuelo
On 20/12/22 11:25, Michael S. Tsirkin wrote: This doesn't matter I think, what Fixes tag does is tell tools if you have commit A you want this one on top. Ok, thanks for clarifying. v3 submitted. Cheers, Ricardo ___ Virtualization mailing list Virtua

[PATCH v3] virtio: fix virtio_config_ops kerneldocs

2022-12-20 Thread Ricardo Cañuelo
.au/ Fixes: 333723e8bc393d ("docs: driver-api: virtio: virtio on Linux") Reported-by: Stephen Rothwell Signed-off-by: Ricardo Cañuelo Reviewed-by: Bagas Sanjaya --- Changes in v3: - Added a Fixes tag referencing the commit that revealed the warning messages (suggested by Bagas S

Re: [PATCH] virtio: fix virtio_config_ops kerneldocs

2022-12-20 Thread Ricardo Cañuelo
On 20/12/22 10:48, AngeloGioacchino Del Regno wrote: To avoid getting the same warning in the future (developer mistake and/or other reasons), what about dropping this instance of "Note:" entirely? I think that something like... the dev->feature bits if it wants. Note that despite the name..

[PATCH v2] virtio: fix virtio_config_ops kerneldocs

2022-12-20 Thread Ricardo Cañuelo
uug.org.au/ Reported-by: Stephen Rothwell Signed-off-by: Ricardo Cañuelo Reviewed-by: Bagas Sanjaya --- include/linux/virtio_config.h | 8 +--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/linux/virtio_config.h b/include/linux/virtio_config.h index 4b517649cfe8..2b3438de2

Re: [PATCH] virtio: fix virtio_config_ops kerneldocs

2022-12-20 Thread Ricardo Cañuelo
Hi Bagas, Thanks for the review, some comments below: On 20/12/22 10:12, Bagas Sanjaya wrote:> On Tue, Dec 20, 2022 at 08:37:09AM +0100, Ricardo Cañuelo wrote: Describe the steps needed to fix both warnings above. I see in the diff that: * move vq_callback_t() declaration ab

[PATCH] virtio: fix virtio_config_ops kerneldocs

2022-12-19 Thread Ricardo Cañuelo
Fixes two warning messages when building htmldocs: warning: duplicate section name 'Note' warning: expecting prototype for virtio_config_ops(). Prototype was for vq_callback_t() instead Signed-off-by: Ricardo Cañuelo --- include/linux/virtio_config.h | 9 +--

[PATCH RESEND] tools/virtio: initialize spinlocks in vring_test.c

2022-10-11 Thread Ricardo Cañuelo
The virtio_device vqs_list spinlocks must be initialized before use to prevent functions that manipulate the device virtualqueues, such as vring_new_virtqueue(), from blocking indefinitely. Signed-off-by: Ricardo Cañuelo --- tools/virtio/vringh_test.c | 2 ++ 1 file changed, 2 insertions

Re: [RESEND PATCH v5 1/1] docs: driver-api: virtio: virtio on Linux

2022-10-11 Thread Ricardo Cañuelo
Hi Bagas, thanks for the review, some comments below: On lun, oct 10 2022 at 20:04:14, Bagas Sanjaya wrote: > What link is for [2]? I think you'll need to spell out the link title. > Also, the external reference pointers should be parenthesized to indicate > that these are references: That's a

[RESEND PATCH v5 0/1] docs: driver-api: virtio: virtio on Linux

2022-10-09 Thread Ricardo Cañuelo
already covered by the spec - split the kerneldocs fixes to a separate patch - remove :c:func: rst formatting Ricardo Cañuelo (1): docs: driver-api: virtio: virtio on Linux Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11

[RESEND PATCH v5 1/1] docs: driver-api: virtio: virtio on Linux

2022-10-09 Thread Ricardo Cañuelo
Basic doc about Virtio on Linux and a short tutorial on Virtio drivers. Signed-off-by: Ricardo Cañuelo Reviewed-by: Cornelia Huck --- Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11 + Documentation/driver-api/virtio/virtio.rst

[PATCH v5 1/1] docs: driver-api: virtio: virtio on Linux

2022-09-02 Thread Ricardo Cañuelo
Basic doc about Virtio on Linux and a short tutorial on Virtio drivers. Signed-off-by: Ricardo Cañuelo Reviewed-by: Cornelia Huck --- Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11 + Documentation/driver-api/virtio/virtio.rst

[PATCH v5 0/1] docs: driver-api: virtio: virtio on Linux

2022-09-02 Thread Ricardo Cañuelo
already covered by the spec - split the kerneldocs fixes to a separate patch - remove :c:func: rst formatting Ricardo Cañuelo (1): docs: driver-api: virtio: virtio on Linux Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11

Re: [PATCH v14 00/42] virtio pci support VIRTIO_F_RING_RESET

2022-08-30 Thread Ricardo Cañuelo
On mar, ago 30 2022 at 17:33:31, Xuan Zhuo wrote: > Can you test this patch? It didn't apply cleanly over git.kernel.org/pub/scm/linux/kernel/git/mst/vhost.git (linux-next) but I applied it manually and it works, thanks! Cheers, Ricardo ___ Virtualiza

[PATCH RESEND] tools/virtio: initialize spinlocks in vring_test.c

2022-08-30 Thread Ricardo Cañuelo
The virtio_device vqs_list spinlocks must be initialized before use to prevent functions that manipulate the device virtualqueues, such as vring_new_virtqueue(), from blocking indefinitely. Signed-off-by: Ricardo Cañuelo --- tools/virtio/vringh_test.c | 2 ++ 1 file changed, 2 insertions

Re: [PATCH v14 00/42] virtio pci support VIRTIO_F_RING_RESET

2022-08-30 Thread Ricardo Cañuelo
Hi Xuan, Patches 24 (virtio_ring: introduce virtqueue_resize()) and 28 (virtio_ring: struct virtqueue introduce reset) break the tools/virtio build: ../../drivers/virtio/virtio_ring.c: In function ‘vring_create_virtqueue_packed’: ../../drivers/virtio/virtio_ring.c:1999:8: error: ‘struct virtqueu

Re: [PATCH v4 2/2] docs: driver-api: virtio: virtio on Linux

2022-08-11 Thread Ricardo Cañuelo
Hi Michael, thanks for reviewing: On jue, ago 11 2022 at 09:32:05, "Michael S. Tsirkin" wrote: > which tree is this for? > > Applying: docs: driver-api: virtio: virtio on Linux > error: sha1 information is lacking or useless (MAINTAINERS). > error: could not build fake ancestor > Patch failed at

[PATCH v4 2/2] docs: driver-api: virtio: virtio on Linux

2022-08-10 Thread Ricardo Cañuelo
Basic doc about Virtio on Linux and a short tutorial on Virtio drivers. Signed-off-by: Ricardo Cañuelo --- Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11 ++ Documentation/driver-api/virtio/virtio.rst| 144

[PATCH v4 0/2] docs: driver-api: virtio: virtio on Linux

2022-08-10 Thread Ricardo Cañuelo
proper Sphinx markup for links to references Changes in v2: - virtio spec links updated to v1.2 - simplify virtio.rst and remove most low level parts that are already covered by the spec - split the kerneldocs fixes to a separate patch - remove :c:func: rst formatting Ricardo Cañuelo

[PATCH v4 1/2] virtio: kerneldocs fixes and enhancements

2022-08-10 Thread Ricardo Cañuelo
Fix variable names in some kerneldocs, naming in others. Add kerneldocs for struct vring_desc and vring_interrupt. Signed-off-by: Ricardo Cañuelo --- drivers/virtio/virtio_ring.c | 8 include/linux/virtio.h | 6 +++--- include/linux/virtio_config.h| 6

Re: [PATCH v2 2/2] docs: driver-api: virtio: virtio on Linux

2022-08-09 Thread Ricardo Cañuelo
Hi Cornelia, Thanks for the insightful comments and ideas. Answers below: On lun, ago 08 2022 at 15:47:06, Cornelia Huck wrote: > Hm... so I'm not quite happy with those two paragraphs, but I'm not sure > how to make it better. > > - While the origins of virtio are hypervisor implementations, th

[PATCH v3 2/2] docs: driver-api: virtio: virtio on Linux

2022-08-08 Thread Ricardo Cañuelo
Basic doc about Virtio on Linux and a short tutorial on Virtio drivers. Signed-off-by: Ricardo Cañuelo --- Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11 + Documentation/driver-api/virtio/virtio.rst| 151 ++ .../virtio

[PATCH v3 1/2] virtio: kerneldocs fixes and enhancements

2022-08-08 Thread Ricardo Cañuelo
Fix variable names in some kerneldocs, naming in others. Add kerneldocs for struct vring_desc and vring_interrupt. Signed-off-by: Ricardo Cañuelo --- drivers/virtio/virtio_ring.c | 8 include/linux/virtio.h | 6 +++--- include/linux/virtio_config.h| 6

[PATCH v3 0/2] docs: driver-api: virtio: virtio on Linux

2022-08-08 Thread Ricardo Cañuelo
: - virtio spec links updated to v1.2 - simplify virtio.rst and remove most low level parts that are already covered by the spec - split the kerneldocs fixes to a separate patch - remove :c:func: rst formatting Ricardo Cañuelo (2): virtio: kerneldocs fixes and enhancements docs: driver-api

Re: [PATCH v2 1/2] virtio: kerneldocs fixes and enhancements

2022-08-08 Thread Ricardo Cañuelo
Hi Cornelia, thanks for the review: On lun, ago 08 2022 at 14:14:07, Cornelia Huck wrote: > Isn't that "kerneldoc"? But maybe I'm a bit behind on the current > terminology. Ugh what a silly slip. You're totally right, I got kerneldocs and htmldocs mixed in my head after so many "make htmldocs" t

Re: [PATCH v2 2/2] docs: driver-api: virtio: virtio on Linux

2022-08-08 Thread Ricardo Cañuelo
Hi Bagas, Thanks for reviewing the patch, comments below: On sáb, ago 06 2022 at 14:58:08, Bagas Sanjaya wrote: > Sphinx citation syntax can be used for external references, like: > > diff --git a/Documentation/driver-api/virtio/virtio.rst > b/Documentation/driver-api/virtio/virtio.rst > index

[PATCH] tools/virtio: initialize spinlocks in vring_test.c

2022-08-05 Thread Ricardo Cañuelo
The virtio_device vqs_list spinlocks must be initialized before use to prevent functions that manipulate the device virtualqueues, such as vring_new_virtqueue(), from blocking indefinitely. Signed-off-by: Ricardo Cañuelo --- tools/virtio/vringh_test.c | 2 ++ 1 file changed, 2 insertions

[PATCH v2 1/2] virtio: kerneldocs fixes and enhancements

2022-08-04 Thread Ricardo Cañuelo
Fix variable names in some htmldocs, naming in others. Add htmldocs for struct vring_desc and vring_interrupt. Signed-off-by: Ricardo Cañuelo --- drivers/virtio/virtio_ring.c | 8 include/linux/virtio.h | 6 +++--- include/linux/virtio_config.h| 6 +++--- include

[PATCH v2 2/2] docs: driver-api: virtio: virtio on Linux

2022-08-04 Thread Ricardo Cañuelo
Basic doc about Virtio on Linux and a short tutorial on Virtio drivers. Signed-off-by: Ricardo Cañuelo --- Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11 + Documentation/driver-api/virtio/virtio.rst| 151 ++ .../virtio

[PATCH v2 0/2] docs: driver-api: virtio: virtio on Linux

2022-08-04 Thread Ricardo Cañuelo
kerneldocs fixes to a separate patch - remove :c:func: rst formatting Ricardo Cañuelo (2): virtio: kerneldocs fixes and enhancements docs: driver-api: virtio: virtio on Linux Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11 + Documentation

Re: [PATCH] docs: driver-api: virtio: virtio on Linux

2022-08-03 Thread Ricardo Cañuelo
Hi Michael, thanks for reviewing the patch. Comments below: On mié, ago 03 2022 at 02:54:28, "Michael S. Tsirkin" wrote: > So I'm okay with a high level overview up to this point. > Below starts getting into details and they are not up to date > and I don't think we want to maintain a copy here.

Re: [PATCH] docs: driver-api: virtio: virtio on Linux

2022-08-03 Thread Ricardo Cañuelo
Hi Cornelia, Thanks for the review. This is my first approach to virtio and I had to make some assumptions myself from reading the code and the spec, so I expected lots of corrections. On mar, ago 02 2022 at 17:55:43, Cornelia Huck wrote: > I think kerneldoc updates should be split out into a se

Re: [PATCH] docs: driver-api: virtio: virtio on Linux

2022-08-03 Thread Ricardo Cañuelo
Hi Matthew, On mar, ago 02 2022 at 16:56:48, Matthew Wilcox wrote: > You don't need to use :c:func:`foo`. You can just write foo() and the > tooling will convert it into :c:func:`foo` for you. Thanks for the tip. However, I did some tests and the results aren't quite the same. For functions wit

Re: [PATCH] docs: driver-api: virtio: virtio on Linux

2022-08-03 Thread Ricardo Cañuelo
Matthew Wilcox writes: > On Tue, Aug 02, 2022 at 02:42:22PM +0200, Ricardo Cañuelo wrote: >> +In this case, when the interrupt arrives :c:func:`vp_interrupt` will be >> +called and it will ultimately lead to a call to >> +:c:func:`vring_interrupt`, which ends up calling t

Re: [PATCH] docs: driver-api: virtio: virtio on Linux

2022-08-02 Thread Ricardo Cañuelo
Hi Bagas, Thanks for reviewing Bagas Sanjaya writes: > I can't apply this patch on top of mainline. On what commit (and what > tree) was it based from? The patch applies cleanly on recent tags of linux-next (tested on next-20220802). If this needs to be tested on a different tree/commit let me

[PATCH] docs: driver-api: virtio: virtio on Linux

2022-08-02 Thread Ricardo Cañuelo
Basic doc about Virtio on Linux and a short tutorial on Virtio drivers. Minor fixes to existing virtio kerneldocs. Signed-off-by: Ricardo Cañuelo --- Documentation/driver-api/index.rst| 1 + Documentation/driver-api/virtio/index.rst | 11 + Documentation/driver-api/virtio