DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Wenbo Cao <caowenbo@mucse.com>
Cc: dev@dpdk.org, ferruh.yigit@amd.com,
	andrew.rybchenko@oktetlabs.ru, yaojun@mucse.com
Subject: Re: [PATCH v5 1/8] net/rnp: add skeleton
Date: Tue, 15 Aug 2023 13:10:50 +0200	[thread overview]
Message-ID: <2763426.X9hSmTKtgW@thomas> (raw)
In-Reply-To: <20230807021615.3663034-2-caowenbo@mucse.com>

Hi,

Wenbo Cao:
> --- /dev/null
> +++ b/doc/guides/nics/rnp.rst
> @@ -0,0 +1,43 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2023 Mucse IC Design Ltd.
> +
> +RNP Poll Mode driver
> +==========================

Please keep underlining the same size as the text above.

> +
> +The RNP ETHDEV PMD (**librte_net_rnp**) provides poll mode ethdev
> +driver support for the inbuilt network device found in the **Mucse RNP**
> +
> +Prerequisites
> +-------------
> +More information can be found at `Mucse, Official Website
> +<https://mucse.com/productDetail>`_.
> +
> +Supported RNP SoCs
> +------------------------
> +
> +- N10
> +
> +Driver compilation and testing
> +------------------------------
> +
> +Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
> +for details.

It was a mistake to originally introduce the anchor "pmd_build_and_test".
You should achieve the same result with the shorter syntax :doc:`build_and_test`

> +
> +#. Running testpmd:
> +
> +   Follow instructions available in the document
> +   :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
> +   to run testpmd.

Do we really need that referencing the same document as above?

> +
> +Limitations or Known issues
> +----------------------------
> +Build with ICC is not supported yet.
> +CRC stripping
> +~~~~~~~~~~~~~~
> +The RNP SoC family NICs strip the CRC for every packets coming into the
> +host interface irrespective of the offload configuration.
> +When You Want To Disable CRC_OFFLOAD The Feature Will Influence The RxCksum Offload
> +VLAN Strip
> +~~~~~~~~~~~
> +For VLAN Strip RNP Just Support CVLAN(0x8100) Type If The Vlan Type Is SVLAN(0X88a8)
> +VLAN Filter Or Strip Will Not Effert For This Packet It Will Bypass To The Host.

Please check the doc contribution guide.
You should add spaces before and after titles.



  reply	other threads:[~2023-08-15 11:10 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-07  2:16 [PATCH v4 0/8] [v4]drivers/net Add Support mucse N10 Pmd Driver Wenbo Cao
2023-08-07  2:16 ` [PATCH v5 1/8] net/rnp: add skeleton Wenbo Cao
2023-08-15 11:10   ` Thomas Monjalon [this message]
2023-08-21  9:32     ` 11
2023-08-30 16:27       ` Thomas Monjalon
2023-08-07  2:16 ` [PATCH v5 2/8] net/rnp: add ethdev probe and remove Wenbo Cao
2023-08-07  2:16 ` [PATCH v5 3/8] net/rnp: add device init and uninit Wenbo Cao
2023-08-07  2:16 ` [PATCH v5 4/8] net/rnp: add mbx basic api feature Wenbo Cao
2023-08-07  2:16 ` [PATCH v5 5/8] net/rnp add reset code for Chip Init process Wenbo Cao
2023-08-07  2:16 ` [PATCH v5 6/8] net/rnp add port info resource init Wenbo Cao
2023-08-07  2:16 ` [PATCH v5 7/8] net/rnp add devargs runtime parsing functions Wenbo Cao
2023-08-07  2:16 ` [PATCH v5 8/8] net/rnp handle device interrupts Wenbo Cao

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=2763426.X9hSmTKtgW@thomas \
    --to=thomas@monjalon.net \
    --cc=andrew.rybchenko@oktetlabs.ru \
    --cc=caowenbo@mucse.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@amd.com \
    --cc=yaojun@mucse.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).