[dpdk-dev] [PATCH v1] doc: update release notes for 18.11

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas at monjalon.net]
> Sent: Monday, November 26, 2018 2:53 PM
> To: Mcnamara, John <john.mcnamara at intel.com>
> Cc: dev at dpdk.org; Kovacevic, Marko <marko.kovacevic at intel.com>
> Subject: Re: [dpdk-dev] [PATCH v1] doc: update release notes for 18.11
> 
> Hi John,
> 
> Thanks for the update.
> I have a couple of comments below.
>...
> > Huffman Encoding for the Deflate algorithm.
> >
> > +* **Added NXP CAAM JR PMD.**
> > +
> > +  Added the new caam job ring driver for NXP platforms. See the  "NXP
> > + CAAM JOB RING (caam_jr)" document for more details on this new driver.
> > +
> 
> The CAAM JR is a crypto PMD, so I think it should be listed before Huffman
> Encoding, which is a compression PMD.

Ok. Will change.


> We could also use the syntax :doc: to refer to its guide.

I thought so too (and I made a similar change elsewhere) except I couldn't 
find a doc for it in nics. Now that I know it is a cryptodev I know where to
find it. :-) I'll make the change.


> 
> [...]
> > +* ``AVX-512`` support has been disabled for ``GCC`` builds [1]
> > +because of a
> > +  crash [2]. This can affect ``native`` machine type build targets on
> > +the
> > +  platforms that support ``AVX512F`` like ``Intel Skylake``
> > +processors, and
> > +  can cause a possible performance drop. The immediate workaround is
> > +to use
> > +  ``clang`` compiler on these platforms. The issue has been
> > +identified as a
> > +  GCC defect and reported to the GCC community [3]. Further actions
> > +will be
> > +  taken based on the GCC defect result.
> >
> >    [1]: Commit 8d07c82b239f ("mk: disable gcc AVX512F support")
> >    [2]: https://bugs.dpdk.org/show_bug.cgi?id=97
> 
> The references appear on the same line in HTML. Should we make them a list?

I'll fix this as well.

John