Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) client-ip=2620:137:e000::3:3;
Message-ID: <24af5965-3fe9-4aca-83e0-5981f721253f@intel.com>
Date:   Tue, 10 Oct 2023 07:25:44 -0700
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] x86/intel_rdt/cqm: fix kernel-doc warnings
Content-Language: en-US
From:   Reinette Chatre <reinette.chatre@intel.com>
To:     Randy Dunlap <rdunlap@infradead.org>,
        <linux-kernel@vger.kernel.org>
CC:     kernel test robot <lkp@intel.com>,
        Vikas Shivappa <vikas.shivappa@linux.intel.com>,
        Tony Luck <tony.luck@intel.com>,
        "Thomas Gleixner" <tglx@linutronix.de>,
        Fenghua Yu <fenghua.yu@intel.com>,
        Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
        Dave Hansen <dave.hansen@linux.intel.com>, <x86@kernel.org>
References: <20231006235132.16227-1-rdunlap@infradead.org>
 <5589e93d-9a9c-4199-a187-ab60fb127236@intel.com>
In-Reply-To: <5589e93d-9a9c-4199-a187-ab60fb127236@intel.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?ZEQ5UnAvaittdEI3UzdOaWY4TENJV0pVcDJwbWszOUFyY0RydkY3NlNMd3Bi?=
 =?utf-8?B?dHFQQTBhdk1YelNmekFvakhUZEp3cGZJYVBiTGhsTXkyTUpwNzlYbi9oaTky?=
 =?utf-8?B?bzJLOWhFZWY3M3BDSnFiNTdzM0xlN0lIRDY2bzNya05uRHlCY3dmNWpGUzRm?=
 =?utf-8?B?T3NJOGI0b01WSzNkVGpqdGxjRzNhU2JXSm5MMmdqbCsvQmdHVzBlVU9nMHNG?=
 =?utf-8?B?eWJScDhYNEFWNXN4SzdIZ25kMVBqZVNXQzVDOWt0T0RUSWJvaVkzb2JJenRX?=
 =?utf-8?B?bnRyUU5jR2tNTmxoK0grUXdJMEhNMWN1ampwM2VkbnhHaWJncnpPQzdaQ3lT?=
 =?utf-8?B?V0FJNkF0NlRiRUJtM1V1cEVmL0Y2Szd4Nmlqekw5cEU0QWh6OUtxTDlpZTlx?=
 =?utf-8?B?clc2cVZOV2R6Z2hDNDR3a3R6OWN3UjBmNURQVlNNVHREZE40OFFnYzZtY0c1?=
 =?utf-8?B?eEpjVUJQTWJmZ0dPUFRlcWZQSytyK2lxMGY5VVpWMWVUS1doRDlCa0JHeHJq?=
 =?utf-8?B?am4xYy83Mm1aWlBzTzVJeWxtcVYyYmtPcFFlYmJrQ0ExZTdwWGt5UXZCcmZh?=
 =?utf-8?B?NTJjZkFYY1FFZ3o0NjM5NFFmUmxUcjRCY0c3QVRFa2dwYTJuMktWaUFGRnZ0?=
 =?utf-8?B?V3h2b2JRK01WR2l3TnNoTnN6Qmd4SGREZDJDU1VLQjdLdmt0S1JqWWxoZGFC?=
 =?utf-8?B?MFYyRUhFYVdWTWdweExPaWwvZ0N1c2JrODdUYVQrMzZaQWszbXdVYlZnZXlr?=
 =?utf-8?B?YnVCZi9NdFA0azRyN0MzRUJSYTlOeE52cEdjbjV5UVRQTm9FSjdud3VXYU9W?=
 =?utf-8?B?NVV5amFHdGRXQlgrVzNJeElBaklmazdBUEVoL3g1VTFZVTB0RUZNR1hXOTl3?=
 =?utf-8?B?ZW5vRzB5MTkycGEvNnRQUVdYaXRpckZubnZkcS8vSUpMbkFzSUh0Z3BxTUJk?=
 =?utf-8?B?UlFwRGtLVE5GQzRXZnhEM1g2b0JjbThHdytleWNKOGc2UGorckRGVVBuQTJB?=
 =?utf-8?B?VHE1TjBDOXgrek5uS2h4ZHEwdVlDbXRxOHpybUpUZDFuZ3RNeEhOczZHWXc0?=
 =?utf-8?B?Y1c1SGViS01SZ0NXRG9JOS9CUnBUTU4xM3VQcjBFN1dzY1dWMzZxendlNXVk?=
 =?utf-8?B?b25wZW1qd01hVERjai83dEpiaFpLQ0FCSklTTXZHNlVNSktETnFqU3NidDBL?=
 =?utf-8?B?RGFPSFJtTEdsdFZVMGljR0xVYVBrSHEwVG9MNkkvNFg2OU5IdHdmTUpPbTNm?=
 =?utf-8?B?NUpKc2djSkMycDU1YjhwY053QzNoK3NOaWxzOWVsRWVMZDJkeS96TDhkQ1Ur?=
 =?utf-8?B?ajl1NG1jaURGTkVQKzBHcmdNR0EzNHZtZUJWM015cFYzUUd4LzBUQjdDQm1X?=
 =?utf-8?B?UEd1NDdvTFRmYys0TzFaZHpUR3ZUSDJnR3lWNjU4OGIwWGIwQnhvNW8xQ2VE?=
 =?utf-8?B?Mnh1VTVwRVJiSkNOendUbGdMU285aFZ2OWE0VkYzTnpKU00zYUdGNHdJNnJW?=
 =?utf-8?B?NFp1N214MnJCS3FTZTZoQkVxMDA3MWtBa3NPL0I5QUYvM0FPb2N3YzdJMk0x?=
 =?utf-8?B?TTBneVZuUFk3MElaT0lIbzFCY2xMR0dlT0gvcVVKVk0rWDZsY1dYMVpuWmZE?=
 =?utf-8?B?U2pXdkQ4eGh5cUxBZGIvUHFjWmF6NHpHQ2VRS0FUWGxDUkxJaXVkeUFKL0Ra?=
 =?utf-8?B?TW5LQU5LRU1rRTZMMEtFUUdXUnF5TWg1SzNJSTVuaC9TQU5Ma2hLeWxKWXg3?=
 =?utf-8?B?UHBWNWRUZDlSTHBNSWYxRk51bjRUTXBYWU4vcFdLUUZ4akoraCtZM1ltQUhZ?=
 =?utf-8?B?MjI4QVJVWldXUEx3QjEyVVI4WXRwbG5NQUlKTldqQkd4T0pKbUFkc3g1UzZD?=
 =?utf-8?B?SC8wbEFpNk9RaWhBOG1vM0pRWTlDYjJTenVTd2owTWdGWEg0UFdjUXNZTGdZ?=
 =?utf-8?B?MG9MWGZqMWcwUkNxMU0ybUdCYnJ2M1hVbUl3d2E3Y2xCVTRpdXAwN254MTVj?=
 =?utf-8?B?UjVnUnA1eU91Z2QvTTZaeExEVG1vZ3BLM0w4VkhRUkZNZFgyWFhxUDJCK1Nz?=
 =?utf-8?B?eDRCbDBUSldwbG02VDhVUU9SZWFpdmRaM2hNS0tFNTVoemJ2UWxLbklRMHZI?=
 =?utf-8?B?SGo5eUR5OE9xVllUdmZ2WTgwK3dJWHdjV0NUbTlyZXN5OTBtaDlHTmljTnMv?=
 =?utf-8?B?V3c9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: cb79785a-8356-44ab-c54b-08dbc99ccb99
X-MS-Exchange-CrossTenant-AuthSource: SJ2PR11MB7573.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 10 Oct 2023 14:25:47.2557
 (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: Cn1RRYytffNwhonxpBRUmX0Z5VTibhQiP5oCEz+NrBFf5FmCB6RwGDjvmOCo2DNJlaevLYxpThGklXdEvA/mpJB+DBzS7m6eFkVVLkhVMQA=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO6PR11MB5633
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 autolearn=no
	autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lipwig.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 (lipwig.vger.email [0.0.0.0]); Tue, 10 Oct 2023 07:26:07 -0700 (PDT)
X-Spam-Level: **

Hi Randy,

On 10/9/2023 10:07 AM, Reinette Chatre wrote:
> On 10/6/2023 4:51 PM, Randy Dunlap wrote:
>>
>> We don't have a syntax for documenting individual data items via
>> kernel-doc, so remove the "/**" kernel-doc markers and add a hyphen
>> for consistency.
>>

I've been thinking more about this change and I would also
like to propose that you do not use "We" in the commit message.
I understand that you are not impersonating code but I think it
would be simpler to avoid any potential controversy by not using
"We". Perhaps something like "There is no syntax for documenting ...".

Reinette