From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 7BAF8C4707B for ; Thu, 18 Jan 2024 15:44:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: Content-Type:In-Reply-To:From:References:CC:To:Subject:MIME-Version:Date: Message-ID:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=+ZVAgZga1ii+/Sn5ORFdOSTTD7OrfCcFwm/OpdMmb8Y=; b=TrIfTntL8XdMwPKQQxvBiptuL3 cCZ2r3iWYebNfCt4RnbukHyCUHiiuPkCfhEybSvaqFxmxPSK/nQgqtkMIZSXB675vuwRfrSL6hdGP C9rc48VsYhSjTBRc7+zJfgYXQ/pARDWrZSpTJG+cktpqcgJUAA/KsCGVoEshCChMQ/lyK9w6xtU4L FGsmQEmZJyWmaZYLP/MvcsA2MnyV5FIMr9LQyKWkgnhFr9zCdrm4lZS/qgmK020GCz8pjsRziJY3h kSprxzvLLlYtv529GePVtLfXI7C2te8v8GFkhHwVLVZxeD/oTzgbYuUYWqVqxehIHWKOdNeJNRryn 6RthyDHw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rQUZ2-0038iS-0n; Thu, 18 Jan 2024 15:44:20 +0000 Received: from mx0a-0031df01.pphosted.com ([205.220.168.131]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1rQUZ0-0038h8-0S for ath11k@lists.infradead.org; Thu, 18 Jan 2024 15:44:19 +0000 Received: from pps.filterd (m0279863.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id 40IF0EDN015329; Thu, 18 Jan 2024 15:44:12 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h= message-id:date:mime-version:subject:to:cc:references:from :in-reply-to:content-type:content-transfer-encoding; s= qcppdkim1; bh=+ZVAgZga1ii+/Sn5ORFdOSTTD7OrfCcFwm/OpdMmb8Y=; b=Ch k0Y6eWiXMr2eCVZwWihw+4wX6E3jXZZmfQ+kXvZtcBXezznGdbAcmqNNabjgaB5T f3MPs/IYmHZqrkZ4mNG6eX6bHE4amI8NhrEMTFmMnlY8uS/kjH1Ok61xVs5ERBLl /MxblLxd5V755MfpDmDggpKXj1a5DK6xCGgqLmwYJe/lbp+WdTVR6hHw4v1tMohW TzVz40k0eWrf+FppwtngLGqbwqXJBOx6cCvMEqnm68lcqd+JKroZdJninCG74+PW cd4TbU9eG/w/IQzXEzEWHb5fsPjvVO5scEd4Nebi8U7v0BnMwRIoMWWEKN3IKDI8 OnE6s+T3iCRUNGLg2rRw== Received: from nalasppmta02.qualcomm.com (Global_NAT1.qualcomm.com [129.46.96.20]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3vq5qrg65s-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 18 Jan 2024 15:44:12 +0000 (GMT) Received: from nalasex01a.na.qualcomm.com (nalasex01a.na.qualcomm.com [10.47.209.196]) by NALASPPMTA02.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 40IFiBbb020942 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 18 Jan 2024 15:44:11 GMT Received: from [10.110.99.42] (10.80.80.8) by nalasex01a.na.qualcomm.com (10.47.209.196) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1118.40; Thu, 18 Jan 2024 07:44:11 -0800 Message-ID: Date: Thu, 18 Jan 2024 07:44:10 -0800 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH] wifi: ath11k: document HAL_RX_BUF_RBM_SW4_BM Content-Language: en-US To: Kalle Valo CC: , , References: <20240111-document-hal_rx_buf_rbm_sw4_bm-v1-1-ad277e8ab3cc@quicinc.com> <874jfg7xm4.fsf@kernel.org> <875xzq526o.fsf@kernel.org> From: Jeff Johnson In-Reply-To: <875xzq526o.fsf@kernel.org> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 7bit X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01b.na.qualcomm.com (10.46.141.250) To nalasex01a.na.qualcomm.com (10.47.209.196) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-GUID: -VQvq0zZEl9ZJ6TH2fjw2tzKOMgYchL_ X-Proofpoint-ORIG-GUID: -VQvq0zZEl9ZJ6TH2fjw2tzKOMgYchL_ X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.997,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2024-01-18_08,2024-01-17_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 spamscore=0 lowpriorityscore=0 bulkscore=0 suspectscore=0 mlxscore=0 adultscore=0 priorityscore=1501 impostorscore=0 clxscore=1015 malwarescore=0 phishscore=0 mlxlogscore=791 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.19.0-2311290000 definitions=main-2401180114 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240118_074418_186450_96485B94 X-CRM114-Status: GOOD ( 20.66 ) X-BeenThere: ath11k@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "ath11k" Errors-To: ath11k-bounces+ath11k=archiver.kernel.org@lists.infradead.org On 1/18/2024 3:08 AM, Kalle Valo wrote: > * To make sure there are no kernel-doc warnings we would have to add > checks to ath11k-check, which would slow down it considerably and it > would again slow down our workflow (I run it several times a day). I currently run the following on every upstream patch series I review: scripts/kernel-doc -Werror -none \ $(find drivers/net/wireless/ath/ath1*k -name '*.[ch]') It takes a trivial amount of time. > * To use kernel-doc formatting alone doesn't really make sense so we > would have to start creating a kernel-doc book or something. But who > would read it? Due to the sparseness, nobody would read the actual rendered documentation; only the documentation as it exists in the code would be read. However note that Linux cross-reference tool also links to the documentation, which I often find useful when looking at core kernel code, and would find it useful when looking at driver code. > * kernel-doc moves field documentation in structures away from the > actual fields which I find confusing. kernel-doc does support in-line commenting as well: Although I don't see that used much. > * The risk of having outdated kernel-doc documentation is high, it would > need active maintenance etc. Agree, but that is true of any documentation. The nice thing about kernel-doc is that it can actively tell you when the documentation doesn't match the code. > * I'm worried about creating useless documentation, like "Count number > foo" for foo_count() just because of kernel-doc. Valid concern > This is why I consider return on investment is low here :) My preference > is to make the code understandable (good symbol names etc) and document > the special cases, which are not obvious from the code, with a normal > code comment. Which I'm also fine with. >> I'm curious what others think of the ath10/11/12k level and style of >> documentation. > > IIRC iwlwifi uses kernel-doc to document the firmware interface, not > sure how much it's used elsewhere in the driver. They have the same problem I'm trying to fix ;) % scripts/kernel-doc -Werror -none \ $(find drivers/net/wireless/intel/iwlwifi -name '*.[ch]') ... 322 warnings as Errors % I'm not looking to change the status quo. Let me get the last of the ath10k cleanups in place, and I'll continue to run kernel-doc to make sure the existing ath1*k documentation is kept up to date. /jeff