[dpdk-dev] [PATCH] doc: add known igb_uio issue for i40e

[Mcnamara, John]

> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Monday, April 3, 2017 11:40 AM
> To: Yang, Qiming <qiming.yang at intel.com>; dev at dpdk.org; Mcnamara, John
> <john.mcnamara at intel.com>; Thomas Monjalon <thomas.monjalon at 6wind.com>
> Subject: Re: [dpdk-dev] [PATCH] doc: add known igb_uio issue for i40e
> 
> On 3/27/2017 10:16 AM, Qiming Yang wrote:
> > When insmod "igb_uio" with "intr_mode=legacy and test link status
> > interrupt. Since INTx interrupt is not supported by X710/XL710/XXV710,
> > it will cause Input/Output error when reading file descriptor.
> >
> > Signed-off-by: Qiming Yang <qiming.yang at intel.com>
> > ---
> >  doc/guides/nics/i40e.rst | 13 +++++++++++++
> 
> Hi John,
> 
> There are three different "Known Issue" sections in documentations:
> 
> 1) Known Issues document, doc/guides/rel_notes/known_issues.rst
> 2) Release notes, known issues section,
> doc/guides/rel_notes/release_17_05.rst
> 3) Device specific known issues sections, doc/guides/nics/i40e.rst
> 
> 
> This patch updates 3), what is the rule on updating those files?
> 

Hi,

I was going to make a similar comment on the patchset.

Having "known" issues in three places is a good way of keeping them unknown.

Ideally the process should be:
    1. Add new "known" issues into the release notes.
    2. Move these to known_issues.rst after each release.

This is a little too manual, so perhaps known issues should be added directly 
to known_issues.rst under a header for the release they were identified in.
The release notes could contain a link to known_issues.rst.

However, this patch adds a third location, the NIC document. I have some
sympathy for this approach since the NIC docs generally have a limitations
section which is similar to known issues.

If we agree that this is a good approach then we should move all of the NIC
specific issues to the Limitations sections of the NIC docs and include a
section at the start of the "Known Issues" doc to remind users to also
check the NIC specific doc.

However, I think this needs to be co-ordinated and done in one go. So, for 
this release, let's not move the i40e known issues and instead do a general
cleanup and refactoring of the "Known Issues" at the very start of the 17.08
cycle.

Other opinions?

John