Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <65927b26-9f0e-7a82-a150-6459b5477a92@intel.com>
Date:   Thu, 12 Jan 2023 09:30:47 -0800
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Firefox/102.0 Thunderbird/102.6.1
Subject: Re: [PATCH v11 13/13] Documentation/x86: Update resctrl.rst for new
 features
Content-Language: en-US
To:     "Moger, Babu" <Babu.Moger@amd.com>,
        "corbet@lwn.net" <corbet@lwn.net>,
        "tglx@linutronix.de" <tglx@linutronix.de>,
        "mingo@redhat.com" <mingo@redhat.com>,
        "bp@alien8.de" <bp@alien8.de>
CC:     "fenghua.yu@intel.com" <fenghua.yu@intel.com>,
        "dave.hansen@linux.intel.com" <dave.hansen@linux.intel.com>,
        "x86@kernel.org" <x86@kernel.org>, "hpa@zytor.com" <hpa@zytor.com>,
        "paulmck@kernel.org" <paulmck@kernel.org>,
        "akpm@linux-foundation.org" <akpm@linux-foundation.org>,
        "quic_neeraju@quicinc.com" <quic_neeraju@quicinc.com>,
        "rdunlap@infradead.org" <rdunlap@infradead.org>,
        "damien.lemoal@opensource.wdc.com" <damien.lemoal@opensource.wdc.com>,
        "songmuchun@bytedance.com" <songmuchun@bytedance.com>,
        "peterz@infradead.org" <peterz@infradead.org>,
        "jpoimboe@kernel.org" <jpoimboe@kernel.org>,
        "pbonzini@redhat.com" <pbonzini@redhat.com>,
        "chang.seok.bae@intel.com" <chang.seok.bae@intel.com>,
        "pawan.kumar.gupta@linux.intel.com" 
        <pawan.kumar.gupta@linux.intel.com>,
        "jmattson@google.com" <jmattson@google.com>,
        "daniel.sneddon@linux.intel.com" <daniel.sneddon@linux.intel.com>,
        "Das1, Sandipan" <Sandipan.Das@amd.com>,
        "tony.luck@intel.com" <tony.luck@intel.com>,
        "james.morse@arm.com" <james.morse@arm.com>,
        "linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "bagasdotme@gmail.com" <bagasdotme@gmail.com>,
        "eranian@google.com" <eranian@google.com>,
        "christophe.leroy@csgroup.eu" <christophe.leroy@csgroup.eu>,
        "jarkko@kernel.org" <jarkko@kernel.org>,
        "adrian.hunter@intel.com" <adrian.hunter@intel.com>,
        "quic_jiles@quicinc.com" <quic_jiles@quicinc.com>,
        "peternewman@google.com" <peternewman@google.com>
References: <20230109164405.569714-1-babu.moger@amd.com>
 <20230109164405.569714-14-babu.moger@amd.com>
 <c7d563ce-13d9-ca6b-a5c9-7e08a3cdc3a9@intel.com>
 <MW3PR12MB45538E045D655C1D6B3BD02C95FC9@MW3PR12MB4553.namprd12.prod.outlook.com>
 <812a0d4d-dfb9-d351-9c9d-01d6943cd72b@intel.com>
 <MW3PR12MB45534504C044EBAEABA9E9E295FD9@MW3PR12MB4553.namprd12.prod.outlook.com>
From:   Reinette Chatre <reinette.chatre@intel.com>
In-Reply-To: <MW3PR12MB45534504C044EBAEABA9E9E295FD9@MW3PR12MB4553.namprd12.prod.outlook.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?TWkyU21RanpFOXNiV0NnS3NZSlU1eFdDYnhjWGp5MjR0b3EvY1lwb2J1S0J2?=
 =?utf-8?B?akxQS1BmQm9ycitBQWxxNlVmVzRxSGxCdlVtMmRJUHhubmFJNk1HdW42Z29P?=
 =?utf-8?B?TTFtQXNWMVVnVEVjZjZWeUZMbFZhRzVJVGpUOGZ6K0g5U0tQaFFEQkZtRzh5?=
 =?utf-8?B?VnNranV4SUhYaXR3VG5LR1A0NXAydlZFVks1bmxLLy9KMG1wbXlGTW05Q3Zq?=
 =?utf-8?B?cFd5SkZGczRNbW9KUzhqcUpKUUgvTnNSb2thakxmcTZ0ZkdWSGtGMVFFZzBt?=
 =?utf-8?B?WlpnZXhGODI0RVlhRFhMZlpPZnZGdHE1QlBuUlhZZlhLcGpPVDJ3eTNlRlFu?=
 =?utf-8?B?bGNXZlRMTjhJUjBHU0dSTy9yODM3NVdvOWVNV3cra0RGZlkzQmUxVnppNWtP?=
 =?utf-8?B?S1NGcVBZSEwxR3NnSzIzVDY5ZGpXQVhlWGgzYzJHQk1oYXVxbkR4ajR2dmdT?=
 =?utf-8?B?RlNWaGk2bFA1TmtaVmRheThZUmw2ajlzMEFRWmc0Qm5XRUdNbEFpcEFyenVr?=
 =?utf-8?B?NFgzYkhyblVJRjl5dVdFNllMZlF6US83WW9HY0owQkpOaTJuQnZKV210eEhQ?=
 =?utf-8?B?TnFoQUhVZnlRbUxmb1NFbEFxZ1JEMzVrRWltNWZIa1VaZnFHRS92S3MxMk9P?=
 =?utf-8?B?WWR5Wm95aTVvYll2REpvdzFjYjFUekMyU3JKSiszdHl5T0l5WmRPWEtZRjN4?=
 =?utf-8?B?UVhkOEhwb1pvQ1RoRXR6d0xSVkM0OTB6aHBid3VKQ0VSVnN4bUt3UnNHbDFI?=
 =?utf-8?B?ZWl3bzNTQVEzMjZsNjVYNHc0RFFqOE5XR21rcVJQYkpDbmxlb083L0hGeWZv?=
 =?utf-8?B?SGJwb2RtckNBeWhZMk5JVExPK1ZIdzNvNGMzSzdMSnZIK28wMnczNWdzV0pt?=
 =?utf-8?B?SlI3RzhPWDdWY014ai9VcGFvalkwTXdJVkNpUFhXd0ZPWG1BQ2ZTWDVaMlpF?=
 =?utf-8?B?L0Q2WUVjQk5GenhET1JpWXkzWkxGcDludFFoY2JvbXlSSWdxeXRjdFgxK2li?=
 =?utf-8?B?K0hIUGNJK2xnQk1qdk9QZ2ZUTndFZlhUdjlwUk1HZUtST0lVMnlGeUs5RlNO?=
 =?utf-8?B?cjE4eGZmbkNOTnBOalkya0FzaE9PRzFaeHcxa3J4LytqUVJRdEtUYTQ3UXA0?=
 =?utf-8?B?MGhMNWk5dnFFNVlWcE9HWGt2N09YQnBqS2pVODNNN2pPcENkSEQwRWFMZGFS?=
 =?utf-8?B?bnRLMnd0WEQxdjVERVU1Tm9TcjRDVGdpTlM1cXhFT0xTc1VOWTFjV1UwRU1j?=
 =?utf-8?B?QUtqd2JsYnk2RDR6R3NqRDhoODlWOS9EcDNuU3JXcTBPRkpJWWJFZlBZUHdS?=
 =?utf-8?B?LzBLdGttN3hMaDNKY1J4UDVBUWcyUGIxeXRHcnBvOGJCZmpyR2JIQ214YUth?=
 =?utf-8?B?Yjh3dXFWS2VFYXhVM0NkdCtSUUt6blkwUXhKQnYvRmhxbi8reEx2emhtTGVQ?=
 =?utf-8?B?enFXb1BWMUc3YXFTZ0xUWFZZdzQ4dC8vVnBTRXV2Q0NFR0xvRGplZjFwUCsx?=
 =?utf-8?B?NUE4ZXVSU0FmR1lYVGlPUkovZjJmU25DbXFJTk5kaHJyclZHcU1oK3VhN2Jv?=
 =?utf-8?B?a1dlU1JvMUE1NytaM005SWZweGlWU3NwYXYxdjVxOFVGUWd2RERkODBKT2h6?=
 =?utf-8?B?dC9PNnd2a1c5VnQzclNsUDNSYzdwZnRIYjVDMjZPQXVWaS9GbkxMQnhISTRI?=
 =?utf-8?B?ekZWaS8xSm11VzRLTkozRVpvamRiTHRVNTVHcHV3WHlMbm5NWUhqRWxmOVcx?=
 =?utf-8?B?d0dQOFBNekFocTNBNGozMjllWjBSQUlOVGtkeDFkTVUyb2ltZXYzZXBkOUg4?=
 =?utf-8?B?NG9QS3MveUFhdzlIUHpDbU8rMHZpM09VUkZKRFJyQ1NxNXdpanFzWW9vNjZZ?=
 =?utf-8?B?SkxUMDdlRXpLYW1HbklFMElnQzNoRUYrbnF1RWF5OGRVa1RldmxqVGFtTC9q?=
 =?utf-8?B?UlI2WlNXYUl4WTFQdFMwaXg3bkxiNlZqU1RVQU0xQy9rZTYxMExmK0lkaG95?=
 =?utf-8?B?aWkyR1Rva3ZyZWpwWkNtQlhXUEZweURVS0JUYStSaloxbFRhaU1KcmcyZGh5?=
 =?utf-8?B?OFhtMlZROStuQlY3c2lhbnhuTzU5QVYxeURIdHZpVTJlVE9rMnQzZUlTMS9i?=
 =?utf-8?B?SzZCNjVwQ25xc0RTYnV4VG11SEZFbnRVOGFHQTRkaElFdlAweHF1ZmhtVG83?=
 =?utf-8?B?OUE9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 4b4bf116-8695-4bb9-6f88-08daf4c2c09c
X-MS-Exchange-CrossTenant-AuthSource: CY4PR11MB1862.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Jan 2023 17:30:52.1175
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: CHYvtib6wAdMkNBDUT93EnHLDYKHzM51wpRRaxWMP0AO2RE7wY157yDNXnRo9su9RXO0PrO9Hlfq70D88T+nZTzwo4DL02naTUiKXH4OqN8=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR11MB6767
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,
        RCVD_IN_DNSWL_MED,SPF_HELO_NONE,SPF_NONE autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hi Babu,

On 1/11/2023 4:47 PM, Moger, Babu wrote:
 
> diff --git a/Documentation/x86/resctrl.rst b/Documentation/x86/resctrl.rst
> index 2860856f4463..7df5889237f4 100644
> --- a/Documentation/x86/resctrl.rst
> +++ b/Documentation/x86/resctrl.rst
> @@ -24,10 +24,15 @@ CDP (Code and Data Prioritization)          "cdp_l3", "cdp_l2"
>  CQM (Cache QoS Monitoring)                     "cqm_llc", "cqm_occup_llc"
>  MBM (Memory Bandwidth Monitoring)              "cqm_mbm_total", "cqm_mbm_local"
>  MBA (Memory Bandwidth Allocation)              "mba"
> -SMBA (Slow Memory Bandwidth Allocation)         "smba"
> -BMEC (Bandwidth Monitoring Event Configuration) "bmec"
> +SMBA (Slow Memory Bandwidth Allocation)         ""
> +BMEC (Bandwidth Monitoring Event Configuration) ""
>  ===============================================        ================================
> 
> +Historically, new features were made visible by default in /proc/cpuinfo. This
> +resulted in the feature flags becoming hard to parse by the humans. Adding a new
> +flag to /proc/cpuinfo should be avoided if user space can obtain information
> +about the feature from resctrl's info directory.
> +

Could you please replace "parse by the humans" with "parse by humans"?

The rest looks good to me.

Could you please do a sanity check by building the documentation to ensure
that the usage of the empty quotes looks as expected and is not parsed out by a
tool when, for example, creating the html docs?

>  To use the feature mount the file system::
> 
>   # mount -t resctrl resctrl [-o cdp[,cdpl2][,mba_MBps]] /sys/fs/resctrl

Thank you very much

Reinette