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

Randy Dunlap posted 1 patch 1 year, 11 months ago
Documentation/userspace-api/vduse.rst |    4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
[PATCH -next] VDUSE: fix another doc underline warning
Posted by Randy Dunlap 1 year, 11 months ago
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 <rdunlap@infradead.org>
Cc: Cindy Lu <lulu@redhat.com>
Cc: Michael S. Tsirkin <mst@redhat.com>
Cc: Jason Wang <jasowang@redhat.com>
Cc: Xuan Zhuo <xuanzhuo@linux.alibaba.com>
Cc: virtualization@lists.linux.dev
Cc: Jonathan Corbet <corbet@lwn.net>
---
 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.
Re: [PATCH -next] VDUSE: fix another doc underline warning
Posted by Michael S. Tsirkin 1 year, 11 months ago
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 <rdunlap@infradead.org>
> Cc: Cindy Lu <lulu@redhat.com>
> Cc: Michael S. Tsirkin <mst@redhat.com>
> Cc: Jason Wang <jasowang@redhat.com>
> Cc: Xuan Zhuo <xuanzhuo@linux.alibaba.com>
> Cc: virtualization@lists.linux.dev
> Cc: Jonathan Corbet <corbet@lwn.net>

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.