diff mbox series

[net] docs: networking: fix indentation errors in multi-pf-netdev

Message ID 20240313032329.3919036-1-kuba@kernel.org (mailing list archive)
State Accepted
Commit 1c6368679979019f884557b1843e1dedffac231c
Delegated to: Netdev Maintainers
Headers show
Series [net] docs: networking: fix indentation errors in multi-pf-netdev | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag present in non-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/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 9 of 9 maintainers
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 Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 64 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-03-14--12-00 (tests: 908)

Commit Message

Jakub Kicinski March 13, 2024, 3:23 a.m. UTC 
Stephen reports new warnings in the docs:

Documentation/networking/multi-pf-netdev.rst:94: ERROR: Unexpected indentation.
Documentation/networking/multi-pf-netdev.rst:106: ERROR: Unexpected indentation.

Fixes: 77d9ec3f6c8c ("Documentation: networking: Add description for multi-pf netdev")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Link: https://lore.kernel.org/all/20240312153304.0ef1b78e@canb.auug.org.au/
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
Turns out our build test for docs was broken.
---
CC: corbet@lwn.net
CC: przemyslaw.kitszel@intel.com
CC: tariqt@nvidia.com
CC: saeedm@nvidia.com
CC: linux-doc@vger.kernel.org
---
 Documentation/networking/multi-pf-netdev.rst | 50 ++++++++++----------
 1 file changed, 25 insertions(+), 25 deletions(-)

Comments

Tariq Toukan March 13, 2024, 6:07 a.m. UTC | #1 
On 13/03/2024 5:23, Jakub Kicinski wrote:
> Stephen reports new warnings in the docs:
> 
> Documentation/networking/multi-pf-netdev.rst:94: ERROR: Unexpected indentation.
> Documentation/networking/multi-pf-netdev.rst:106: ERROR: Unexpected indentation.
> 
> Fixes: 77d9ec3f6c8c ("Documentation: networking: Add description for multi-pf netdev")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Link: https://lore.kernel.org/all/20240312153304.0ef1b78e@canb.auug.org.au/
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
> Turns out our build test for docs was broken.
> ---
> CC: corbet@lwn.net
> CC: przemyslaw.kitszel@intel.com
> CC: tariqt@nvidia.com
> CC: saeedm@nvidia.com
> CC: linux-doc@vger.kernel.org

Thanks for taking care of this.
Reviewed-by: Tariq Toukan <tariqt@nvidia.com>
Yunsheng Lin March 13, 2024, 8:03 a.m. UTC | #2 
On 2024/3/13 11:23, Jakub Kicinski wrote:

...

>  
> -Here you can clearly observe our channels distribution policy:
> +Here you can clearly observe our channels distribution policy::

If the double ':' above is intended?
Jonathan Corbet March 13, 2024, 9:32 a.m. UTC | #3 
Yunsheng Lin <linyunsheng@huawei.com> writes:

> On 2024/3/13 11:23, Jakub Kicinski wrote:
>
> ...
>
>>  
>> -Here you can clearly observe our channels distribution policy:
>> +Here you can clearly observe our channels distribution policy::
>
> If the double ':' above is intended?

That is RST markup indicating a literal block, so yes, it is intended.

jon
patchwork-bot+netdevbpf@kernel.org March 14, 2024, 12:30 p.m. UTC | #4 
Hello:

This patch was applied to netdev/net.git (main)
by Paolo Abeni <pabeni@redhat.com>:

On Tue, 12 Mar 2024 20:23:29 -0700 you wrote:
> Stephen reports new warnings in the docs:
> 
> Documentation/networking/multi-pf-netdev.rst:94: ERROR: Unexpected indentation.
> Documentation/networking/multi-pf-netdev.rst:106: ERROR: Unexpected indentation.
> 
> Fixes: 77d9ec3f6c8c ("Documentation: networking: Add description for multi-pf netdev")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Link: https://lore.kernel.org/all/20240312153304.0ef1b78e@canb.auug.org.au/
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> 
> [...]

Here is the summary with links:
  - [net] docs: networking: fix indentation errors in multi-pf-netdev
    https://git.kernel.org/netdev/net/c/1c6368679979

You are awesome, thank you!
diff mbox series

Patch

diff --git a/Documentation/networking/multi-pf-netdev.rst b/Documentation/networking/multi-pf-netdev.rst
index be8e4bcadf11..268819225866 100644
--- a/Documentation/networking/multi-pf-netdev.rst
+++ b/Documentation/networking/multi-pf-netdev.rst
@@ -87,35 +87,35 @@  all using the same instance under "priv->mdev".
 
 Observability
 =============
-The relation between PF, irq, napi, and queue can be observed via netlink spec:
+The relation between PF, irq, napi, and queue can be observed via netlink spec::
 
-$ ./tools/net/ynl/cli.py --spec Documentation/netlink/specs/netdev.yaml --dump queue-get --json='{"ifindex": 13}'
-[{'id': 0, 'ifindex': 13, 'napi-id': 539, 'type': 'rx'},
- {'id': 1, 'ifindex': 13, 'napi-id': 540, 'type': 'rx'},
- {'id': 2, 'ifindex': 13, 'napi-id': 541, 'type': 'rx'},
- {'id': 3, 'ifindex': 13, 'napi-id': 542, 'type': 'rx'},
- {'id': 4, 'ifindex': 13, 'napi-id': 543, 'type': 'rx'},
- {'id': 0, 'ifindex': 13, 'napi-id': 539, 'type': 'tx'},
- {'id': 1, 'ifindex': 13, 'napi-id': 540, 'type': 'tx'},
- {'id': 2, 'ifindex': 13, 'napi-id': 541, 'type': 'tx'},
- {'id': 3, 'ifindex': 13, 'napi-id': 542, 'type': 'tx'},
- {'id': 4, 'ifindex': 13, 'napi-id': 543, 'type': 'tx'}]
+  $ ./tools/net/ynl/cli.py --spec Documentation/netlink/specs/netdev.yaml --dump queue-get --json='{"ifindex": 13}'
+  [{'id': 0, 'ifindex': 13, 'napi-id': 539, 'type': 'rx'},
+   {'id': 1, 'ifindex': 13, 'napi-id': 540, 'type': 'rx'},
+   {'id': 2, 'ifindex': 13, 'napi-id': 541, 'type': 'rx'},
+   {'id': 3, 'ifindex': 13, 'napi-id': 542, 'type': 'rx'},
+   {'id': 4, 'ifindex': 13, 'napi-id': 543, 'type': 'rx'},
+   {'id': 0, 'ifindex': 13, 'napi-id': 539, 'type': 'tx'},
+   {'id': 1, 'ifindex': 13, 'napi-id': 540, 'type': 'tx'},
+   {'id': 2, 'ifindex': 13, 'napi-id': 541, 'type': 'tx'},
+   {'id': 3, 'ifindex': 13, 'napi-id': 542, 'type': 'tx'},
+   {'id': 4, 'ifindex': 13, 'napi-id': 543, 'type': 'tx'}]
 
-$ ./tools/net/ynl/cli.py --spec Documentation/netlink/specs/netdev.yaml --dump napi-get --json='{"ifindex": 13}'
-[{'id': 543, 'ifindex': 13, 'irq': 42},
- {'id': 542, 'ifindex': 13, 'irq': 41},
- {'id': 541, 'ifindex': 13, 'irq': 40},
- {'id': 540, 'ifindex': 13, 'irq': 39},
- {'id': 539, 'ifindex': 13, 'irq': 36}]
+  $ ./tools/net/ynl/cli.py --spec Documentation/netlink/specs/netdev.yaml --dump napi-get --json='{"ifindex": 13}'
+  [{'id': 543, 'ifindex': 13, 'irq': 42},
+   {'id': 542, 'ifindex': 13, 'irq': 41},
+   {'id': 541, 'ifindex': 13, 'irq': 40},
+   {'id': 540, 'ifindex': 13, 'irq': 39},
+   {'id': 539, 'ifindex': 13, 'irq': 36}]
 
-Here you can clearly observe our channels distribution policy:
+Here you can clearly observe our channels distribution policy::
 
-$ ls /proc/irq/{36,39,40,41,42}/mlx5* -d -1
-/proc/irq/36/mlx5_comp1@pci:0000:08:00.0
-/proc/irq/39/mlx5_comp1@pci:0000:09:00.0
-/proc/irq/40/mlx5_comp2@pci:0000:08:00.0
-/proc/irq/41/mlx5_comp2@pci:0000:09:00.0
-/proc/irq/42/mlx5_comp3@pci:0000:08:00.0
+  $ ls /proc/irq/{36,39,40,41,42}/mlx5* -d -1
+  /proc/irq/36/mlx5_comp1@pci:0000:08:00.0
+  /proc/irq/39/mlx5_comp1@pci:0000:09:00.0
+  /proc/irq/40/mlx5_comp2@pci:0000:08:00.0
+  /proc/irq/41/mlx5_comp2@pci:0000:09:00.0
+  /proc/irq/42/mlx5_comp3@pci:0000:08:00.0
 
 Steering
 ========