Re: [PATCH v2 1/2] Documentation: x86: Rename resctrl_ui.rst and add two errata to the file

[Randy Dunlap]

On 10/12/20 7:46 PM, Fenghua Yu wrote:
> Intel Memory Bandwidth Monitoring (MBM) counters may report system
> memory bandwidth incorrectly on some Intel processors. The errata are
> reported in erratum SKX99 [1], erratum BDF102 [2] and RDT reference
> manual [3].
> 
> To work around the errata, MBM total and local readings are corrected
> using a correction factor table.
> 
> Since the correction factor table is not publicly documented anywhere,
> the table and the errata are documented in Documentation/x86/resctrl.rst
> for future reference. The resctrl.rst file is renamed from
> Documentation/x86/resctrl_ui.rst because the file won't contain user
> interface only anymore.
> 
> 1. Erratum SKX99 in Intel Xeon Processor Scalable Family Specification
>    Update:
> http://web.archive.org/web/20200716124958/https://www.intel.com/content/www/us/en/processors/xeon/scalable/xeon-scalable-spec-update.html
> 2. Erratum BDF102 in Intel Xeon E5-2600 v4 Processor Product Family
>    Specification Update:
> http://web.archive.org/web/20191125200531/https://www.intel.com/content/dam/www/public/us/en/documents/specification-updates/xeon-e5-v4-spec-update.pdf
> 3. The errata in Intel Resource Director Technology (Intel RDT) on 2nd
>    Generation Intel Xeon Scalable Processors Reference Manual:
> https://software.intel.com/content/www/us/en/develop/articles/intel-resource-director-technology-rdt-reference-manual.html
> 
> Suggested-by: Borislav Petkov <bp@xxxxxxxxx>
> Signed-off-by: Fenghua Yu <fenghua.yu@xxxxxxxxx>
> ---
> Change Log:
> v2:
> - Document the correction factor table and errata in resctrl.rst (Boris).
> - Change the documentation URLs to stable archive.org (Tony).
> 
>  Documentation/conf.py                         |  2 +-
>  Documentation/x86/index.rst                   |  2 +-
>  .../x86/{resctrl_ui.rst => resctrl.rst}       | 82 +++++++++++++++++++
>  3 files changed, 84 insertions(+), 2 deletions(-)
>  rename Documentation/x86/{resctrl_ui.rst => resctrl.rst} (92%)
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index c503188880d9..b5b2be8eec22 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -36,7 +36,7 @@ needs_sphinx = '1.3'
>  # Add any Sphinx extension module names here, as strings. They can be
>  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
>  # ones.
> -extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain',
> +extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include',
>                'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
>                'maintainers_include', 'sphinx.ext.autosectionlabel' ]

Hi,
I don't see this change described in the patch description.
Should it be here?

thanks.
-- 
~Randy