2024-02-23 06:24:09

by Randy Dunlap

Subject: [PATCH -next] VDUSE: fix another doc underline warning

Extend the underline for a heading to prevent a documentation
build warning. Also spell "reconnection" correctly.

Documentation/userspace-api/vduse.rst:236: WARNING: Title underline too short.
HOW VDUSE devices reconnectoin works
----------------

Fixes: 2b3fd606c662 ("Documentation: Add reconnect process for VDUSE")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Cindy Lu <[email protected]>
Cc: Michael S. Tsirkin <[email protected]>
Cc: Jason Wang <[email protected]>
Cc: Xuan Zhuo <[email protected]>
Cc: [email protected]
Cc: Jonathan Corbet <[email protected]>
---
Documentation/userspace-api/vduse.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/Documentation/userspace-api/vduse.rst b/Documentation/userspace-api/vduse.rst
--- a/Documentation/userspace-api/vduse.rst
+++ b/Documentation/userspace-api/vduse.rst
@@ -232,8 +232,8 @@ able to start the dataplane processing a

For more details on the uAPI, please see include/uapi/linux/vduse.h.

-HOW VDUSE devices reconnectoin works
-----------------
+HOW VDUSE devices reconnection works
+------------------------------------
0. Userspace APP checks if the device /dev/vduse/vduse_name exists.
If it does not exist, need to create the instance.goto step 1
If it does exist, it means this is a reconnect and goto step 3.

2024-02-23 08:08:11

by Michael S. Tsirkin

Subject: Re: [PATCH -next] VDUSE: fix another doc underline warning

On Thu, Feb 22, 2024 at 10:23:41PM -0800, Randy Dunlap wrote:
> Extend the underline for a heading to prevent a documentation
> build warning. Also spell "reconnection" correctly.
>
> Documentation/userspace-api/vduse.rst:236: WARNING: Title underline too short.
> HOW VDUSE devices reconnectoin works
> ----------------
>
> Fixes: 2b3fd606c662 ("Documentation: Add reconnect process for VDUSE")
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Cindy Lu <[email protected]>
> Cc: Michael S. Tsirkin <[email protected]>
> Cc: Jason Wang <[email protected]>
> Cc: Xuan Zhuo <[email protected]>
> Cc: [email protected]
> Cc: Jonathan Corbet <[email protected]>

Thanks, I fixed this in my tree already.

> ---
> Documentation/userspace-api/vduse.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff -- a/Documentation/userspace-api/vduse.rst b/Documentation/userspace-api/vduse.rst
> --- a/Documentation/userspace-api/vduse.rst
> +++ b/Documentation/userspace-api/vduse.rst
> @@ -232,8 +232,8 @@ able to start the dataplane processing a
>
> For more details on the uAPI, please see include/uapi/linux/vduse.h.
>
> -HOW VDUSE devices reconnectoin works
> -----------------
> +HOW VDUSE devices reconnection works
> +------------------------------------
> 0. Userspace APP checks if the device /dev/vduse/vduse_name exists.
> If it does not exist, need to create the instance.goto step 1
> If it does exist, it means this is a reconnect and goto step 3.