diff mbox series

[v1,net-next] net: ena: Add missing newline after markup

Message ID 20230620070206.1320-1-darinzon@amazon.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series [v1,net-next] net: ena: Add missing newline after markup | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 8 this patch: 8
netdev/cc_maintainers warning 4 maintainers not CCed: pabeni@redhat.com corbet@lwn.net edumazet@google.com linux-doc@vger.kernel.org
netdev/build_clang success Errors and warnings before: 8 this patch: 8
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 7 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Arinzon, David June 20, 2023, 7:02 a.m. UTC
From: David Arinzon <darinzon@amazon.com>

This patch fixes a warning in the ena documentation
file identified by the kernel automatic tools.

Signed-off-by: David Arinzon <darinzon@amazon.com>
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202306171804.U7E92zoE-lkp@intel.com/
---
 Documentation/networking/device_drivers/ethernet/amazon/ena.rst | 1 +
 1 file changed, 1 insertion(+)

Comments

Simon Horman June 20, 2023, 12:47 p.m. UTC | #1
On Tue, Jun 20, 2023 at 07:02:06AM +0000, darinzon@amazon.com wrote:
> From: David Arinzon <darinzon@amazon.com>
> 
> This patch fixes a warning in the ena documentation
> file identified by the kernel automatic tools.
> 
> Signed-off-by: David Arinzon <darinzon@amazon.com>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202306171804.U7E92zoE-lkp@intel.com/
> ---
>  Documentation/networking/device_drivers/ethernet/amazon/ena.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> index 491492677632..00851ec7b4ec 100644
> --- a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> +++ b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> @@ -206,6 +206,7 @@ More information about Adaptive Interrupt Moderation (DIM) can be found in
>  Documentation/networking/net_dim.rst
>  
>  .. _`RX copybreak`:
> +
>  RX copybreak
>  ============
>  The rx_copybreak is initialized by default to ENA_DEFAULT_RX_COPYBREAK

Thanks David,

this looks good to me.

Reviewed-by: Simon Horman <simon.horman@corigine.com>

Although it doesn't trigger a warning, the formatting of the
text updated below doesn't seem right (I used make htmldocs).
Feel free to take this if it is useful, or say the word and I'll submit
it formally.

diff --git a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
index 00851ec7b4ec..5eaa3ab6c73e 100644
--- a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
+++ b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
@@ -38,6 +38,7 @@ debug logs.
 
 Some of the ENA devices support a working mode called Low-latency
 Queue (LLQ), which saves several more microseconds.
+
 ENA Source Code Directory Structure
 ===================================
Arinzon, David June 20, 2023, 1:25 p.m. UTC | #2
> On Tue, Jun 20, 2023 at 07:02:06AM +0000, darinzon@amazon.com wrote:
> > From: David Arinzon <darinzon@amazon.com>
> >
> > This patch fixes a warning in the ena documentation file identified by
> > the kernel automatic tools.
> >
> > Signed-off-by: David Arinzon <darinzon@amazon.com>
> > Reported-by: kernel test robot <lkp@intel.com>
> > Closes:
> > https://lore.kernel.org/oe-kbuild-all/202306171804.U7E92zoE-lkp@intel.
> > com/
> > ---
> >  Documentation/networking/device_drivers/ethernet/amazon/ena.rst | 1
> +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git
> > a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> > b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> > index 491492677632..00851ec7b4ec 100644
> > ---
> a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> > +++
> b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> > @@ -206,6 +206,7 @@ More information about Adaptive Interrupt
> > Moderation (DIM) can be found in
> Documentation/networking/net_dim.rst
> >
> >  .. _`RX copybreak`:
> > +
> >  RX copybreak
> >  ============
> >  The rx_copybreak is initialized by default to
> > ENA_DEFAULT_RX_COPYBREAK
> 
> Thanks David,
> 
> this looks good to me.
> 
> Reviewed-by: Simon Horman <simon.horman@corigine.com>
> 
> Although it doesn't trigger a warning, the formatting of the text updated
> below doesn't seem right (I used make htmldocs).
> Feel free to take this if it is useful, or say the word and I'll submit it formally.
> 
> diff --git
> a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> index 00851ec7b4ec..5eaa3ab6c73e 100644
> --- a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> +++
> b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> @@ -38,6 +38,7 @@ debug logs.
> 
>  Some of the ENA devices support a working mode called Low-latency
> Queue (LLQ), which saves several more microseconds.
> +
>  ENA Source Code Directory Structure
>  ===================================
> 
> 

Hi Simon,

Thank you for reviewing and identifying this formatting issue, I'll submit a v2 today.
diff mbox series

Patch

diff --git a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
index 491492677632..00851ec7b4ec 100644
--- a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
+++ b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
@@ -206,6 +206,7 @@  More information about Adaptive Interrupt Moderation (DIM) can be found in
 Documentation/networking/net_dim.rst
 
 .. _`RX copybreak`:
+
 RX copybreak
 ============
 The rx_copybreak is initialized by default to ENA_DEFAULT_RX_COPYBREAK