From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Yigit, Ferruh" <ferruh.yigit@intel.com>,
"Yang, Qiming" <qiming.yang@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>,
Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [dpdk-dev] [PATCH] doc: add known igb_uio issue for i40e
Date: Mon, 3 Apr 2017 13:30:29 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE2332AE92D@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <aa79e4b6-ccbd-a369-82c1-83b0863a5714@intel.com>
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Monday, April 3, 2017 11:40 AM
> To: Yang, Qiming <qiming.yang@intel.com>; dev@dpdk.org; Mcnamara, John
> <john.mcnamara@intel.com>; Thomas Monjalon <thomas.monjalon@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@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
next prev parent reply other threads:[~2017-04-03 13:30 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-27 9:16 Qiming Yang
2017-03-30 12:08 ` Wu, Jingjing
2017-04-03 10:40 ` Ferruh Yigit
2017-04-03 13:30 ` Mcnamara, John [this message]
2017-04-13 3:08 ` [dpdk-dev] [PATCH v2] " Qiming Yang
2017-04-14 16:03 ` Mcnamara, John
2017-04-14 16:53 ` Ferruh Yigit
2017-04-19 4:16 ` [dpdk-dev] [PATCH v3] " Qiming Yang
2017-04-19 10:06 ` Ferruh Yigit
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=B27915DBBA3421428155699D51E4CFE2332AE92D@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=qiming.yang@intel.com \
--cc=thomas.monjalon@6wind.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).