Skip to contentSkip to conversation

net: ena: Add missing newline after markup

PATCH In review [email protected] 2 participants 3 messages Jun 20, 2023

Subsystems (4)
lore
Share & tools
lore

[email protected]

author maintainer
#0 lore raw

PATCH 1/1 net: ena: Add missing newline after markup

From: David Arinzon <[email protected]>

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

---
 Documentation/networking/device_drivers/ethernet/amazon/ena.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/networking/device_drivers/ethernet/amazon/ena.rst +1 -0
index 491492677632..00851ec7b4ec 100644
@@ -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
Signature · 1 line
2.40.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 17 lines · On Tue, Jun 20, 2023 at 07:02:06AM +0000, [email protected] wrote:

From: David Arinzon <[email protected]>

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

---
 Documentation/networking/device_drivers/ethernet/amazon/ena.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/networking/device_drivers/ethernet/amazon/ena.rst +0 -0
index 491492677632..00851ec7b4ec 100644

Documentation/networking/device_drivers/ethernet/amazon/ena.rst More information about Adaptive Interrupt Moderation (DIM) can be found in · line 212

Quoted 7 lines
Documentation/networking/device_drivers/ethernet/amazon/ena.rst +1 -0
@@ -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.

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.

Documentation/networking/device_drivers/ethernet/amazon/ena.rst +1 -0
index 00851ec7b4ec..5eaa3ab6c73e 100644
@@ -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
 ===================================
 
author maintainer
#2 lore raw
Quoted 55 lines · On Tue, Jun 20, 2023 at 07:02:06AM +0000, [email protected] wrote:
Quoted 5 lines

From: David Arinzon <[email protected]>

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

Quoted 7 lines

Closes:
https://lore.kernel.org/oe-kbuild-all/202306171804.U7E92zoE-lkp@intel.
com/

---
 Documentation/networking/device_drivers/ethernet/amazon/ena.rst | 1

+

Quoted 7 lines
 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

Quoted 1 line

+++

b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst

Quoted 2 lines
(quoted diff) +0 -0
@@ -206,6 +206,7 @@ More information about Adaptive Interrupt

Moderation (DIM) can be found in

Documentation/networking/net_dim.rst

Quoted 7 lines

.. _RX copybreak:
+
RX copybreak
============
The rx_copybreak is initialized by default to
ENA_DEFAULT_RX_COPYBREAK

Thanks David,

this looks good to me.

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

Documentation/networking/device_drivers/ethernet/amazon/ena.rst +0 -0
@@ -38,6 +38,7 @@ debug logs.
 
 Some of the ENA devices support a working mode called Low-latency
Quoted 6 lines

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.