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: <2a2935e6-ae3c-85d9-a2e9-f42fb4ca7d59@suse.com>
Date:   Mon, 12 Dec 2022 14:27:46 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.2.2
Subject: Re: [PATCH] USB: drop misleading usb_set_intfdata() kernel doc
Content-Language: en-US
To:     Johan Hovold <johan@kernel.org>, Oliver Neukum <oneukum@suse.com>
Cc:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Vincent Mailhol <mailhol.vincent@wanadoo.fr>,
        linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20221211120626.12210-1-johan@kernel.org>
 <efca6b26-fb20-ae38-0fc4-8612f1ee150b@suse.com>
 <Y5cDBSZrgC2TUnXs@hovoldconsulting.com>
 <4cf7bce3-dfbb-b064-9d91-27616bf11d6a@suse.com>
 <Y5cpH8aV7aox2Pbd@hovoldconsulting.com>
From:   Oliver Neukum <oneukum@suse.com>
In-Reply-To: <Y5cpH8aV7aox2Pbd@hovoldconsulting.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?REx1dFBGUDB1VDI2SlpKd3dlcjZVMTRLNkRwOTg2NitTQWFaQzY4clVnRXdN?=
 =?utf-8?B?Vk1FRWRtQ0ZicDNOVUhldVQ0MWdPMGZiM1M4ODhjQTd2V01Xa3phV2wxMzJP?=
 =?utf-8?B?cW5BNjFxLzAxWHBVL2JKRmx4WEIyOWxzVEVLMnpQcFdjY2pPMlBjYmRUT1ZT?=
 =?utf-8?B?NnRlb3RVU2ZJZ1E1bzlqYzBRWG1hdTQ3N3dOUk8wWUxhdFVBRm5pcG1OU0Vu?=
 =?utf-8?B?QmpmTGlSRGVFQWdtTUE2OXBmZ0poR0U5T2VaY2JzZUF6YzRqSXExNDc2RE94?=
 =?utf-8?B?VVVVRUxkNkVTQjlDeXZ3MXpBRHRURDhvTXFwYUJiamo2NU5JcDhvcW1JOE5w?=
 =?utf-8?B?ODc5KzlTRm9lek53bnlWNDN1N1BpMzJCdGYrWGVFT2hWcVF4UkRpSlV0K3Ji?=
 =?utf-8?B?RDR2V01hY2hwRWNoNVBwSU9oaE1KNnRLUnFEQlRMeU5abUZOcCsvZzVHSHF4?=
 =?utf-8?B?MVNoUU43ZW5iMlBXTGFxUGptSmdhdHd0U1M3SyswZEdURmdBc0l4MVpuei84?=
 =?utf-8?B?VTdZNEhhVmZkTCtObWxuK0ljWjZYQTRsOENkUCtwWGJMK3p3T053N0F0dmIz?=
 =?utf-8?B?Y2M3SHBBWlloakViVnZ0Rkhrcmt3T3dVdkNoVitKby9qRU5VWVdVcTN0eDZo?=
 =?utf-8?B?ekpvQjFMb2dEY3NTUW5zenZuejZSOXU5K2VCd0NNb1N2SmI5MWFMN3N2c2tt?=
 =?utf-8?B?UUhqYlJWb3BKRGNwYmdrVURUU1pWeHJKRnVkaFdTUUhqZ1pwTElWb0VBOEFI?=
 =?utf-8?B?T21QRm9uS3dUTWdtcDRtaGJYS2ovZzd3UW9FNi8wU25vMlkwMUk1SEM1L3ph?=
 =?utf-8?B?anUwemdTNjZtQVYvSWt6S3RuWTVSdTg4Y2RrR0F1Q3V6blNieXlVWWxZa1M2?=
 =?utf-8?B?U0VvcHpJZXMzcC9CMm95amRGeWxITE5YZFNGWmNoenRNQWJDL0RnSXpXbUtK?=
 =?utf-8?B?alRSOVlkQUlXa0xJYzhCZXlIcEYwTThPdW0xbEpPQ1Z6UWpmSUJlUnpRSS8v?=
 =?utf-8?B?Vk5ONzdtQkVzUkdtYmQ0OUUzRzZYdUtsaHhzaVZ0UDFKbzNUZzlEZ3U1Mi83?=
 =?utf-8?B?UVhBMWkyMzhZTEd5TDlML0V0NTNFNWphMldOS0VFRTN5QjRwNDJHWkxRVVJo?=
 =?utf-8?B?eGNwTUptanNpQ1gvVHFjN25BUXo4R1ZIZXBaOUJDS2IyWksrMVltVmFVR2Nk?=
 =?utf-8?B?WUpreHlrcDNVYlJmOTdQeHVoOG5udzI3SHJGU1p2UGptOHN3OHBBUjNZTUpi?=
 =?utf-8?B?U2xhTnFwc1gwRlYwVjkyandnVWxBOWxlOG53MjBVSEtaZTU0WUY0OWJhT09x?=
 =?utf-8?B?NTNyVk1KS2xBQjhhVmNZbmNSNTQxY1pkWGd6SzAvWHN2ZjQyK1l3RXVMbnlI?=
 =?utf-8?B?OFpXalZzMmQyMm9Da3RGUm8yS0Fvdks0dDJnaU84eXRDd2tidVoreVpTU1lZ?=
 =?utf-8?B?NktuVW1BVmZMSk03SGoxWWp4QytSRFllaWMvbFB1Sk5PQnFhdVNEV09zbDEz?=
 =?utf-8?B?MXVWRmZUTDVVeGEybFpuYkpXbFk4dHVqNGJCR0IxUXBiVlMyZm9BOGpFdmZa?=
 =?utf-8?B?dWQ2M2FqM0dJeFdYaFZ2QjFWaTRrMTFDUzN3SG56MFpxNjQ3ekoyNGxxN201?=
 =?utf-8?B?eW9qZTJ0eXJOdml0cmNlOFNvZlVzR0ozMkxYSm9tNllxREVDaEcvditldlN2?=
 =?utf-8?B?cG1EUDB3SGg3bzI1RkZGdkpidHB4VDdRMUJpK05US0VxY0hYbVFNOXJlaTlo?=
 =?utf-8?B?SWpYWnA5aXFkQjU5eEZiZTc5cWNjSmhwMjRyY1VWVnlTWit4eWVIdWN3ZHZT?=
 =?utf-8?B?MTJ5cDhsM0xleXY0TmhkSzZsZ2NVVmR2bVloRTh4L1hkcmEwT1VVdFkvbGI3?=
 =?utf-8?B?azFsakRaazZuTDFZS25xeGE0WUl4TCs3aDVwVjJ0aFBNd0UvZWRheW9uaVdJ?=
 =?utf-8?B?L1ZRT3d1dTNzWDdmdlF3RjNCYlY2M3BjMkRkcGRJbXUzYy9NbVZSRk04bG1p?=
 =?utf-8?B?R1dmQXNYc2FDNXp2b3plZ1JiVlM2c0V2TVI3UG41UkJieGI0cmRCWUhkQXN6?=
 =?utf-8?B?ZTlVYXdPdFJ3SWJlb2lXSk1kM2p1MGl2K2t1SVRJdFR1ZTBESU1PcHpqU01C?=
 =?utf-8?B?SVlpbDUrN2dlNWVFMkRpdzlMbTYreUhpT2IwOUZCQnJzTkkvSXBBd0xGcDlB?=
 =?utf-8?Q?LpCwp1+iCIxHdSfMxRVGDZt3/e56SvvyeucI/w5cvNXu?=
X-OriginatorOrg: suse.com
X-MS-Exchange-CrossTenant-Network-Message-Id: f999afce-202d-4b6b-2587-08dadc44a97c
X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB7104.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Dec 2022 13:27:48.6968
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: f7a17af6-1c5c-4a36-aa8b-f5be247aa4ba
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: G0M80SFh2CqzYqJVnC7lup/Qu2HG/yuoiHNgODCXAG3gkLI2gVFcgY5XalNgjaPyQ312E4umGFdO/2l5xgeB2w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DBAPR04MB7383
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS 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


On 12.12.22 14:14, Johan Hovold wrote:
> On Mon, Dec 12, 2022 at 12:13:54PM +0100, Oliver Neukum wrote:

>> 1. that the function exists and its purpose
> 
> That should be apparent from the function name (and implementation).
> 
>> 2. its parameters
> 
> Apparent from the prototype.
> 
> But sure, it would not show up in generated documentation (like many
> other functions).

purpose, yes. existence, no.

> it seems. Not sure how much value there is in that, though.

I am afraid there is no consensus answer to that question.
  
> And in this case there was also no kernel doc for usb_get_intfdata()
> which is equally self documenting. Why add redundant docs for only one
> of these functions?

Because knowing that one of them exists makes the other much more
obvious.

> I'd rather drop this particular documentation which was added due to a
> misunderstanding then go down the rabbit hole of adding mindless kernel
> doc to every helper we have.

Yes, but those are not the alternatives.
Removing the perfectly good part of the kerneldoc is a needless regression,
albeit a minor one.

> Yes. The (device group) attributes are removed by driver core before
> ->remove() is called, otherwise you'd have an even bigger issue with the
> driver data itself which is typically deallocated before the pointer is

So what happens if user space calls read() or write() on an existing fd?
Sorry, but this is an issue we need to be sure about.

	Regards
		Oliver