diff mbox series

doc: fix build error with sphinx 4.5.0

Message ID 20220501145721.3776509-1-jerinj@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers
Series doc: fix build error with sphinx 4.5.0 |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Jerin Jacob Kollanukkaran May 1, 2022, 2:57 p.m. UTC 
From: Jerin Jacob <jerinj@marvell.com>

Latest sphinx checks c language syntax more aggressively.
Fix the following warning by correcting c language syntax.

doc/guides/prog_guide/event_ethernet_rx_adapter.rst:243:
WARNING: Could not lex literal_block as "c". Highlighting skipped.

Fixes: 3c838062b91f ("eventdev: introduce event vector Rx capability")
Cc: Pavan Nikhilesh <pbhagavatula@marvell.com>
Cc: stable@dpdk.org

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
---
 doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Jayatheerthan, Jay May 2, 2022, 7 a.m. UTC | #1 
Looks good, thanks!

Acked-by: Jay Jayatheerthan <jay.jayatheerthan@intel.com>

-Jay



> -----Original Message-----
> From: jerinj@marvell.com <jerinj@marvell.com>
> Sent: Sunday, May 1, 2022 8:27 PM
> To: dev@dpdk.org; Jayatheerthan, Jay <jay.jayatheerthan@intel.com>; Jerin Jacob <jerinj@marvell.com>; Ray Kinsella
> <mdr@ashroe.eu>; Pavan Nikhilesh <pbhagavatula@marvell.com>
> Cc: thomas@monjalon.net; david.marchand@redhat.com; stable@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: fix build error with sphinx 4.5.0
> 
> From: Jerin Jacob <jerinj@marvell.com>
> 
> Latest sphinx checks c language syntax more aggressively.
> Fix the following warning by correcting c language syntax.
> 
> doc/guides/prog_guide/event_ethernet_rx_adapter.rst:243:
> WARNING: Could not lex literal_block as "c". Highlighting skipped.
> 
> Fixes: 3c838062b91f ("eventdev: introduce event vector Rx capability")
> Cc: Pavan Nikhilesh <pbhagavatula@marvell.com>
> Cc: stable@dpdk.org
> 
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> ---
>  doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> index 67b11e1563..3b4ef502b2 100644
> --- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> +++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> @@ -257,8 +257,8 @@ A loop processing ``rte_event_vector`` containing mbufs is shown below.
>                          /* Process each mbuf. */
>                  }
>          break;
> -        case ...
> -        ...
> +        case default:
> +                /* Handle other event_types. */
>          }
> 
>  Rx event vectorization for SW Rx adapter
> --
> 2.36.0
Jerin Jacob May 9, 2022, 4:07 p.m. UTC | #2 
On Mon, May 2, 2022 at 12:30 PM Jayatheerthan, Jay
<jay.jayatheerthan@intel.com> wrote:
>
> Looks good, thanks!
>
> Acked-by: Jay Jayatheerthan <jay.jayatheerthan@intel.com>

Applied to dpdk-next-eventdev/for-main. Thanks.

>
> -Jay
>
>
>
> > -----Original Message-----
> > From: jerinj@marvell.com <jerinj@marvell.com>
> > Sent: Sunday, May 1, 2022 8:27 PM
> > To: dev@dpdk.org; Jayatheerthan, Jay <jay.jayatheerthan@intel.com>; Jerin Jacob <jerinj@marvell.com>; Ray Kinsella
> > <mdr@ashroe.eu>; Pavan Nikhilesh <pbhagavatula@marvell.com>
> > Cc: thomas@monjalon.net; david.marchand@redhat.com; stable@dpdk.org
> > Subject: [dpdk-dev] [PATCH] doc: fix build error with sphinx 4.5.0
> >
> > From: Jerin Jacob <jerinj@marvell.com>
> >
> > Latest sphinx checks c language syntax more aggressively.
> > Fix the following warning by correcting c language syntax.
> >
> > doc/guides/prog_guide/event_ethernet_rx_adapter.rst:243:
> > WARNING: Could not lex literal_block as "c". Highlighting skipped.
> >
> > Fixes: 3c838062b91f ("eventdev: introduce event vector Rx capability")
> > Cc: Pavan Nikhilesh <pbhagavatula@marvell.com>
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> > ---
> >  doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> > index 67b11e1563..3b4ef502b2 100644
> > --- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> > +++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
> > @@ -257,8 +257,8 @@ A loop processing ``rte_event_vector`` containing mbufs is shown below.
> >                          /* Process each mbuf. */
> >                  }
> >          break;
> > -        case ...
> > -        ...
> > +        case default:
> > +                /* Handle other event_types. */
> >          }
> >
> >  Rx event vectorization for SW Rx adapter
> > --
> > 2.36.0
>
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
index 67b11e1563..3b4ef502b2 100644
--- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
+++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
@@ -257,8 +257,8 @@  A loop processing ``rte_event_vector`` containing mbufs is shown below.
                         /* Process each mbuf. */
                 }
         break;
-        case ...
-        ...
+        case default:
+                /* Handle other event_types. */
         }
 
 Rx event vectorization for SW Rx adapter