Hi Thomas, Thanks for your useful advice, previously only focused on code format and Ignored document format.
Regards Wenbo > -----Original Message----- > From: Thomas Monjalon <tho...@monjalon.net> > Sent: 2023年8月15日 19:11 > To: Wenbo Cao <caowe...@mucse.com> > Cc: dev@dpdk.org; ferruh.yi...@amd.com; andrew.rybche...@oktetlabs.ru; > yao...@mucse.com > Subject: Re: [PATCH v5 1/8] net/rnp: add skeleton > > 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. Thanks for your kindly comment, the format of document I must lake of this knowledge > > > + > > +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? For this block, there's really no need to add this. Previous ideas I want to add new content as the subsequent code is submitted. Do I need to add full features and NIC Description at the first code commit ? > > > + > > +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. Yes this is my fault, :) , I have read the document and known that Add 2 blank lines before each section header. Add 1 blank line after each section header. > >
