Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) client-ip=2620:137:e000::3:2;
Message-ID: <71539687-13cf-405d-bf7c-27480e49e872@intel.com>
Date:   Tue, 10 Oct 2023 17:56:28 -0700
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v12 04/10] x86/resctrl: Add comments on RFTYPE flags
 hierarchy
Content-Language: en-US
To:     Babu Moger <babu.moger@amd.com>, <corbet@lwn.net>,
        <tglx@linutronix.de>, <mingo@redhat.com>, <bp@alien8.de>
CC:     <fenghua.yu@intel.com>, <dave.hansen@linux.intel.com>,
        <x86@kernel.org>, <hpa@zytor.com>, <paulmck@kernel.org>,
        <akpm@linux-foundation.org>, <quic_neeraju@quicinc.com>,
        <rdunlap@infradead.org>, <damien.lemoal@opensource.wdc.com>,
        <songmuchun@bytedance.com>, <peterz@infradead.org>,
        <jpoimboe@kernel.org>, <pbonzini@redhat.com>,
        <chang.seok.bae@intel.com>, <pawan.kumar.gupta@linux.intel.com>,
        <jmattson@google.com>, <daniel.sneddon@linux.intel.com>,
        <sandipan.das@amd.com>, <tony.luck@intel.com>,
        <james.morse@arm.com>, <linux-doc@vger.kernel.org>,
        <linux-kernel@vger.kernel.org>, <bagasdotme@gmail.com>,
        <eranian@google.com>, <christophe.leroy@csgroup.eu>,
        <jarkko@kernel.org>, <adrian.hunter@intel.com>,
        <quic_jiles@quicinc.com>, <peternewman@google.com>
References: <20231010233335.998475-1-babu.moger@amd.com>
 <20231010233335.998475-5-babu.moger@amd.com>
From:   Reinette Chatre <reinette.chatre@intel.com>
In-Reply-To: <20231010233335.998475-5-babu.moger@amd.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?cy9OZ2xJSDJoa2taeXY4bndJWXZJN0hVcWVTcVNqMC9kM0JFNzd1elFiaHJB?=
 =?utf-8?B?dXh3SlV1dmJmaDN4eEVpWEMyNkZZQjlGOWV3Wjc3anEzVWl5dnhvZHNNejcx?=
 =?utf-8?B?Z09lTWF5eERueGU2K1FTMkY0U0lvK3FYR0daZ1pYaVA2UE83VVRpUnFqMlJH?=
 =?utf-8?B?K1IxbnRrMmJZTXdoa0paSlpDSlBKYjN2amdEK28wWGxOSThUZVJBTUthaHc5?=
 =?utf-8?B?cWdSZkYrQW5pVUw0M1plWEphaVpEaCt6L3NzalhiUlZXcGE2R1dvNlNsczF5?=
 =?utf-8?B?T0ZKRVh3bWhJc2RSTWlZL0VRbjBWVlI3M3NRNEtuOXFVbmRaQjZyKzdXd2RL?=
 =?utf-8?B?Nys5eUgxdDZ5QzNISW9aUC9meThYejZ0eDdYOWhtcG5PK2FDWkFQUXlXVG50?=
 =?utf-8?B?Qm54clJLa2JrT1ZYS054UWhOckFSenYzanpBUElBSkYxM0lWNmluVitSWW9D?=
 =?utf-8?B?SVhCRU9KNGNBQlQ2NFJ1cVBtc0lZM0crTmFlUVFhaWJLWGlHby9TeEwrMWRk?=
 =?utf-8?B?RXRzWTlZY1gyTFhmYS9wSHF5YUE5dGJBR0R3eTlJdkhVUEw2SGd1VlFUOG50?=
 =?utf-8?B?Zm5LOGYwWmphd2hnM0Q4T2JRZGcvL09IODA0SjZ0MWg4TU1scmRJRGFEWWlP?=
 =?utf-8?B?WU5kbnpsZWlZcmNuZGcvR2RvaW01bXVsN0FqZ1FDSlF1QUhoYXV2ZkJKMDRR?=
 =?utf-8?B?YXRobkU1QkxKMHJUeVBHTVllN2ZjYlRoTXpvWnExc1NmYnV1aGU2VyswMU5C?=
 =?utf-8?B?ZnZ5R0huYkVvRk1hQ3FYOGtTbFhTM29naVc5Snk0YXNOem9ydlZjNVZ3NGxZ?=
 =?utf-8?B?ZjRtT2VDV1hZbVNST25pazFnbkJLQUJ5eXNoU2hwVjgxU3lwTmZ4b0RhRDA2?=
 =?utf-8?B?c0JNM1UybTNKR3RiQ2Q3dTN3cmQ4NjhkOG55R0E1UThRY0ZiNlF0VjVXcW9i?=
 =?utf-8?B?NXNVb1ZyWTFnZGdHb3BGblRWYUVxMUpFRlNqYitUeHZDK3hhRzhmY1hac0hR?=
 =?utf-8?B?d1FFWUtaVUF5S2pqU2J0QWU4djA0K0JSSEhZbml0dzl2Z0NKQmcwdWpyL3dm?=
 =?utf-8?B?bUlXL1FGSlpOaG5OcnJYSFZ3OTNxeWtRM1Nwa1dGVmdsU21WU0lOZmNnTlBQ?=
 =?utf-8?B?bE94TGVEOEFkczZHUUNJdE1qeVZVU1pSc0RYeGhITTVoRnJKbXBGL3JsME9h?=
 =?utf-8?B?bjRleXdLZXpVcHRaM2d4bzdSeHZLd1VrYTZxQ2RmOFg5NUZicmNHVUdhSEFV?=
 =?utf-8?B?QlRYNWlyeVNDL2I2R1ZUS3RtMnU1WmUyQUcvU1EzTlF4bVdNNHFJbmFyeGVJ?=
 =?utf-8?B?RTdqT2VhVW1lWEFTN2lZODdTQmdsVGlLRHN2WFE4K1VVcUMxMUdIZTZuMDRy?=
 =?utf-8?B?TEVmWFFyV2kxQTBMV3VpNTVPaGVUcWtCKzRienV6Ni9qV09QTnIyWEs1WXJB?=
 =?utf-8?B?d1N0N0E2eGZuakhiQzVxTUxxOEhkMm5uYUhOSllpQTlUMnlTQVZESHRobzgv?=
 =?utf-8?B?empkOWpqbWh6YnNDRm1PTnlXRHhidk9tTUV5TEhOZUNiYmV6Q0tkcjZ0d2lK?=
 =?utf-8?B?R2h4R0R6bDd5NnVVSUtMdnlMUHNqV3VENGxkd1cvNXRlRlRGY2xGNVFXOGNq?=
 =?utf-8?B?aFRjTjVGbUNuYVlaOUVqaUZzdUV6ZlJJbERkY2VjK2lEbWZ1T2lXa2dVS3F6?=
 =?utf-8?B?WlhQNG1XNkxJc3V2VWttSFN3QWxLa2lRVTRHbjd0N25xZ2ZIZUsyV3pYMkNl?=
 =?utf-8?B?SGNZK3FUUCtEbTlzY3g5YmRBdld6K0w1MXJrOHdNejRMVzR2T3poZTlPNVlu?=
 =?utf-8?B?NDhYbkdtMHp0aGdUcDVnNFRMc3A1a25RM2lic2hZUFZHaW9HZE9VTktjUzF2?=
 =?utf-8?B?MW85eVFBczJhWFBZNUFsQWErR0dHekY0S3ZVVUMvcnJjYlJCSUU2SGR2QnVQ?=
 =?utf-8?B?N3g4aWVJYTc3alc0Q0NHdDg3TlR4b0Qwbk5YWlpBRjNGSnJWbE42WndTS0Fh?=
 =?utf-8?B?emVtUUVNTGZpQ0lYOVkxNE51ejZzT0JueDlQaGFkLzV3NSt4cG1rSVV2RmtK?=
 =?utf-8?B?eU9xNzNQY0JOR251Rmx2UnBXeXV4am1kOWROVnNqbE96d3VaWG9DK2lCclhY?=
 =?utf-8?B?QndkK0I1b25zc29hQVZDK2xzRWl6emlWOHprL3hTZS9QMHdUMzhLUFNYNUZG?=
 =?utf-8?B?aHc9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 03991aab-df28-4f92-c201-08dbc9f4e96f
X-MS-Exchange-CrossTenant-AuthSource: SJ2PR11MB7573.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Oct 2023 00:56:33.0407
 (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: t0XO5nAGwaInx2qdiYhagR8+qpnuoNr1OUttBsaU8k/dHaw50l3Hl/hJPFT5s+os6if9pcp8wCYQr0ONd1qJkyk2qTdNlckQA+GQTUWQ7ck=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY1PR11MB8030
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=2.7 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,RCVD_IN_SBL_CSS,SPF_HELO_NONE,SPF_PASS,
	URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on agentk.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (agentk.vger.email [0.0.0.0]); Tue, 10 Oct 2023 17:57:05 -0700 (PDT)
X-Spam-Level: **

Hi Babu,

On 10/10/2023 4:33 PM, Babu Moger wrote:
> resctrl uses RFTYPE flags for creating resctrl directory structure.
> 
> Definitions and directory structures are not documented. Add
> comments to improve the readability and help future additions.
> 
> Signed-off-by: Babu Moger <babu.moger@amd.com>
> Tested-by: Peter Newman <peternewman@google.com>
> Reviewed-by: Peter Newman <peternewman@google.com>
> Tested-by: Tan Shaopeng <tan.shaopeng@jp.fujitsu.com>
> Reviewed-by: Tan Shaopeng <tan.shaopeng@jp.fujitsu.com>
> Reviewed-by: Fenghua Yu <fenghua.yu@intel.com>
> Reviewed-by: Reinette Chatre <reinette.chatre@intel.com>
> Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
> ---
> v12: Moved the comments from arch/x86/kernel/cpu/resctrl/internal.h
>      to Documentation/arch/x86/resctrl.rst. (Boris)
> ---

It seems like you just copied the text to the documentation without
taking into account the destination's use of reST syntax.

I tried a "make htmldocs" to see how this looks but encountered:
docutils.utils.SystemMessage: [snip]/linux/Documentation/arch/x86/resctrl.rst:398: (SEVERE/4) Unexpected section title.

Please remove my Reviewed-by.

Reinette